From de127eb63905406db5b5f474db9d355e4e7fb52a Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Tue, 17 Sep 2019 12:22:21 -0700 Subject: [PATCH] fix!: accept null values in request bodies (#1824) --- src/apis/abusiveexperiencereport/v1.ts | 14 +- src/apis/acceleratedmobilepageurl/v1.ts | 16 +- src/apis/accessapproval/v1beta1.ts | 36 +- src/apis/accesscontextmanager/v1.ts | 88 +- src/apis/accesscontextmanager/v1beta.ts | 100 +- src/apis/adexchangebuyer/v1.2.ts | 68 +- src/apis/adexchangebuyer/v1.3.ts | 220 +- src/apis/adexchangebuyer/v1.4.ts | 524 +- src/apis/adexchangebuyer2/v2beta1.ts | 468 +- src/apis/adexperiencereport/v1.ts | 16 +- src/apis/admin/datatransfer_v1.ts | 42 +- src/apis/admin/directory_v1.ts | 910 +- src/apis/admin/reports_v1.ts | 72 +- src/apis/adsense/v1.4.ts | 186 +- src/apis/adsensehost/v4.1.ts | 118 +- src/apis/alertcenter/v1beta1.ts | 216 +- src/apis/analytics/v3.ts | 947 +- src/apis/analyticsreporting/v4.ts | 250 +- src/apis/androiddeviceprovisioning/v1.ts | 166 +- src/apis/androidenterprise/v1.ts | 446 +- src/apis/androidmanagement/v1.ts | 607 +- src/apis/androidpublisher/v1.1.ts | 22 +- src/apis/androidpublisher/v1.ts | 8 +- src/apis/androidpublisher/v2.ts | 278 +- src/apis/androidpublisher/v3.ts | 314 +- src/apis/appengine/v1.ts | 462 +- src/apis/appengine/v1alpha.ts | 126 +- src/apis/appengine/v1beta.ts | 480 +- src/apis/appsactivity/v1.ts | 46 +- src/apis/bigquery/v2.ts | 916 +- src/apis/bigqueryconnection/README.md | 47 + src/apis/bigqueryconnection/index.ts | 39 + src/apis/bigqueryconnection/package.json | 43 + src/apis/bigqueryconnection/tsconfig.json | 10 + src/apis/bigqueryconnection/v1beta1.ts | 1199 + src/apis/bigqueryconnection/webpack.config.js | 71 + src/apis/bigquerydatatransfer/v1.ts | 164 +- src/apis/bigqueryreservation/v1.ts | 20 +- src/apis/bigqueryreservation/v1alpha2.ts | 62 +- src/apis/bigtableadmin/v1.ts | 56 +- src/apis/bigtableadmin/v2.ts | 456 +- src/apis/binaryauthorization/index.ts | 18 +- src/apis/binaryauthorization/v1.ts | 903 + src/apis/binaryauthorization/v1beta1.ts | 70 +- src/apis/blogger/v2.ts | 120 +- src/apis/blogger/v3.ts | 195 +- src/apis/books/v1.ts | 384 +- src/apis/calendar/v3.ts | 327 +- src/apis/chat/v1.ts | 106 +- src/apis/civicinfo/v2.ts | 390 +- src/apis/classroom/v1.ts | 288 +- src/apis/cloudasset/v1.ts | 160 +- src/apis/cloudasset/v1beta1.ts | 68 +- src/apis/cloudbilling/v1.ts | 112 +- src/apis/cloudbuild/v1.ts | 180 +- src/apis/cloudbuild/v1alpha1.ts | 156 +- src/apis/clouddebugger/v2.ts | 100 +- src/apis/clouderrorreporting/v1beta1.ts | 68 +- src/apis/cloudfunctions/v1.ts | 138 +- src/apis/cloudfunctions/v1beta2.ts | 120 +- src/apis/cloudidentity/v1.ts | 50 +- src/apis/cloudidentity/v1beta1.ts | 48 +- src/apis/cloudiot/v1.ts | 130 +- src/apis/cloudkms/v1.ts | 160 +- src/apis/cloudprivatecatalog/v1beta1.ts | 38 +- .../cloudprivatecatalogproducer/v1beta1.ts | 104 +- src/apis/cloudprofiler/v2.ts | 18 +- src/apis/cloudresourcemanager/v1.ts | 164 +- src/apis/cloudresourcemanager/v1beta1.ts | 78 +- src/apis/cloudresourcemanager/v2.ts | 86 +- src/apis/cloudresourcemanager/v2beta1.ts | 86 +- src/apis/cloudscheduler/v1.ts | 94 +- src/apis/cloudscheduler/v1beta1.ts | 94 +- src/apis/cloudsearch/v1.ts | 458 +- src/apis/cloudshell/v1.ts | 40 +- src/apis/cloudshell/v1alpha1.ts | 46 +- src/apis/cloudtasks/v2.ts | 110 +- src/apis/cloudtasks/v2beta2.ts | 134 +- src/apis/cloudtasks/v2beta3.ts | 130 +- src/apis/cloudtrace/v1.ts | 20 +- src/apis/cloudtrace/v2.ts | 64 +- src/apis/commentanalyzer/v1alpha1.ts | 54 +- src/apis/composer/v1.ts | 84 +- src/apis/composer/v1beta1.ts | 100 +- src/apis/compute/alpha.ts | 81371 ++++++++++++++++ src/apis/compute/beta.ts | 4084 +- src/apis/compute/index.ts | 16 +- src/apis/compute/v1.ts | 9245 +- src/apis/container/v1.ts | 520 +- src/apis/container/v1beta1.ts | 612 +- src/apis/containeranalysis/v1alpha1.ts | 314 +- src/apis/containeranalysis/v1beta1.ts | 328 +- src/apis/content/v2.1.ts | 1562 +- src/apis/content/v2.ts | 1796 +- src/apis/customsearch/v1.ts | 128 +- src/apis/dataflow/v1b3.ts | 792 +- src/apis/datafusion/v1beta1.ts | 146 +- src/apis/dataproc/v1.ts | 3307 +- src/apis/dataproc/v1beta2.ts | 456 +- src/apis/datastore/v1.ts | 190 +- src/apis/datastore/v1beta1.ts | 72 +- src/apis/datastore/v1beta3.ts | 150 +- src/apis/deploymentmanager/alpha.ts | 340 +- src/apis/deploymentmanager/v2.ts | 214 +- src/apis/deploymentmanager/v2beta.ts | 322 +- src/apis/dfareporting/v3.1.ts | 1918 +- src/apis/dfareporting/v3.2.ts | 1970 +- src/apis/dfareporting/v3.3.ts | 1962 +- src/apis/digitalassetlinks/v1.ts | 22 +- src/apis/discovery/v1.ts | 136 +- src/apis/dlp/v2.ts | 426 +- src/apis/dns/v1.ts | 859 +- src/apis/dns/v1beta2.ts | 200 +- src/apis/dns/v2beta1.ts | 859 +- src/apis/docs/v1.ts | 602 +- src/apis/domainsrdap/v1.ts | 36 +- src/apis/doubleclickbidmanager/v1.ts | 132 +- src/apis/doubleclicksearch/v2.ts | 155 +- src/apis/drive/v2.ts | 571 +- src/apis/drive/v3.ts | 346 +- src/apis/driveactivity/v2.ts | 98 +- src/apis/factchecktools/v1alpha1.ts | 68 +- src/apis/fcm/v1.ts | 108 +- src/apis/file/v1.ts | 134 +- src/apis/file/v1beta1.ts | 134 +- src/apis/firebase/v1beta1.ts | 164 +- src/apis/firebasedynamiclinks/v1.ts | 184 +- src/apis/firebasehosting/v1beta1.ts | 114 +- src/apis/firebaserules/v1.ts | 70 +- src/apis/firestore/v1.ts | 270 +- src/apis/firestore/v1beta1.ts | 236 +- src/apis/firestore/v1beta2.ts | 90 +- src/apis/fitness/v1.ts | 124 +- src/apis/fusiontables/v1.ts | 154 +- src/apis/fusiontables/v2.ts | 170 +- src/apis/games/v1.ts | 768 +- .../gamesConfiguration/v1configuration.ts | 68 +- src/apis/gamesManagement/v1management.ts | 78 +- src/apis/genomics/v1.ts | 92 +- src/apis/genomics/v1alpha2.ts | 196 +- src/apis/genomics/v2alpha1.ts | 198 +- src/apis/gmail/v1.ts | 228 +- src/apis/groupsmigration/v1.ts | 4 +- src/apis/groupssettings/v1.ts | 122 +- src/apis/healthcare/index.ts | 16 +- src/apis/healthcare/v1alpha2.ts | 10283 -- src/apis/healthcare/v1beta1.ts | 251 +- src/apis/homegraph/v1.ts | 70 +- src/apis/iam/v1.ts | 180 +- src/apis/iamcredentials/v1.ts | 34 +- src/apis/iap/v1.ts | 26 +- src/apis/iap/v1beta1.ts | 26 +- src/apis/identitytoolkit/v3.ts | 610 +- src/apis/index.ts | 3 + src/apis/indexing/v3.ts | 8 +- src/apis/jobs/v2.ts | 380 +- src/apis/jobs/v3.ts | 302 +- src/apis/jobs/v3p1beta1.ts | 328 +- src/apis/kgsearch/v1.ts | 6 +- src/apis/language/v1.ts | 96 +- src/apis/language/v1beta1.ts | 86 +- src/apis/language/v1beta2.ts | 96 +- src/apis/libraryagent/v1.ts | 16 +- src/apis/licensing/v1.ts | 24 +- src/apis/logging/v2.ts | 323 +- src/apis/manufacturers/v1.ts | 116 +- src/apis/mirror/v1.ts | 168 +- src/apis/ml/v1.ts | 294 +- src/apis/monitoring/v3.ts | 424 +- src/apis/oauth2/v1.ts | 46 +- src/apis/oauth2/v2.ts | 42 +- src/apis/oslogin/v1.ts | 30 +- src/apis/oslogin/v1alpha.ts | 30 +- src/apis/oslogin/v1beta.ts | 30 +- src/apis/pagespeedonline/v1.ts | 22 +- src/apis/pagespeedonline/v2.ts | 41 +- src/apis/pagespeedonline/v4.ts | 43 +- src/apis/pagespeedonline/v5.ts | 80 +- src/apis/people/v1.ts | 270 +- src/apis/playcustomapp/v1.ts | 4 +- src/apis/plus/v1.ts | 184 +- src/apis/plusDomains/v1.ts | 268 +- src/apis/poly/v1.ts | 84 +- src/apis/proximitybeacon/v1beta1.ts | 88 +- src/apis/pubsub/v1.ts | 108 +- src/apis/pubsub/v1beta1a.ts | 64 +- src/apis/pubsub/v1beta2.ts | 68 +- src/apis/redis/v1.ts | 92 +- src/apis/redis/v1beta1.ts | 90 +- src/apis/remotebuildexecution/v1.ts | 312 +- src/apis/remotebuildexecution/v1alpha.ts | 298 +- src/apis/remotebuildexecution/v2.ts | 334 +- src/apis/replicapool/v1beta1.ts | 130 +- src/apis/reseller/v1.ts | 96 +- src/apis/run/v1.ts | 12 +- src/apis/run/v1alpha1.ts | 549 +- src/apis/runtimeconfig/v1.ts | 16 +- src/apis/runtimeconfig/v1beta1.ts | 68 +- src/apis/safebrowsing/v4.ts | 106 +- src/apis/script/v1.ts | 152 +- src/apis/searchconsole/v1.ts | 18 +- src/apis/securitycenter/v1.ts | 172 +- src/apis/securitycenter/v1beta1.ts | 162 +- src/apis/securitycenter/v1p1alpha1.ts | 24 +- src/apis/servicebroker/v1.ts | 26 +- src/apis/servicebroker/v1alpha1.ts | 152 +- src/apis/servicebroker/v1beta1.ts | 174 +- src/apis/serviceconsumermanagement/v1.ts | 366 +- src/apis/servicecontrol/v1.ts | 310 +- src/apis/servicemanagement/v1.ts | 394 +- src/apis/servicenetworking/v1.ts | 338 +- src/apis/servicenetworking/v1beta.ts | 336 +- src/apis/serviceusage/v1.ts | 337 +- src/apis/serviceusage/v1beta1.ts | 345 +- src/apis/sheets/v4.ts | 634 +- src/apis/siteVerification/v1.ts | 14 +- src/apis/slides/v1.ts | 474 +- src/apis/sourcerepo/v1.ts | 82 +- src/apis/spanner/v1.ts | 250 +- src/apis/speech/v1.ts | 80 +- src/apis/speech/v1p1beta1.ts | 104 +- src/apis/speech/v2beta.ts | 46 +- src/apis/sqladmin/v1beta4.ts | 410 +- src/apis/storage/v1.ts | 281 +- src/apis/storage/v1beta1.ts | 92 +- src/apis/storage/v1beta2.ts | 160 +- src/apis/storagetransfer/v1.ts | 134 +- src/apis/streetviewpublish/v1.ts | 62 +- src/apis/surveys/v2.ts | 106 +- src/apis/tagmanager/v1.ts | 244 +- src/apis/tagmanager/v2.ts | 370 +- src/apis/tasks/v1.ts | 54 +- src/apis/testing/v1.ts | 272 +- src/apis/texttospeech/v1.ts | 32 +- src/apis/texttospeech/v1beta1.ts | 32 +- src/apis/toolresults/v1beta3.ts | 250 +- src/apis/tpu/v1.ts | 100 +- src/apis/tpu/v1alpha1.ts | 100 +- src/apis/translate/v2.ts | 24 +- src/apis/translate/v3beta1.ts | 110 +- src/apis/urlshortener/v1.ts | 26 +- src/apis/vault/v1.ts | 162 +- src/apis/verifiedaccess/v1.ts | 14 +- src/apis/videointelligence/v1.ts | 476 +- src/apis/videointelligence/v1beta2.ts | 474 +- src/apis/videointelligence/v1p1beta1.ts | 474 +- src/apis/videointelligence/v1p2beta1.ts | 474 +- src/apis/videointelligence/v1p3beta1.ts | 474 +- src/apis/vision/v1.ts | 1274 +- src/apis/vision/v1p1beta1.ts | 1244 +- src/apis/vision/v1p2beta1.ts | 1244 +- src/apis/webfonts/v1.ts | 18 +- src/apis/webmasters/v3.ts | 60 +- src/apis/websecurityscanner/v1.ts | 124 +- src/apis/websecurityscanner/v1alpha.ts | 104 +- src/apis/websecurityscanner/v1beta.ts | 122 +- src/apis/youtube/v3.ts | 1464 +- src/apis/youtubeAnalytics/v2.ts | 64 +- src/apis/youtubereporting/v1.ts | 142 +- src/generator/templates/api-endpoint.njk | 2 +- src/index.ts | 4 +- 261 files changed, 126123 insertions(+), 44564 deletions(-) create mode 100644 src/apis/bigqueryconnection/README.md create mode 100644 src/apis/bigqueryconnection/index.ts create mode 100644 src/apis/bigqueryconnection/package.json create mode 100644 src/apis/bigqueryconnection/tsconfig.json create mode 100644 src/apis/bigqueryconnection/v1beta1.ts create mode 100644 src/apis/bigqueryconnection/webpack.config.js create mode 100644 src/apis/binaryauthorization/v1.ts create mode 100644 src/apis/compute/alpha.ts delete mode 100644 src/apis/healthcare/v1alpha2.ts diff --git a/src/apis/abusiveexperiencereport/v1.ts b/src/apis/abusiveexperiencereport/v1.ts index 656e44d7ce2..2dab6d815a3 100644 --- a/src/apis/abusiveexperiencereport/v1.ts +++ b/src/apis/abusiveexperiencereport/v1.ts @@ -126,31 +126,31 @@ export namespace abusiveexperiencereport_v1 { /** * The site's Abusive Experience Report status. */ - abusiveStatus?: string; + abusiveStatus?: string | null; /** * The time at which [enforcement](https://support.google.com/webtools/answer/7538608) against the site began or will begin. Not set when the filter_status is OFF. */ - enforcementTime?: string; + enforcementTime?: string | null; /** * The site's [enforcement status](https://support.google.com/webtools/answer/7538608). */ - filterStatus?: string; + filterStatus?: string | null; /** * The time at which the site's status last changed. */ - lastChangeTime?: string; + lastChangeTime?: string | null; /** * A link to the full Abusive Experience Report for the site. Not set in ViolatingSitesResponse. Note that you must complete the [Search Console verification process](https://support.google.com/webmasters/answer/9008080) for the site before you can access the full report. */ - reportUrl?: string; + reportUrl?: string | null; /** * The name of the reviewed site, e.g. `google.com`. */ - reviewedSite?: string; + reviewedSite?: string | null; /** * Whether the site is currently under review. */ - underReview?: boolean; + underReview?: boolean | null; } /** * Response message for ListViolatingSites. diff --git a/src/apis/acceleratedmobilepageurl/v1.ts b/src/apis/acceleratedmobilepageurl/v1.ts index a2bc56f5f11..8ed2b3e61e3 100644 --- a/src/apis/acceleratedmobilepageurl/v1.ts +++ b/src/apis/acceleratedmobilepageurl/v1.ts @@ -124,15 +124,15 @@ export namespace acceleratedmobilepageurl_v1 { /** * The AMP URL pointing to the publisher's web server. */ - ampUrl?: string; + ampUrl?: string | null; /** * The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache. */ - cdnAmpUrl?: string; + cdnAmpUrl?: string | null; /** * The original non-AMP URL. */ - originalUrl?: string; + originalUrl?: string | null; } /** * AMP URL Error resource for a requested URL that couldn't be found. @@ -141,15 +141,15 @@ export namespace acceleratedmobilepageurl_v1 { /** * The error code of an API call. */ - errorCode?: string; + errorCode?: string | null; /** * An optional descriptive error message. */ - errorMessage?: string; + errorMessage?: string | null; /** * The original non-AMP URL. */ - originalUrl?: string; + originalUrl?: string | null; } /** * AMP URL request for a batch of URLs. @@ -158,11 +158,11 @@ export namespace acceleratedmobilepageurl_v1 { /** * The lookup_strategy being requested. */ - lookupStrategy?: string; + lookupStrategy?: string | null; /** * List of URLs to look up for the paired AMP URLs. The URLs are case-sensitive. Up to 50 URLs per lookup (see [Usage Limits](/amp/cache/reference/limits)). */ - urls?: string[]; + urls?: string[] | null; } /** * Batch AMP URL response. diff --git a/src/apis/accessapproval/v1beta1.ts b/src/apis/accessapproval/v1beta1.ts index 1136dc5ef1e..3978e4d1ef4 100644 --- a/src/apis/accessapproval/v1beta1.ts +++ b/src/apis/accessapproval/v1beta1.ts @@ -132,11 +132,11 @@ export namespace accessapproval_v1beta1 { /** * The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol> */ - name?: string; + name?: string | null; /** * A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. */ - notificationEmails?: string[]; + notificationEmails?: string[] | null; } /** * Home office and physical location of the principal. @@ -145,21 +145,21 @@ export namespace accessapproval_v1beta1 { /** * The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol> */ - principalOfficeCountry?: string; + principalOfficeCountry?: string | null; /** * Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol> */ - principalPhysicalLocationCountry?: string; + principalPhysicalLocationCountry?: string | null; } export interface Schema$AccessReason { /** * More detail about certain reason types. See comments for each type above. */ - detail?: string; + detail?: string | null; /** * Type of access justification. */ - type?: string; + type?: string | null; } /** * A request for the customer to approve access to a resource. @@ -176,11 +176,11 @@ export namespace accessapproval_v1beta1 { /** * The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}". */ - name?: string; + name?: string | null; /** * The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. */ - requestedExpiration?: string; + requestedExpiration?: string | null; /** * The locations for which approval is being requested. */ @@ -192,7 +192,7 @@ export namespace accessapproval_v1beta1 { /** * The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. */ - requestedResourceName?: string; + requestedResourceName?: string | null; /** * Properties related to the resource represented by requested_resource_name. */ @@ -200,7 +200,7 @@ export namespace accessapproval_v1beta1 { /** * The time at which approval was requested. */ - requestTime?: string; + requestTime?: string | null; } /** * Request to approve an ApprovalRequest. @@ -209,7 +209,7 @@ export namespace accessapproval_v1beta1 { /** * The expiration time of this approval. */ - expireTime?: string; + expireTime?: string | null; } /** * A decision that has been made to approve access to a resource. @@ -218,11 +218,11 @@ export namespace accessapproval_v1beta1 { /** * The time at which approval was granted. */ - approveTime?: string; + approveTime?: string | null; /** * The time at which the approval expires. */ - expireTime?: string; + expireTime?: string | null; } /** * Request to dismiss an approval request. @@ -235,7 +235,7 @@ export namespace accessapproval_v1beta1 { /** * The time at which the approval request was dismissed. */ - dismissTime?: string; + dismissTime?: string | null; } /** * Represents the enrollment of a cloud resource into a specific service. @@ -244,11 +244,11 @@ export namespace accessapproval_v1beta1 { /** * The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): <ol> <li>all</li> <li>appengine.googleapis.com</li> <li>bigquery.googleapis.com</li> <li>bigtable.googleapis.com</li> <li>cloudkms.googleapis.com</li> <li>compute.googleapis.com</li> <li>dataflow.googleapis.com</li> <li>iam.googleapis.com</li> <li>pubsub.googleapis.com</li> <li>storage.googleapis.com</li> <ol> */ - cloudProduct?: string; + cloudProduct?: string | null; /** * The enrollment level of the service. */ - enrollmentLevel?: string; + enrollmentLevel?: string | null; } /** * Response to listing of ApprovalRequest objects. @@ -261,7 +261,7 @@ export namespace accessapproval_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The properties associated with the resource of the request. @@ -270,7 +270,7 @@ export namespace accessapproval_v1beta1 { /** * Whether an approval will exclude the descendants of the resource being requested. */ - excludesDescendants?: boolean; + excludesDescendants?: boolean | null; } export class Resource$Folders { diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index d88565ee036..5b2cace0afd 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -130,23 +130,23 @@ export namespace accesscontextmanager_v1 { /** * Output only. Time the `AccessLevel` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Description of the `AccessLevel` and its use. Does not affect behavior. */ - description?: string; + description?: string | null; /** * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` */ - name?: string; + name?: string | null; /** * Human readable title. Must be unique within the Policy. */ - title?: string; + title?: string | null; /** * Output only. Time the `AccessLevel` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. @@ -155,23 +155,23 @@ export namespace accesscontextmanager_v1 { /** * Output only. Time the `AccessPolicy` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` */ - name?: string; + name?: string | null; /** * Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` */ - parent?: string; + parent?: string | null; /** * Required. Human readable title. Does not affect behavior. */ - title?: string; + title?: string | null; /** * Output only. Time the `AccessPolicy` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `BasicLevel` is an `AccessLevel` using a set of recommended features. @@ -180,7 +180,7 @@ export namespace accesscontextmanager_v1 { /** * How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND. */ - combiningFunction?: string; + combiningFunction?: string | null; /** * Required. A list of requirements for the `AccessLevel` to be granted. */ @@ -201,23 +201,23 @@ export namespace accesscontextmanager_v1 { /** * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed. */ - ipSubnetworks?: string[]; + ipSubnetworks?: string[] | null; /** * The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user. */ - members?: string[]; + members?: string[] | null; /** * Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false. */ - negate?: boolean; + negate?: boolean | null; /** * The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. */ - regions?: string[]; + regions?: string[] | null; /** * A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` */ - requiredAccessLevels?: string[]; + requiredAccessLevels?: string[] | null; } /** * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. @@ -226,11 +226,11 @@ export namespace accesscontextmanager_v1 { /** * Allowed device management levels, an empty list allows all management levels. */ - allowedDeviceManagementLevels?: string[]; + allowedDeviceManagementLevels?: string[] | null; /** * Allowed encryptions statuses, an empty list allows all statuses. */ - allowedEncryptionStatuses?: string[]; + allowedEncryptionStatuses?: string[] | null; /** * Allowed OS versions, an empty list allows all types and all versions. */ @@ -238,15 +238,15 @@ export namespace accesscontextmanager_v1 { /** * Whether the device needs to be approved by the customer admin. */ - requireAdminApproval?: boolean; + requireAdminApproval?: boolean | null; /** * Whether the device needs to be corp owned. */ - requireCorpOwned?: boolean; + requireCorpOwned?: boolean | null; /** * Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. */ - requireScreenlock?: boolean; + requireScreenlock?: 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 `{}`. @@ -263,7 +263,7 @@ export namespace accesscontextmanager_v1 { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A response to `ListAccessPoliciesRequest`. @@ -276,7 +276,7 @@ export namespace accesscontextmanager_v1 { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -285,7 +285,7 @@ export namespace accesscontextmanager_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -298,7 +298,7 @@ export namespace accesscontextmanager_v1 { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of the Service Perimeter instances. */ @@ -311,7 +311,7 @@ export namespace accesscontextmanager_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -319,15 +319,15 @@ export namespace accesscontextmanager_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A restriction on the OS type and version of devices making requests. @@ -336,15 +336,15 @@ export namespace accesscontextmanager_v1 { /** * The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. */ - minimumVersion?: string; + minimumVersion?: string | null; /** * Required. The allowed OS type. */ - osType?: string; + osType?: string | null; /** * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. */ - requireVerifiedChromeOs?: boolean; + requireVerifiedChromeOs?: boolean | null; } /** * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. @@ -353,19 +353,19 @@ export namespace accesscontextmanager_v1 { /** * Output only. Time the `ServicePerimeter` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Description of the `ServicePerimeter` and its use. Does not affect behavior. */ - description?: string; + description?: string | null; /** * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` */ - name?: string; + name?: string | null; /** * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. */ - perimeterType?: string; + perimeterType?: string | null; /** * Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. */ @@ -373,11 +373,11 @@ export namespace accesscontextmanager_v1 { /** * Human readable title. Must be unique within the Policy. */ - title?: string; + title?: string | null; /** * Output only. Time the `ServicePerimeter` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. @@ -386,15 +386,15 @@ export namespace accesscontextmanager_v1 { /** * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ - accessLevels?: string[]; + accessLevels?: string[] | null; /** * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ - resources?: string[]; + resources?: string[] | null; /** * GCP services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ - restrictedServices?: string[]; + restrictedServices?: 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). @@ -403,15 +403,15 @@ export namespace accesscontextmanager_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Accesspolicies { diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index 73da59358a2..9fcd76a4ed7 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -130,23 +130,23 @@ export namespace accesscontextmanager_v1beta { /** * Output only. Time the `AccessLevel` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Description of the `AccessLevel` and its use. Does not affect behavior. */ - description?: string; + description?: string | null; /** * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` */ - name?: string; + name?: string | null; /** * Human readable title. Must be unique within the Policy. */ - title?: string; + title?: string | null; /** * Output only. Time the `AccessLevel` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. @@ -155,23 +155,23 @@ export namespace accesscontextmanager_v1beta { /** * Output only. Time the `AccessPolicy` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` */ - name?: string; + name?: string | null; /** * Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` */ - parent?: string; + parent?: string | null; /** * Required. Human readable title. Does not affect behavior. */ - title?: string; + title?: string | null; /** * Output only. Time the `AccessPolicy` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `BasicLevel` is an `AccessLevel` using a set of recommended features. @@ -180,7 +180,7 @@ export namespace accesscontextmanager_v1beta { /** * How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND. */ - combiningFunction?: string; + combiningFunction?: string | null; /** * Required. A list of requirements for the `AccessLevel` to be granted. */ @@ -193,11 +193,11 @@ export namespace accesscontextmanager_v1beta { /** * The list of APIs usable through the Bridge Perimeter. Must be empty unless 'enable_restriction' is True. */ - allowedServices?: string[]; + allowedServices?: string[] | null; /** * Whether to restrict the set of APIs callable through the Bridge Service Perimeter. */ - enableRestriction?: boolean; + enableRestriction?: boolean | null; } /** * A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction. @@ -210,23 +210,23 @@ export namespace accesscontextmanager_v1beta { /** * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed. */ - ipSubnetworks?: string[]; + ipSubnetworks?: string[] | null; /** * The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user. */ - members?: string[]; + members?: string[] | null; /** * Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false. */ - negate?: boolean; + negate?: boolean | null; /** * The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. */ - regions?: string[]; + regions?: string[] | null; /** * A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` */ - requiredAccessLevels?: string[]; + requiredAccessLevels?: string[] | null; } /** * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. @@ -235,11 +235,11 @@ export namespace accesscontextmanager_v1beta { /** * Allowed device management levels, an empty list allows all management levels. */ - allowedDeviceManagementLevels?: string[]; + allowedDeviceManagementLevels?: string[] | null; /** * Allowed encryptions statuses, an empty list allows all statuses. */ - allowedEncryptionStatuses?: string[]; + allowedEncryptionStatuses?: string[] | null; /** * Allowed OS versions, an empty list allows all types and all versions. */ @@ -247,15 +247,15 @@ export namespace accesscontextmanager_v1beta { /** * Whether the device needs to be approved by the customer admin. */ - requireAdminApproval?: boolean; + requireAdminApproval?: boolean | null; /** * Whether the device needs to be corp owned. */ - requireCorpOwned?: boolean; + requireCorpOwned?: boolean | null; /** * Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. */ - requireScreenlock?: boolean; + requireScreenlock?: boolean | null; } /** * Alpha. Specifies how Access Levels are to be used for accessing the Service Perimeter. @@ -264,11 +264,11 @@ export namespace accesscontextmanager_v1beta { /** * The list of APIs usable with a valid Access Level. Must be empty unless 'enable_restriction' is True. */ - allowedServices?: string[]; + allowedServices?: string[] | null; /** * Whether to restrict the set of APIs callable outside the Service Perimeter via Access Levels. */ - enableRestriction?: boolean; + enableRestriction?: boolean | null; } /** * A response to `ListAccessLevelsRequest`. @@ -281,7 +281,7 @@ export namespace accesscontextmanager_v1beta { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A response to `ListAccessPoliciesRequest`. @@ -294,7 +294,7 @@ export namespace accesscontextmanager_v1beta { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A response to `ListServicePerimetersRequest`. @@ -303,7 +303,7 @@ export namespace accesscontextmanager_v1beta { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of the Service Perimeter instances. */ @@ -316,7 +316,7 @@ export namespace accesscontextmanager_v1beta { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -324,15 +324,15 @@ export namespace accesscontextmanager_v1beta { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A restriction on the OS type and version of devices making requests. @@ -341,15 +341,15 @@ export namespace accesscontextmanager_v1beta { /** * The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. */ - minimumVersion?: string; + minimumVersion?: string | null; /** * Required. The allowed OS type. */ - osType?: string; + osType?: string | null; /** * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. */ - requireVerifiedChromeOs?: boolean; + requireVerifiedChromeOs?: boolean | null; } /** * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. @@ -358,19 +358,19 @@ export namespace accesscontextmanager_v1beta { /** * Output only. Time the `ServicePerimeter` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Description of the `ServicePerimeter` and its use. Does not affect behavior. */ - description?: string; + description?: string | null; /** * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` */ - name?: string; + name?: string | null; /** * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty. */ - perimeterType?: string; + perimeterType?: string | null; /** * Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries. */ @@ -378,11 +378,11 @@ export namespace accesscontextmanager_v1beta { /** * Human readable title. Must be unique within the Policy. */ - title?: string; + title?: string | null; /** * Output only. Time the `ServicePerimeter` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. @@ -391,7 +391,7 @@ export namespace accesscontextmanager_v1beta { /** * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ - accessLevels?: string[]; + accessLevels?: string[] | null; /** * Alpha. Configuration for what services are accessible via the Bridge Perimeter. Must be empty for non-Bridge Perimeters. */ @@ -403,15 +403,15 @@ export namespace accesscontextmanager_v1beta { /** * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ - resources?: string[]; + resources?: string[] | null; /** * GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ - restrictedServices?: string[]; + restrictedServices?: string[] | null; /** * GCP services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted. */ - unrestrictedServices?: string[]; + unrestrictedServices?: string[] | null; /** * Alpha. Configuration for within Perimeter allowed APIs. */ @@ -424,15 +424,15 @@ export namespace accesscontextmanager_v1beta { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Alpha. Specifies how APIs are allowed to communicate within the Service Perimeter. @@ -441,11 +441,11 @@ export namespace accesscontextmanager_v1beta { /** * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. */ - allowedServices?: string[]; + allowedServices?: string[] | null; /** * Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. */ - enableRestriction?: boolean; + enableRestriction?: boolean | null; } export class Resource$Accesspolicies { diff --git a/src/apis/adexchangebuyer/v1.2.ts b/src/apis/adexchangebuyer/v1.2.ts index 032b5e77a5b..fffcb9f2308 100644 --- a/src/apis/adexchangebuyer/v1.2.ts +++ b/src/apis/adexchangebuyer/v1.2.ts @@ -114,35 +114,35 @@ export namespace adexchangebuyer_v1_2 { maximumQps?: number; region?: string; url?: string; - }>; + }> | null; /** * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. */ - cookieMatchingNid?: string; + cookieMatchingNid?: string | null; /** * The base URL used in cookie match requests. */ - cookieMatchingUrl?: string; + cookieMatchingUrl?: string | null; /** * Account id. */ - id?: number; + id?: number | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this. */ - maximumActiveCreatives?: number; + maximumActiveCreatives?: number | null; /** * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. */ - maximumTotalQps?: number; + maximumTotalQps?: number | null; /** * The number of creatives that this account inserted or bid with in the last 30 days. */ - numberActiveCreatives?: number; + numberActiveCreatives?: number | null; } /** * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account. @@ -155,7 +155,7 @@ export namespace adexchangebuyer_v1_2 { /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * A creative and its classification data. @@ -164,98 +164,98 @@ export namespace adexchangebuyer_v1_2 { /** * Account id. */ - accountId?: number; + accountId?: number | null; /** * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ - advertiserId?: string[]; + advertiserId?: string[] | null; /** * The name of the company being advertised in the creative. */ - advertiserName?: string; + advertiserName?: string | null; /** * The agency id for this creative. */ - agencyId?: string; + agencyId?: string | null; /** * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). */ - apiUploadTimestamp?: string; + apiUploadTimestamp?: string | null; /** * All attributes for the ads that may be shown from this snippet. */ - attribute?: number[]; + attribute?: number[] | null; /** * A buyer-specific id identifying the creative in this ad. */ - buyerCreativeId?: string; + buyerCreativeId?: string | null; /** * The set of destination urls for the snippet. */ - clickThroughUrl?: string[]; + clickThroughUrl?: string[] | null; /** * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. */ - corrections?: Array<{details?: string[]; reason?: string}>; + corrections?: Array<{details?: string[]; reason?: string}> | null; /** * The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests. */ - disapprovalReasons?: Array<{details?: string[]; reason?: string}>; + disapprovalReasons?: Array<{details?: string[]; reason?: string}> | null; /** * The filtering reasons for the creative. Read-only. This field should not be set in requests. */ filteringReasons?: { date?: string; reasons?: Array<{filteringCount?: string; filteringStatus?: number}>; - }; + } | null; /** * Ad height. */ - height?: number; + height?: number | null; /** * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. */ - HTMLSnippet?: string; + HTMLSnippet?: string | null; /** * The set of urls to be called to record an impression. */ - impressionTrackingUrl?: string[]; + impressionTrackingUrl?: string[] | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Detected product categories, if any. Read-only. This field should not be set in requests. */ - productCategories?: number[]; + productCategories?: number[] | null; /** * All restricted categories for the ads that may be shown from this snippet. */ - restrictedCategories?: number[]; + restrictedCategories?: number[] | null; /** * Detected sensitive categories, if any. Read-only. This field should not be set in requests. */ - sensitiveCategories?: number[]; + sensitiveCategories?: number[] | null; /** * Creative serving status. Read-only. This field should not be set in requests. */ - status?: string; + status?: string | null; /** * All vendor types for the ads that may be shown from this snippet. */ - vendorType?: number[]; + vendorType?: number[] | null; /** * The version for this creative. Read-only. This field should not be set in requests. */ - version?: number; + version?: number | null; /** * The url to fetch a video ad. If set, HTMLSnippet should not be set. */ - videoURL?: string; + videoURL?: string | null; /** * Ad width. */ - width?: number; + width?: number | null; } /** * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative. @@ -268,11 +268,11 @@ export namespace adexchangebuyer_v1_2 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export class Resource$Accounts { diff --git a/src/apis/adexchangebuyer/v1.3.ts b/src/apis/adexchangebuyer/v1.3.ts index 3a5beb815c7..e2ace0e26e2 100644 --- a/src/apis/adexchangebuyer/v1.3.ts +++ b/src/apis/adexchangebuyer/v1.3.ts @@ -124,35 +124,35 @@ export namespace adexchangebuyer_v1_3 { maximumQps?: number; region?: string; url?: string; - }>; + }> | null; /** * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. */ - cookieMatchingNid?: string; + cookieMatchingNid?: string | null; /** * The base URL used in cookie match requests. */ - cookieMatchingUrl?: string; + cookieMatchingUrl?: string | null; /** * Account id. */ - id?: number; + id?: number | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this. */ - maximumActiveCreatives?: number; + maximumActiveCreatives?: number | null; /** * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. */ - maximumTotalQps?: number; + maximumTotalQps?: number | null; /** * The number of creatives that this account inserted or bid with in the last 30 days. */ - numberActiveCreatives?: number; + numberActiveCreatives?: number | null; } /** * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account. @@ -165,7 +165,7 @@ export namespace adexchangebuyer_v1_3 { /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * The configuration data for an Ad Exchange billing info. @@ -174,19 +174,19 @@ export namespace adexchangebuyer_v1_3 { /** * Account id. */ - accountId?: number; + accountId?: number | null; /** * Account name. */ - accountName?: string; + accountName?: string | null; /** * A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account. */ - billingId?: string[]; + billingId?: string[] | null; /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info. @@ -199,7 +199,7 @@ export namespace adexchangebuyer_v1_3 { /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * The configuration data for Ad Exchange RTB - Budget API. @@ -208,27 +208,27 @@ export namespace adexchangebuyer_v1_3 { /** * The id of the account. This is required for get and update requests. */ - accountId?: string; + accountId?: string | null; /** * The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. */ - billingId?: string; + billingId?: string | null; /** * The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. */ - budgetAmount?: string; + budgetAmount?: string | null; /** * The currency code for the buyer. This cannot be altered here. */ - currencyCode?: string; + currencyCode?: string | null; /** * The unique id that describes this item. */ - id?: string; + id?: string | null; /** * The kind of the resource, i.e. "adexchangebuyer#budget". */ - kind?: string; + kind?: string | null; } /** * A creative and its classification data. @@ -237,70 +237,70 @@ export namespace adexchangebuyer_v1_3 { /** * Account id. */ - accountId?: number; + accountId?: number | null; adTechnologyProviders?: { detectedProviderIds?: string[]; hasUnidentifiedProvider?: boolean; - }; + } | null; /** * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ - advertiserId?: string[]; + advertiserId?: string[] | null; /** * The name of the company being advertised in the creative. */ - advertiserName?: string; + advertiserName?: string | null; /** * The agency id for this creative. */ - agencyId?: string; + agencyId?: string | null; /** * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). */ - apiUploadTimestamp?: string; + apiUploadTimestamp?: string | null; /** * All attributes for the ads that may be shown from this snippet. */ - attribute?: number[]; + attribute?: number[] | null; /** * A buyer-specific id identifying the creative in this ad. */ - buyerCreativeId?: string; + buyerCreativeId?: string | null; /** * The set of destination urls for the snippet. */ - clickThroughUrl?: string[]; + clickThroughUrl?: string[] | null; /** * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. */ - corrections?: Array<{details?: string[]; reason?: string}>; + corrections?: Array<{details?: string[]; reason?: string}> | null; /** * The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests. */ - disapprovalReasons?: Array<{details?: string[]; reason?: string}>; + disapprovalReasons?: Array<{details?: string[]; reason?: string}> | null; /** * The filtering reasons for the creative. Read-only. This field should not be set in requests. */ filteringReasons?: { date?: string; reasons?: Array<{filteringCount?: string; filteringStatus?: number}>; - }; + } | null; /** * Ad height. */ - height?: number; + height?: number | null; /** * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. */ - HTMLSnippet?: string; + HTMLSnippet?: string | null; /** * The set of urls to be called to record an impression. */ - impressionTrackingUrl?: string[]; + impressionTrackingUrl?: string[] | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * If nativeAd is set, HTMLSnippet and videoURL should not be set. */ @@ -316,39 +316,39 @@ export namespace adexchangebuyer_v1_3 { logo?: {height?: number; url?: string; width?: number}; price?: string; starRating?: number; - }; + } | null; /** * Detected product categories, if any. Read-only. This field should not be set in requests. */ - productCategories?: number[]; + productCategories?: number[] | null; /** * All restricted categories for the ads that may be shown from this snippet. */ - restrictedCategories?: number[]; + restrictedCategories?: number[] | null; /** * Detected sensitive categories, if any. Read-only. This field should not be set in requests. */ - sensitiveCategories?: number[]; + sensitiveCategories?: number[] | null; /** * Creative serving status. Read-only. This field should not be set in requests. */ - status?: string; + status?: string | null; /** * All vendor types for the ads that may be shown from this snippet. */ - vendorType?: number[]; + vendorType?: number[] | null; /** * The version for this creative. Read-only. This field should not be set in requests. */ - version?: number; + version?: number | null; /** * The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. */ - videoURL?: string; + videoURL?: string | null; /** * Ad width. */ - width?: number; + width?: number | null; } /** * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative. @@ -361,11 +361,11 @@ export namespace adexchangebuyer_v1_3 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The configuration data for an Ad Exchange direct deal. @@ -374,63 +374,63 @@ export namespace adexchangebuyer_v1_3 { /** * The account id of the buyer this deal is for. */ - accountId?: number; + accountId?: number | null; /** * The name of the advertiser this deal is for. */ - advertiser?: string; + advertiser?: string | null; /** * Whether the publisher for this deal is eligible for alcohol ads. */ - allowsAlcohol?: boolean; + allowsAlcohol?: boolean | null; /** * The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of. */ - buyerAccountId?: string; + buyerAccountId?: string | null; /** * The currency code that applies to the fixed_cpm value. If not set then assumed to be USD. */ - currencyCode?: string; + currencyCode?: string | null; /** * The deal type such as programmatic reservation or fixed price and so on. */ - dealTier?: string; + dealTier?: string | null; /** * End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch. */ - endTime?: string; + endTime?: string | null; /** * The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price). */ - fixedCpm?: string; + fixedCpm?: string | null; /** * Deal id. */ - id?: string; + id?: string | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Deal name. */ - name?: string; + name?: string | null; /** * The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction). */ - privateExchangeMinCpm?: string; + privateExchangeMinCpm?: string | null; /** * If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal. */ - publisherBlocksOverriden?: boolean; + publisherBlocksOverriden?: boolean | null; /** * The name of the publisher offering this direct deal. */ - sellerNetwork?: string; + sellerNetwork?: string | null; /** * Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch. */ - startTime?: string; + startTime?: string | null; } /** * A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats. @@ -443,7 +443,7 @@ export namespace adexchangebuyer_v1_3 { /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * The configuration data for an Ad Exchange performance report list. @@ -452,91 +452,91 @@ export namespace adexchangebuyer_v1_3 { /** * The number of bid responses with an ad. */ - bidRate?: number; + bidRate?: number | null; /** * The number of bid requests sent to your bidder. */ - bidRequestRate?: number; + bidRequestRate?: number | null; /** * Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses. */ - calloutStatusRate?: any[]; + calloutStatusRate?: any[] | null; /** * Average QPS for cookie matcher operations. */ - cookieMatcherStatusRate?: any[]; + cookieMatcherStatusRate?: any[] | null; /** * Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses. */ - creativeStatusRate?: any[]; + creativeStatusRate?: any[] | null; /** * The number of bid responses that were filtered due to a policy violation or other errors. */ - filteredBidRate?: number; + filteredBidRate?: number | null; /** * Average QPS for hosted match operations. */ - hostedMatchStatusRate?: any[]; + hostedMatchStatusRate?: any[] | null; /** * The number of potential queries based on your pretargeting settings. */ - inventoryMatchRate?: number; + inventoryMatchRate?: number | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ - latency50thPercentile?: number; + latency50thPercentile?: number | null; /** * The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ - latency85thPercentile?: number; + latency85thPercentile?: number | null; /** * The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ - latency95thPercentile?: number; + latency95thPercentile?: number | null; /** * Rate of various quota account statuses per quota check. */ - noQuotaInRegion?: number; + noQuotaInRegion?: number | null; /** * Rate of various quota account statuses per quota check. */ - outOfQuota?: number; + outOfQuota?: number | null; /** * Average QPS for pixel match requests from clients. */ - pixelMatchRequests?: number; + pixelMatchRequests?: number | null; /** * Average QPS for pixel match responses from clients. */ - pixelMatchResponses?: number; + pixelMatchResponses?: number | null; /** * The configured quota limits for this account. */ - quotaConfiguredLimit?: number; + quotaConfiguredLimit?: number | null; /** * The throttled quota limits for this account. */ - quotaThrottledLimit?: number; + quotaThrottledLimit?: number | null; /** * The trading location of this data. */ - region?: string; + region?: string | null; /** * The number of properly formed bid responses received by our servers within the deadline. */ - successfulRequestRate?: number; + successfulRequestRate?: number | null; /** * The unix timestamp of the starting time of this performance data. */ - timestamp?: string; + timestamp?: string | null; /** * The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc. */ - unsuccessfulRequestRate?: number; + unsuccessfulRequestRate?: number | null; } /** * The configuration data for an Ad Exchange performance report list. @@ -545,7 +545,7 @@ export namespace adexchangebuyer_v1_3 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * A list of performance reports relevant for the account. */ @@ -555,95 +555,95 @@ export namespace adexchangebuyer_v1_3 { /** * The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically. */ - billingId?: string; + billingId?: string | null; /** * The config id; generated automatically. Leave this field blank for insert requests. */ - configId?: string; + configId?: string | null; /** * The name of the config. Must be unique. Required for all requests. */ - configName?: string; + configName?: string | null; /** * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. */ - creativeType?: string[]; + creativeType?: string[] | null; /** * Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions. */ - dimensions?: Array<{height?: string; width?: string}>; + dimensions?: Array<{height?: string; width?: string}> | null; /** * Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section. */ - excludedContentLabels?: string[]; + excludedContentLabels?: string[] | null; /** * Requests containing any of these geo criteria ids will not match. */ - excludedGeoCriteriaIds?: string[]; + excludedGeoCriteriaIds?: string[] | null; /** * Requests containing any of these placements will not match. */ - excludedPlacements?: Array<{token?: string; type?: string}>; + excludedPlacements?: Array<{token?: string; type?: string}> | null; /** * Requests containing any of these users list ids will not match. */ - excludedUserLists?: string[]; + excludedUserLists?: string[] | null; /** * Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. */ - excludedVerticals?: string[]; + excludedVerticals?: string[] | null; /** * Requests containing any of these geo criteria ids will match. */ - geoCriteriaIds?: string[]; + geoCriteriaIds?: string[] | null; /** * Whether this config is active. Required for all requests. */ - isActive?: boolean; + isActive?: boolean | null; /** * The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig". */ - kind?: string; + kind?: string | null; /** * Request containing any of these language codes will match. */ - languages?: string[]; + languages?: string[] | null; /** * Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section. */ - mobileCarriers?: string[]; + mobileCarriers?: string[] | null; /** * Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section. */ - mobileDevices?: string[]; + mobileDevices?: string[] | null; /** * Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section. */ - mobileOperatingSystemVersions?: string[]; + mobileOperatingSystemVersions?: string[] | null; /** * Requests containing any of these placements will match. */ - placements?: Array<{token?: string; type?: string}>; + placements?: Array<{token?: string; type?: string}> | null; /** * Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. */ - platforms?: string[]; + platforms?: string[] | null; /** * Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section. */ - supportedCreativeAttributes?: string[]; + supportedCreativeAttributes?: string[] | null; /** * Requests containing any of these user list ids will match. */ - userLists?: string[]; + userLists?: string[] | null; /** * Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section. */ - vendorTypes?: string[]; + vendorTypes?: string[] | null; /** * Requests containing any of these vertical ids will match. */ - verticals?: string[]; + verticals?: string[] | null; } export interface Schema$PretargetingConfigList { /** @@ -653,7 +653,7 @@ export namespace adexchangebuyer_v1_3 { /** * Resource type. */ - kind?: string; + kind?: string | null; } export class Resource$Accounts { diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts index 4358bbe663b..b6f8fca58d3 100644 --- a/src/apis/adexchangebuyer/v1.4.ts +++ b/src/apis/adexchangebuyer/v1.4.ts @@ -132,7 +132,7 @@ export namespace adexchangebuyer_v1_4 { /** * When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. */ - applyPretargetingToNonGuaranteedDeals?: boolean; + applyPretargetingToNonGuaranteedDeals?: boolean | null; /** * Your bidder locations that have distinct URLs. */ @@ -141,35 +141,35 @@ export namespace adexchangebuyer_v1_4 { maximumQps?: number; region?: string; url?: string; - }>; + }> | null; /** * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. */ - cookieMatchingNid?: string; + cookieMatchingNid?: string | null; /** * The base URL used in cookie match requests. */ - cookieMatchingUrl?: string; + cookieMatchingUrl?: string | null; /** * Account id. */ - id?: number; + id?: number | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this. */ - maximumActiveCreatives?: number; + maximumActiveCreatives?: number | null; /** * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. */ - maximumTotalQps?: number; + maximumTotalQps?: number | null; /** * The number of creatives that this account inserted or bid with in the last 30 days. */ - numberActiveCreatives?: number; + numberActiveCreatives?: number | null; } /** * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account. @@ -182,7 +182,7 @@ export namespace adexchangebuyer_v1_4 { /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$AddOrderDealsRequest { /** @@ -192,11 +192,11 @@ export namespace adexchangebuyer_v1_4 { /** * The last known proposal revision number. */ - proposalRevisionNumber?: string; + proposalRevisionNumber?: string | null; /** * Indicates an optional action to take on the proposal */ - updateAction?: string; + updateAction?: string | null; } export interface Schema$AddOrderDealsResponse { /** @@ -206,7 +206,7 @@ export namespace adexchangebuyer_v1_4 { /** * The updated revision number for the proposal. */ - proposalRevisionNumber?: string; + proposalRevisionNumber?: string | null; } export interface Schema$AddOrderNotesRequest { /** @@ -224,19 +224,19 @@ export namespace adexchangebuyer_v1_4 { /** * Account id. */ - accountId?: number; + accountId?: number | null; /** * Account name. */ - accountName?: string; + accountName?: string | null; /** * A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account. */ - billingId?: string[]; + billingId?: string[] | null; /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info. @@ -249,7 +249,7 @@ export namespace adexchangebuyer_v1_4 { /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * The configuration data for Ad Exchange RTB - Budget API. @@ -258,43 +258,43 @@ export namespace adexchangebuyer_v1_4 { /** * The id of the account. This is required for get and update requests. */ - accountId?: string; + accountId?: string | null; /** * The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. */ - billingId?: string; + billingId?: string | null; /** * The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. */ - budgetAmount?: string; + budgetAmount?: string | null; /** * The currency code for the buyer. This cannot be altered here. */ - currencyCode?: string; + currencyCode?: string | null; /** * The unique id that describes this item. */ - id?: string; + id?: string | null; /** * The kind of the resource, i.e. "adexchangebuyer#budget". */ - kind?: string; + kind?: string | null; } export interface Schema$Buyer { /** * Adx account id of the buyer. */ - accountId?: string; + accountId?: string | null; } export interface Schema$ContactInformation { /** * Email address of the contact. */ - email?: string; + email?: string | null; /** * The name of the contact. */ - name?: string; + name?: string | null; } export interface Schema$CreateOrdersRequest { /** @@ -304,7 +304,7 @@ export namespace adexchangebuyer_v1_4 { /** * Web property id of the seller creating these orders */ - webPropertyCode?: string; + webPropertyCode?: string | null; } export interface Schema$CreateOrdersResponse { /** @@ -319,43 +319,43 @@ export namespace adexchangebuyer_v1_4 { /** * Account id. */ - accountId?: number; + accountId?: number | null; /** * The link to the Ad Preferences page. This is only supported for native ads. */ - adChoicesDestinationUrl?: string; + adChoicesDestinationUrl?: string | null; adTechnologyProviders?: { detectedProviderIds?: string[]; hasUnidentifiedProvider?: boolean; - }; + } | null; /** * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ - advertiserId?: string[]; + advertiserId?: string[] | null; /** * The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file. */ - advertiserName?: string; + advertiserName?: string | null; /** * The agency id for this creative. */ - agencyId?: string; + agencyId?: string | null; /** * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). */ - apiUploadTimestamp?: string; + apiUploadTimestamp?: string | null; /** * List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt. */ - attribute?: number[]; + attribute?: number[] | null; /** * A buyer-specific id identifying the creative in this ad. */ - buyerCreativeId?: string; + buyerCreativeId?: string | null; /** * The set of destination urls for the snippet. */ - clickThroughUrl?: string[]; + clickThroughUrl?: string[] | null; /** * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. */ @@ -368,46 +368,46 @@ export namespace adexchangebuyer_v1_4 { }>; details?: string[]; reason?: string; - }>; + }> | null; /** * Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole. */ - creativeStatusIdentityType?: string; + creativeStatusIdentityType?: string | null; /** * Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly. */ - dealsStatus?: string; + dealsStatus?: string | null; /** * Detected domains for this creative. Read-only. This field should not be set in requests. */ - detectedDomains?: string[]; + detectedDomains?: string[] | null; /** * The filtering reasons for the creative. Read-only. This field should not be set in requests. */ filteringReasons?: { date?: string; reasons?: Array<{filteringCount?: string; filteringStatus?: number}>; - }; + } | null; /** * Ad height. */ - height?: number; + height?: number | null; /** * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set. */ - HTMLSnippet?: string; + HTMLSnippet?: string | null; /** * The set of urls to be called to record an impression. */ - impressionTrackingUrl?: string[]; + impressionTrackingUrl?: string[] | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Detected languages for this creative. Read-only. This field should not be set in requests. */ - languages?: string[]; + languages?: string[] | null; /** * If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) */ @@ -425,23 +425,23 @@ export namespace adexchangebuyer_v1_4 { price?: string; starRating?: number; videoURL?: string; - }; + } | null; /** * Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly. */ - openAuctionStatus?: string; + openAuctionStatus?: string | null; /** * Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. */ - productCategories?: number[]; + productCategories?: number[] | null; /** * All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt. */ - restrictedCategories?: number[]; + restrictedCategories?: number[] | null; /** * Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. */ - sensitiveCategories?: number[]; + sensitiveCategories?: number[] | null; /** * The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details. */ @@ -454,27 +454,27 @@ export namespace adexchangebuyer_v1_4 { }>; disapprovalReasons?: Array<{details?: string[]; reason?: string}>; reason?: string; - }>; + }> | null; /** * List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. */ - vendorType?: number[]; + vendorType?: number[] | null; /** * The version for this creative. Read-only. This field should not be set in requests. */ - version?: number; + version?: number | null; /** * The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above. */ - videoURL?: string; + videoURL?: string | null; /** * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. */ - videoVastXML?: string; + videoVastXML?: string | null; /** * Ad width. */ - width?: number; + width?: number | null; } /** * The external deal ids associated with a creative. @@ -487,11 +487,11 @@ export namespace adexchangebuyer_v1_4 { arcStatus?: string; dealId?: string; webPropertyId?: number; - }>; + }> | null; /** * Resource type. */ - kind?: string; + kind?: string | null; } /** * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative. @@ -504,17 +504,17 @@ export namespace adexchangebuyer_v1_4 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$DealServingMetadata { /** * True if alcohol ads are allowed for this deal (read-only). This field is only populated when querying for finalized orders using the method GetFinalizedOrderDeals */ - alcoholAdsAllowed?: boolean; + alcoholAdsAllowed?: boolean | null; /** * Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action) */ @@ -524,28 +524,28 @@ export namespace adexchangebuyer_v1_4 { * Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. */ export interface Schema$DealServingMetadataDealPauseStatus { - buyerPauseReason?: string; + buyerPauseReason?: string | null; /** * If the deal is paused, records which party paused the deal first. */ - firstPausedBy?: string; - hasBuyerPaused?: boolean; - hasSellerPaused?: boolean; - sellerPauseReason?: string; + firstPausedBy?: string | null; + hasBuyerPaused?: boolean | null; + hasSellerPaused?: boolean | null; + sellerPauseReason?: string | null; } export interface Schema$DealTerms { /** * Visibilty of the URL in bid requests. */ - brandingType?: string; + brandingType?: string | null; /** * Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case. */ - crossListedExternalDealIdType?: string; + crossListedExternalDealIdType?: string | null; /** * Description for the proposed terms of the deal. */ - description?: string; + description?: string | null; /** * Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. */ @@ -553,7 +553,7 @@ export namespace adexchangebuyer_v1_4 { /** * Non-binding estimate of the impressions served per day Can be set by buyer or seller. */ - estimatedImpressionsPerDay?: string; + estimatedImpressionsPerDay?: string | null; /** * The terms for guaranteed fixed price deals. */ @@ -573,7 +573,7 @@ export namespace adexchangebuyer_v1_4 { /** * For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) */ - sellerTimeZone?: string; + sellerTimeZone?: string | null; } export interface Schema$DealTermsGuaranteedFixedPriceTerms { /** @@ -587,29 +587,29 @@ export namespace adexchangebuyer_v1_4 { /** * Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. */ - guaranteedImpressions?: string; + guaranteedImpressions?: string | null; /** * Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. */ - guaranteedLooks?: string; + guaranteedLooks?: string | null; /** * Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. */ - minimumDailyLooks?: string; + minimumDailyLooks?: string | null; } export interface Schema$DealTermsGuaranteedFixedPriceTermsBillingInfo { /** * The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy. */ - currencyConversionTimeMs?: string; + currencyConversionTimeMs?: string | null; /** * The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. */ - dfpLineItemId?: string; + dfpLineItemId?: string | null; /** * The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. */ - originalContractedQuantity?: string; + originalContractedQuantity?: string | null; /** * The original reservation price for the deal, if the currency code is different from the one used in negotiation. */ @@ -619,7 +619,7 @@ export namespace adexchangebuyer_v1_4 { /** * True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). */ - autoOptimizePrivateAuction?: boolean; + autoOptimizePrivateAuction?: boolean | null; /** * Reserve price for the specified buyer. */ @@ -645,15 +645,15 @@ export namespace adexchangebuyer_v1_4 { /** * List of deals to delete for a given proposal */ - dealIds?: string[]; + dealIds?: string[] | null; /** * The last known proposal revision number. */ - proposalRevisionNumber?: string; + proposalRevisionNumber?: string | null; /** * Indicates an optional action to take on the proposal */ - updateAction?: string; + updateAction?: string | null; } export interface Schema$DeleteOrderDealsResponse { /** @@ -663,23 +663,23 @@ export namespace adexchangebuyer_v1_4 { /** * The updated revision number for the proposal. */ - proposalRevisionNumber?: string; + proposalRevisionNumber?: string | null; } export interface Schema$DeliveryControl { - creativeBlockingLevel?: string; - deliveryRateType?: string; + creativeBlockingLevel?: string | null; + deliveryRateType?: string | null; frequencyCaps?: Schema$DeliveryControlFrequencyCap[]; } export interface Schema$DeliveryControlFrequencyCap { - maxImpressions?: number; - numTimeUnits?: number; - timeUnitType?: string; + maxImpressions?: number | null; + numTimeUnits?: number | null; + timeUnitType?: string | null; } /** * This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]} */ export interface Schema$Dimension { - dimensionType?: string; + dimensionType?: string | null; dimensionValues?: Schema$DimensionDimensionValue[]; } /** @@ -689,15 +689,15 @@ export namespace adexchangebuyer_v1_4 { /** * Id of the dimension. */ - id?: number; + id?: number | null; /** * Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. */ - name?: string; + name?: string | null; /** * Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender. */ - percentage?: number; + percentage?: number | null; } export interface Schema$EditAllOrderDealsRequest { /** @@ -711,11 +711,11 @@ export namespace adexchangebuyer_v1_4 { /** * The last known revision number for the proposal. */ - proposalRevisionNumber?: string; + proposalRevisionNumber?: string | null; /** * Indicates an optional action to take on the proposal */ - updateAction?: string; + updateAction?: string | null; } export interface Schema$EditAllOrderDealsResponse { /** @@ -725,7 +725,7 @@ export namespace adexchangebuyer_v1_4 { /** * The latest revision number after the update has been applied. */ - orderRevisionNumber?: string; + orderRevisionNumber?: string | null; } export interface Schema$GetOffersResponse { /** @@ -768,19 +768,19 @@ export namespace adexchangebuyer_v1_4 { /** * The time (ms since epoch) of the deal creation. (readonly) */ - creationTimeMs?: string; + creationTimeMs?: string | null; /** * Specifies the creative pre-approval policy (buyer-readonly) */ - creativePreApprovalPolicy?: string; + creativePreApprovalPolicy?: string | null; /** * Specifies whether the creative is safeFrame compatible (buyer-readonly) */ - creativeSafeFrameCompatibility?: string; + creativeSafeFrameCompatibility?: string | null; /** * A unique deal-id for the deal (readonly). */ - dealId?: string; + dealId?: string | null; /** * Metadata about the serving status of this deal (readonly, writes via custom actions) */ @@ -792,52 +792,52 @@ export namespace adexchangebuyer_v1_4 { /** * The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) */ - externalDealId?: string; + externalDealId?: string | null; /** * Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) */ - flightEndTimeMs?: string; + flightEndTimeMs?: string | null; /** * Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) */ - flightStartTimeMs?: string; + flightStartTimeMs?: string | null; /** * Description for the deal terms. (buyer-readonly) */ - inventoryDescription?: string; + inventoryDescription?: string | null; /** * Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products. */ - isRfpTemplate?: boolean; + isRfpTemplate?: boolean | null; /** * True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action) */ - isSetupComplete?: boolean; + isSetupComplete?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal". */ - kind?: string; + kind?: string | null; /** * The time (ms since epoch) when the deal was last updated. (readonly) */ - lastUpdateTimeMs?: string; + lastUpdateTimeMs?: string | null; /** * The name of the deal. (updatable) */ - name?: string; + name?: string | null; /** * The product-id from which this deal was created. (readonly, except on create) */ - productId?: string; + productId?: string | null; /** * The revision number of the product that the deal was created from (readonly, except on create) */ - productRevisionNumber?: string; + productRevisionNumber?: string | null; /** * Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly) */ - programmaticCreativeSource?: string; - proposalId?: string; + programmaticCreativeSource?: string | null; + proposalId?: string | null; /** * Optional Seller contact information for the deal (buyer-readonly) */ @@ -849,12 +849,12 @@ export namespace adexchangebuyer_v1_4 { /** * The syndication product associated with the deal. (readonly, except on create) */ - syndicationProduct?: string; + syndicationProduct?: string | null; /** * The negotiable terms of the deal. (updatable) */ terms?: Schema$DealTerms; - webPropertyCode?: string; + webPropertyCode?: string | null; } export interface Schema$MarketplaceDealParty { /** @@ -870,11 +870,11 @@ export namespace adexchangebuyer_v1_4 { /** * The accountId of the party that created the label. */ - accountId?: string; + accountId?: string | null; /** * The creation time (in ms since epoch) for the label. */ - createTimeMs?: string; + createTimeMs?: string | null; /** * Information about the party that created the label. */ @@ -882,7 +882,7 @@ export namespace adexchangebuyer_v1_4 { /** * The label to use. */ - label?: string; + label?: string | null; } /** * A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. @@ -891,35 +891,35 @@ export namespace adexchangebuyer_v1_4 { /** * The role of the person (buyer/seller) creating the note. (readonly) */ - creatorRole?: string; + creatorRole?: string | null; /** * Notes can optionally be associated with a deal. (readonly, except on create) */ - dealId?: string; + dealId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote". */ - kind?: string; + kind?: string | null; /** * The actual note to attach. (readonly, except on create) */ - note?: string; + note?: string | null; /** * The unique id for the note. (readonly) */ - noteId?: string; + noteId?: string | null; /** * The proposalId that a note is attached to. (readonly) */ - proposalId?: string; + proposalId?: string | null; /** * If the note is associated with a proposal revision number, then store that here. (readonly, except on create) */ - proposalRevisionNumber?: string; + proposalRevisionNumber?: string | null; /** * The timestamp (ms since epoch) that this note was created. (readonly) */ - timestampMs?: string; + timestampMs?: string | null; } /** * The configuration data for an Ad Exchange performance report list. @@ -928,91 +928,91 @@ export namespace adexchangebuyer_v1_4 { /** * The number of bid responses with an ad. */ - bidRate?: number; + bidRate?: number | null; /** * The number of bid requests sent to your bidder. */ - bidRequestRate?: number; + bidRequestRate?: number | null; /** * Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses. */ - calloutStatusRate?: any[]; + calloutStatusRate?: any[] | null; /** * Average QPS for cookie matcher operations. */ - cookieMatcherStatusRate?: any[]; + cookieMatcherStatusRate?: any[] | null; /** * Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses. */ - creativeStatusRate?: any[]; + creativeStatusRate?: any[] | null; /** * The number of bid responses that were filtered due to a policy violation or other errors. */ - filteredBidRate?: number; + filteredBidRate?: number | null; /** * Average QPS for hosted match operations. */ - hostedMatchStatusRate?: any[]; + hostedMatchStatusRate?: any[] | null; /** * The number of potential queries based on your pretargeting settings. */ - inventoryMatchRate?: number; + inventoryMatchRate?: number | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ - latency50thPercentile?: number; + latency50thPercentile?: number | null; /** * The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ - latency85thPercentile?: number; + latency85thPercentile?: number | null; /** * The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ - latency95thPercentile?: number; + latency95thPercentile?: number | null; /** * Rate of various quota account statuses per quota check. */ - noQuotaInRegion?: number; + noQuotaInRegion?: number | null; /** * Rate of various quota account statuses per quota check. */ - outOfQuota?: number; + outOfQuota?: number | null; /** * Average QPS for pixel match requests from clients. */ - pixelMatchRequests?: number; + pixelMatchRequests?: number | null; /** * Average QPS for pixel match responses from clients. */ - pixelMatchResponses?: number; + pixelMatchResponses?: number | null; /** * The configured quota limits for this account. */ - quotaConfiguredLimit?: number; + quotaConfiguredLimit?: number | null; /** * The throttled quota limits for this account. */ - quotaThrottledLimit?: number; + quotaThrottledLimit?: number | null; /** * The trading location of this data. */ - region?: string; + region?: string | null; /** * The number of properly formed bid responses received by our servers within the deadline. */ - successfulRequestRate?: number; + successfulRequestRate?: number | null; /** * The unix timestamp of the starting time of this performance data. */ - timestamp?: string; + timestamp?: string | null; /** * The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc. */ - unsuccessfulRequestRate?: number; + unsuccessfulRequestRate?: number | null; } /** * The configuration data for an Ad Exchange performance report list. @@ -1021,7 +1021,7 @@ export namespace adexchangebuyer_v1_4 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * A list of performance reports relevant for the account. */ @@ -1031,103 +1031,103 @@ export namespace adexchangebuyer_v1_4 { /** * The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically. */ - billingId?: string; + billingId?: string | null; /** * The config id; generated automatically. Leave this field blank for insert requests. */ - configId?: string; + configId?: string | null; /** * The name of the config. Must be unique. Required for all requests. */ - configName?: string; + configName?: string | null; /** * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. */ - creativeType?: string[]; + creativeType?: string[] | null; /** * Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions. */ - dimensions?: Array<{height?: string; width?: string}>; + dimensions?: Array<{height?: string; width?: string}> | null; /** * Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section. */ - excludedContentLabels?: string[]; + excludedContentLabels?: string[] | null; /** * Requests containing any of these geo criteria ids will not match. */ - excludedGeoCriteriaIds?: string[]; + excludedGeoCriteriaIds?: string[] | null; /** * Requests containing any of these placements will not match. */ - excludedPlacements?: Array<{token?: string; type?: string}>; + excludedPlacements?: Array<{token?: string; type?: string}> | null; /** * Requests containing any of these users list ids will not match. */ - excludedUserLists?: string[]; + excludedUserLists?: string[] | null; /** * Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. */ - excludedVerticals?: string[]; + excludedVerticals?: string[] | null; /** * Requests containing any of these geo criteria ids will match. */ - geoCriteriaIds?: string[]; + geoCriteriaIds?: string[] | null; /** * Whether this config is active. Required for all requests. */ - isActive?: boolean; + isActive?: boolean | null; /** * The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig". */ - kind?: string; + kind?: string | null; /** * Request containing any of these language codes will match. */ - languages?: string[]; + languages?: string[] | null; /** * Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored. */ - minimumViewabilityDecile?: number; + minimumViewabilityDecile?: number | null; /** * Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section. */ - mobileCarriers?: string[]; + mobileCarriers?: string[] | null; /** * Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section. */ - mobileDevices?: string[]; + mobileDevices?: string[] | null; /** * Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section. */ - mobileOperatingSystemVersions?: string[]; + mobileOperatingSystemVersions?: string[] | null; /** * Requests containing any of these placements will match. */ - placements?: Array<{token?: string; type?: string}>; + placements?: Array<{token?: string; type?: string}> | null; /** * Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. */ - platforms?: string[]; + platforms?: string[] | null; /** * Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section. */ - supportedCreativeAttributes?: string[]; + supportedCreativeAttributes?: string[] | null; /** * Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA. */ - userIdentifierDataRequired?: string[]; + userIdentifierDataRequired?: string[] | null; /** * Requests containing any of these user list ids will match. */ - userLists?: string[]; + userLists?: string[] | null; /** * Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section. */ - vendorTypes?: string[]; + vendorTypes?: string[] | null; /** * Requests containing any of these vertical ids will match. */ - verticals?: string[]; + verticals?: string[] | null; /** * Video requests satisfying any of these player size constraints will match. */ @@ -1135,7 +1135,7 @@ export namespace adexchangebuyer_v1_4 { aspectRatio?: string; minHeight?: string; minWidth?: string; - }>; + }> | null; } export interface Schema$PretargetingConfigList { /** @@ -1145,25 +1145,25 @@ export namespace adexchangebuyer_v1_4 { /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$Price { /** * The price value in micros. */ - amountMicros?: number; + amountMicros?: number | null; /** * The currency code for the price. */ - currencyCode?: string; + currencyCode?: string | null; /** * In case of CPD deals, the expected CPM in micros. */ - expectedCpmMicros?: number; + expectedCpmMicros?: number | null; /** * The pricing type for the deal/product. */ - pricingType?: string; + pricingType?: string | null; } /** * Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. @@ -1172,7 +1172,7 @@ export namespace adexchangebuyer_v1_4 { /** * Optional access type for this buyer. */ - auctionTier?: string; + auctionTier?: string | null; /** * Reference to the buyer that will get billed. */ @@ -1187,8 +1187,8 @@ export namespace adexchangebuyer_v1_4 { price?: Schema$Price; } export interface Schema$PrivateData { - referenceId?: string; - referencePayload?: string; + referenceId?: string | null; + referencePayload?: string | null; } /** * A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. @@ -1205,7 +1205,7 @@ export namespace adexchangebuyer_v1_4 { /** * Creation time in ms. since epoch (readonly) */ - creationTimeMs?: string; + creationTimeMs?: string | null; /** * Optional contact information for the creator of this product. (buyer-readonly) */ @@ -1213,7 +1213,7 @@ export namespace adexchangebuyer_v1_4 { /** * The role that created the offer. Set to BUYER for buyer initiated offers. */ - creatorRole?: string; + creatorRole?: string | null; /** * The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. */ @@ -1221,23 +1221,23 @@ export namespace adexchangebuyer_v1_4 { /** * The proposed end time for the deal (ms since epoch) (buyer-readonly) */ - flightEndTimeMs?: string; + flightEndTimeMs?: string | null; /** * Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly) */ - flightStartTimeMs?: string; + flightStartTimeMs?: string | null; /** * If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. */ - hasCreatorSignedOff?: boolean; + hasCreatorSignedOff?: boolean | null; /** * What exchange will provide this inventory (readonly, except on create). */ - inventorySource?: string; + inventorySource?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product". */ - kind?: string; + kind?: string | null; /** * Optional List of labels for the product (optional, buyer-readonly). */ @@ -1245,31 +1245,31 @@ export namespace adexchangebuyer_v1_4 { /** * Time of last update in ms. since epoch (readonly) */ - lastUpdateTimeMs?: string; + lastUpdateTimeMs?: string | null; /** * Optional legacy offer id if this offer is a preferred deal offer. */ - legacyOfferId?: string; + legacyOfferId?: string | null; /** * Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself. */ - marketplacePublisherProfileId?: string; + marketplacePublisherProfileId?: string | null; /** * The name for this product as set by the seller. (buyer-readonly) */ - name?: string; + name?: string | null; /** * Optional private auction id if this offer is a private auction offer. */ - privateAuctionId?: string; + privateAuctionId?: string | null; /** * The unique id for the product (readonly) */ - productId?: string; + productId?: string | null; /** * Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller. */ - publisherProfileId?: string; + publisherProfileId?: string | null; /** * Publisher self-provided forecast information. */ @@ -1277,7 +1277,7 @@ export namespace adexchangebuyer_v1_4 { /** * The revision number of the product. (readonly) */ - revisionNumber?: string; + revisionNumber?: string | null; /** * Information about the seller that created this product (readonly, except on create) */ @@ -1289,11 +1289,11 @@ export namespace adexchangebuyer_v1_4 { /** * The state of the product. (buyer-readonly) */ - state?: string; + state?: string | null; /** * The syndication product associated with the deal. (readonly, except on create) */ - syndicationProduct?: string; + syndicationProduct?: string | null; /** * The negotiable terms of the deal (buyer-readonly) */ @@ -1301,7 +1301,7 @@ export namespace adexchangebuyer_v1_4 { /** * The web property code for the seller. This field is meant to be copied over as is when creating deals. */ - webPropertyCode?: string; + webPropertyCode?: string | null; } /** * Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. @@ -1326,31 +1326,31 @@ export namespace adexchangebuyer_v1_4 { /** * IDs of DBM advertisers permission to this proposal. */ - dbmAdvertiserIds?: string[]; + dbmAdvertiserIds?: string[] | null; /** * When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) */ - hasBuyerSignedOff?: boolean; + hasBuyerSignedOff?: boolean | null; /** * When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) */ - hasSellerSignedOff?: boolean; + hasSellerSignedOff?: boolean | null; /** * What exchange will provide this inventory (readonly, except on create). */ - inventorySource?: string; + inventorySource?: string | null; /** * True if the proposal is being renegotiated (readonly). */ - isRenegotiating?: boolean; + isRenegotiating?: boolean | null; /** * True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag. */ - isSetupComplete?: boolean; + isSetupComplete?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". */ - kind?: string; + kind?: string | null; /** * List of labels associated with the proposal. (readonly) */ @@ -1358,39 +1358,39 @@ export namespace adexchangebuyer_v1_4 { /** * The role of the last user that either updated the proposal or left a comment. (readonly) */ - lastUpdaterOrCommentorRole?: string; + lastUpdaterOrCommentorRole?: string | null; /** * The name for the proposal (updatable) */ - name?: string; + name?: string | null; /** * Optional negotiation id if this proposal is a preferred deal proposal. */ - negotiationId?: string; + negotiationId?: string | null; /** * Indicates whether the buyer/seller created the proposal.(readonly) */ - originatorRole?: string; + originatorRole?: string | null; /** * Optional private auction id if this proposal is a private auction proposal. */ - privateAuctionId?: string; + privateAuctionId?: string | null; /** * The unique id of the proposal. (readonly). */ - proposalId?: string; + proposalId?: string | null; /** * The current state of the proposal. (readonly) */ - proposalState?: string; + proposalState?: string | null; /** * The revision number for the proposal (readonly). */ - revisionNumber?: string; + revisionNumber?: string | null; /** * The time (ms since epoch) when the proposal was last revised (readonly). */ - revisionTimeMs?: string; + revisionTimeMs?: string | null; /** * Reference to the seller on the proposal. (readonly, except on create) */ @@ -1404,64 +1404,64 @@ export namespace adexchangebuyer_v1_4 { /** * Publisher provided info on its audience. */ - audience?: string; + audience?: string | null; /** * A pitch statement for the buyer */ - buyerPitchStatement?: string; + buyerPitchStatement?: string | null; /** * Direct contact for the publisher profile. */ - directContact?: string; + directContact?: string | null; /** * Exchange where this publisher profile is from. E.g. AdX, Rubicon etc... */ - exchange?: string; + exchange?: string | null; /** * Link to publisher's Google+ page. */ - googlePlusLink?: string; + googlePlusLink?: string | null; /** * True, if this is the parent profile, which represents all domains owned by the publisher. */ - isParent?: boolean; + isParent?: boolean | null; /** * True, if this profile is published. Deprecated for state. */ - isPublished?: boolean; + isPublished?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#publisherProfileApiProto". */ - kind?: string; + kind?: string | null; /** * The url to the logo for the publisher. */ - logoUrl?: string; + logoUrl?: string | null; /** * The url for additional marketing and sales materials. */ - mediaKitLink?: string; - name?: string; + mediaKitLink?: string | null; + name?: string | null; /** * Publisher provided overview. */ - overview?: string; + overview?: string | null; /** * The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher. */ - profileId?: number; + profileId?: number | null; /** * Programmatic contact for the publisher profile. */ - programmaticContact?: string; + programmaticContact?: string | null; /** * The list of domains represented in this publisher profile. Empty if this is a parent profile. */ - publisherDomains?: string[]; + publisherDomains?: string[] | null; /** * Unique Id for publisher profile. */ - publisherProfileId?: string; + publisherProfileId?: string | null; /** * Publisher provided forecasting information. */ @@ -1469,11 +1469,11 @@ export namespace adexchangebuyer_v1_4 { /** * Link to publisher rate card */ - rateCardInfoLink?: string; + rateCardInfoLink?: string | null; /** * Link for a sample content page. */ - samplePageLink?: string; + samplePageLink?: string | null; /** * Seller of the publisher profile. */ @@ -1481,11 +1481,11 @@ export namespace adexchangebuyer_v1_4 { /** * State of the publisher profile. */ - state?: string; + state?: string | null; /** * Publisher provided key metrics and rankings. */ - topHeadlines?: string[]; + topHeadlines?: string[] | null; } /** * This message carries publisher provided forecasting information. @@ -1498,21 +1498,21 @@ export namespace adexchangebuyer_v1_4 { /** * Publisher provided weekly impressions. */ - weeklyImpressions?: string; + weeklyImpressions?: string | null; /** * Publisher provided weekly uniques. */ - weeklyUniques?: string; + weeklyUniques?: string | null; } export interface Schema$Seller { /** * The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. */ - accountId?: string; + accountId?: string | null; /** * Optional sub-account id for the seller. */ - subAccountId?: string; + subAccountId?: string | null; } export interface Schema$SharedTargeting { /** @@ -1526,7 +1526,7 @@ export namespace adexchangebuyer_v1_4 { /** * The key representing the shared targeting criterion. */ - key?: string; + key?: string | null; } export interface Schema$TargetingValue { /** @@ -1542,11 +1542,11 @@ export namespace adexchangebuyer_v1_4 { /** * The long value to exclude/include. */ - longValue?: string; + longValue?: string | null; /** * The string value to exclude/include. */ - stringValue?: string; + stringValue?: string | null; } /** * Next Id: 7 @@ -1555,7 +1555,7 @@ export namespace adexchangebuyer_v1_4 { /** * The formats allowed by the publisher. */ - allowedFormats?: string[]; + allowedFormats?: string[] | null; /** * For video size type, the list of companion sizes. */ @@ -1563,11 +1563,11 @@ export namespace adexchangebuyer_v1_4 { /** * The Creative size type. */ - creativeSizeType?: string; + creativeSizeType?: string | null; /** * The native template for native ad. */ - nativeTemplate?: string; + nativeTemplate?: string | null; /** * For regular or video creative size type, specifies the size of the creative. */ @@ -1575,40 +1575,40 @@ export namespace adexchangebuyer_v1_4 { /** * The skippable ad type for video size. */ - skippableAdType?: string; + skippableAdType?: string | null; } export interface Schema$TargetingValueDayPartTargeting { dayParts?: Schema$TargetingValueDayPartTargetingDayPart[]; - timeZoneType?: string; + timeZoneType?: string | null; } export interface Schema$TargetingValueDayPartTargetingDayPart { - dayOfWeek?: string; - endHour?: number; - endMinute?: number; - startHour?: number; - startMinute?: number; + dayOfWeek?: string | null; + endHour?: number | null; + endMinute?: number | null; + startHour?: number | null; + startMinute?: number | null; } export interface Schema$TargetingValueDemogAgeCriteria { - demogAgeCriteriaIds?: string[]; + demogAgeCriteriaIds?: string[] | null; } export interface Schema$TargetingValueDemogGenderCriteria { - demogGenderCriteriaIds?: string[]; + demogGenderCriteriaIds?: string[] | null; } export interface Schema$TargetingValueSize { /** * The height of the creative. */ - height?: number; + height?: number | null; /** * The width of the creative. */ - width?: number; + width?: number | null; } export interface Schema$UpdatePrivateAuctionProposalRequest { /** * The externalDealId of the deal to be updated. */ - externalDealId?: string; + externalDealId?: string | null; /** * Optional note to be added. */ @@ -1616,11 +1616,11 @@ export namespace adexchangebuyer_v1_4 { /** * The current revision number of the proposal to be updated. */ - proposalRevisionNumber?: string; + proposalRevisionNumber?: string | null; /** * The proposed action on the private auction proposal. */ - updateAction?: string; + updateAction?: string | null; } export class Resource$Accounts { diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index e42b7f4c8bc..7e6a3ab1e08 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -139,7 +139,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The last known client revision number of the proposal. */ - proposalRevision?: string; + proposalRevision?: string | null; } /** * A request for associating a deal and a creative. @@ -166,15 +166,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */ - height?: string; + height?: string | null; /** * The size type of the ad slot. */ - sizeType?: string; + sizeType?: string | null; /** * The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */ - width?: string; + width?: string | null; } /** * Detected ad technology provider information. @@ -183,11 +183,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. */ - detectedProviderIds?: string[]; + detectedProviderIds?: string[] | null; /** * Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. */ - hasUnidentifiedProvider?: boolean; + hasUnidentifiedProvider?: boolean | null; } /** * Output only. The app type the restriction applies to for mobile device. @@ -196,7 +196,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The app types this restriction applies to. */ - appTypes?: string[]; + appTypes?: string[] | null; } /** * Output only. The auction type the restriction applies to. @@ -205,7 +205,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The auction types this restriction applies to. */ - auctionTypes?: string[]; + auctionTypes?: string[] | null; } /** * The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel; @@ -255,7 +255,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The status specifying why the bid responses were considered to have no applicable bids. */ - status?: string; + status?: string | null; } /** * Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. @@ -264,7 +264,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * Authorized Buyers account ID of the buyer. */ - accountId?: string; + accountId?: string | null; } /** * The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status. @@ -273,7 +273,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). */ - calloutStatusId?: number; + calloutStatusId?: number | null; /** * The number of impressions for which there was a bid request or bid response with the specified callout status. */ @@ -294,39 +294,39 @@ export namespace adexchangebuyer2_v2beta1 { /** * The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. */ - clientAccountId?: string; + clientAccountId?: string | null; /** * Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty. */ - clientName?: string; + clientName?: string | null; /** * Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file. */ - entityId?: string; + entityId?: string | null; /** * The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations. */ - entityName?: string; + entityName?: string | null; /** * The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. */ - entityType?: string; + entityType?: string | null; /** * Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer. */ - partnerClientId?: string; + partnerClientId?: string | null; /** * The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. */ - role?: string; + role?: string | null; /** * The status of the client buyer. */ - status?: string; + status?: string | null; /** * Whether the client buyer will be visible to sellers. */ - visibleToSeller?: boolean; + visibleToSeller?: boolean | null; } /** * A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. @@ -335,19 +335,19 @@ export namespace adexchangebuyer2_v2beta1 { /** * Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. */ - clientAccountId?: string; + clientAccountId?: string | null; /** * User's email address. The value of this field is ignored in an update operation. */ - email?: string; + email?: string | null; /** * The status of the client user. */ - status?: string; + status?: string | null; /** * The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. */ - userId?: string; + userId?: string | null; } /** * An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified. @@ -356,15 +356,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations. */ - clientAccountId?: string; + clientAccountId?: string | null; /** * The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer. */ - email?: string; + email?: string | null; /** * The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations. */ - invitationId?: string; + invitationId?: string | null; } /** * Request message for indicating that the proposal's setup step is complete. @@ -377,11 +377,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Email address for the contact. */ - email?: string; + email?: string | null; /** * The name of the contact. */ - name?: string; + name?: string | null; } /** * Output only. Shows any corrections that were applied to this creative. @@ -394,11 +394,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Additional details about what was corrected. */ - details?: string[]; + details?: string[] | null; /** * The type of correction that was applied to the creative. */ - type?: string; + type?: string | null; } /** * A creative and its classification data. @@ -407,11 +407,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */ - accountId?: string; + accountId?: string | null; /** * The link to AdChoices destination page. */ - adChoicesDestinationUrl?: string; + adChoicesDestinationUrl?: string | null; /** * Output only. The detected ad technology providers. */ @@ -419,23 +419,23 @@ export namespace adexchangebuyer2_v2beta1 { /** * The name of the company being advertised in the creative. */ - advertiserName?: string; + advertiserName?: string | null; /** * The agency ID for this creative. */ - agencyId?: string; + agencyId?: string | null; /** * Output only. The last update timestamp of the creative via API. */ - apiUpdateTime?: string; + apiUpdateTime?: string | null; /** * All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. */ - attributes?: string[]; + attributes?: string[] | null; /** * The set of destination URLs for the creative. */ - clickThroughUrls?: string[]; + clickThroughUrls?: string[] | null; /** * Output only. Shows any corrections that were applied to this creative. */ @@ -443,35 +443,35 @@ export namespace adexchangebuyer2_v2beta1 { /** * The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. */ - creativeId?: string; + creativeId?: string | null; /** * Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. */ - dealsStatus?: string; + dealsStatus?: string | null; /** * The set of declared destination URLs for the creative. */ - declaredClickThroughUrls?: string[]; + declaredClickThroughUrls?: string[] | null; /** * Output only. Detected advertiser IDs, if any. */ - detectedAdvertiserIds?: string[]; + detectedAdvertiserIds?: string[] | null; /** * Output only. The detected domains for this creative. */ - detectedDomains?: string[]; + detectedDomains?: string[] | null; /** * Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. */ - detectedLanguages?: string[]; + detectedLanguages?: string[] | null; /** * Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. */ - detectedProductCategories?: number[]; + detectedProductCategories?: number[] | null; /** * Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. */ - detectedSensitiveCategories?: number[]; + detectedSensitiveCategories?: number[] | null; /** * An HTML creative. */ @@ -479,7 +479,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The set of URLs to be called to record an impression. */ - impressionTrackingUrls?: string[]; + impressionTrackingUrls?: string[] | null; /** * A native creative. */ @@ -487,11 +487,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. */ - openAuctionStatus?: string; + openAuctionStatus?: string | null; /** * All restricted categories for the ads that may be shown from this creative. */ - restrictedCategories?: string[]; + restrictedCategories?: string[] | null; /** * Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). */ @@ -499,11 +499,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. */ - vendorIds?: number[]; + vendorIds?: number[] | null; /** * Output only. The version of this creative. */ - version?: number; + version?: number | null; /** * A video creative. */ @@ -516,15 +516,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * The account the creative belongs to. */ - accountId?: string; + accountId?: string | null; /** * The ID of the creative associated with the deal. */ - creativeId?: string; + creativeId?: string | null; /** * The externalDealId for the deal associated with the creative. */ - dealsId?: string; + dealsId?: string | null; } /** * Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. @@ -533,12 +533,12 @@ export namespace adexchangebuyer2_v2beta1 { /** * The format of the environment that the creatives will be displayed in. */ - creativeFormat?: string; + creativeFormat?: string | null; creativeSpecifications?: Schema$CreativeSpecification[]; /** * Skippable video ads allow viewers to skip ads after 5 seconds. */ - skippableAdType?: string; + skippableAdType?: string | null; } /** * Specifies the size of the creative. @@ -547,7 +547,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). */ - allowedFormats?: string[]; + allowedFormats?: string[] | null; /** * For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO */ @@ -555,11 +555,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The creative size type. */ - creativeSizeType?: string; + creativeSizeType?: string | null; /** * Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. */ - nativeTemplate?: string; + nativeTemplate?: string | null; /** * For regular or video creative size type, specifies the size of the creative */ @@ -567,7 +567,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. */ - skippableAdType?: string; + skippableAdType?: string | null; } /** * Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -593,7 +593,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). */ - creativeStatusId?: number; + creativeStatusId?: number | null; /** * The values of all dimensions associated with metric values in this row. */ @@ -606,11 +606,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * A list of numeric IDs to be excluded. */ - excludedCriteriaIds?: string[]; + excludedCriteriaIds?: string[] | null; /** * A list of numeric IDs to be included. */ - targetedCriteriaIds?: string[]; + targetedCriteriaIds?: 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 date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. @@ -619,15 +619,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * 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; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. @@ -636,7 +636,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The day of the week to target. If unspecified, applicable to all days. */ - dayOfWeek?: string; + dayOfWeek?: string | null; /** * The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. */ @@ -657,7 +657,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The timezone to use for interpreting the day part targeting. */ - timeZoneType?: string; + timeZoneType?: string | null; } /** * A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. @@ -666,11 +666,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. */ - availableEndTime?: string; + availableEndTime?: string | null; /** * Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. */ - availableStartTime?: string; + availableStartTime?: string | null; /** * Buyer private data (hidden from seller). */ @@ -678,19 +678,19 @@ export namespace adexchangebuyer2_v2beta1 { /** * The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ - createProductId?: string; + createProductId?: string | null; /** * Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ - createProductRevision?: string; + createProductRevision?: string | null; /** * Output only. The time of the deal creation. */ - createTime?: string; + createTime?: string | null; /** * Output only. Specifies the creative pre-approval policy. */ - creativePreApprovalPolicy?: string; + creativePreApprovalPolicy?: string | null; /** * Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. */ @@ -698,11 +698,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Output only. Specifies whether the creative is safeFrame compatible. */ - creativeSafeFrameCompatibility?: string; + creativeSafeFrameCompatibility?: string | null; /** * Output only. A unique deal ID for the deal (server-assigned). */ - dealId?: string; + dealId?: string | null; /** * Output only. Metadata about the serving status of this deal. */ @@ -718,27 +718,27 @@ export namespace adexchangebuyer2_v2beta1 { /** * Description for the deal terms. */ - description?: string; + description?: string | null; /** * The name of the deal. */ - displayName?: string; + displayName?: string | null; /** * Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. */ - externalDealId?: string; + externalDealId?: string | null; /** * Output only. True, if the buyside inventory setup is complete for this deal. */ - isSetupComplete?: boolean; + isSetupComplete?: boolean | null; /** * Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. */ - programmaticCreativeSource?: string; + programmaticCreativeSource?: string | null; /** * Output only. ID of the proposal that this deal is part of. */ - proposalId?: string; + proposalId?: string | null; /** * Output only. Seller contact information for the deal. */ @@ -746,7 +746,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ - syndicationProduct?: string; + syndicationProduct?: string | null; /** * Output only. Specifies the subset of inventory targeted by the deal. */ @@ -758,11 +758,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Output only. The time when the deal was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * The web property code for the seller copied over from the product. */ - webPropertyCode?: string; + webPropertyCode?: string | null; } /** * Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. @@ -771,23 +771,23 @@ export namespace adexchangebuyer2_v2beta1 { /** * The buyer's reason for pausing, if the buyer paused the deal. */ - buyerPauseReason?: string; + buyerPauseReason?: string | null; /** * The role of the person who first paused this deal. */ - firstPausedBy?: string; + firstPausedBy?: string | null; /** * True, if the buyer has paused the deal unilaterally. */ - hasBuyerPaused?: boolean; + hasBuyerPaused?: boolean | null; /** * True, if the seller has paused the deal unilaterally. */ - hasSellerPaused?: boolean; + hasSellerPaused?: boolean | null; /** * The seller's reason for pausing, if the seller paused the deal. */ - sellerPauseReason?: string; + sellerPauseReason?: string | null; } /** * Message captures metadata about the serving status of a deal. @@ -805,11 +805,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Visibility of the URL in bid requests. (default: BRANDED) */ - brandingType?: string; + brandingType?: string | null; /** * Publisher provided description for the terms. */ - description?: string; + description?: string | null; /** * Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. */ @@ -817,7 +817,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * Non-binding estimate of the impressions served per day. Can be set by buyer or seller. */ - estimatedImpressionsPerDay?: string; + estimatedImpressionsPerDay?: string | null; /** * The terms for guaranteed fixed price deals. */ @@ -833,7 +833,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. */ - sellerTimeZone?: string; + sellerTimeZone?: string | null; } /** * Message contains details about how the deals will be paced. @@ -842,11 +842,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Output only. Specified the creative blocking levels to be applied. */ - creativeBlockingLevel?: string; + creativeBlockingLevel?: string | null; /** * Output only. Specifies how the impression delivery will be paced. */ - deliveryRateType?: string; + deliveryRateType?: string | null; /** * Output only. Specifies any frequency caps. */ @@ -859,11 +859,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Additional details about the reason for disapproval. */ - details?: string[]; + details?: string[] | null; /** * The categorized reason for disapproval. */ - reason?: string; + reason?: 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 `{}`. @@ -880,7 +880,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The ID of the creative. */ - creativeId?: string; + creativeId?: string | null; /** * The values of all dimensions associated with metric values in this row. */ @@ -897,7 +897,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message. */ - detailId?: number; + detailId?: number | null; /** * The values of all dimensions associated with metric values in this row. */ @@ -914,35 +914,35 @@ export namespace adexchangebuyer2_v2beta1 { /** * The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. */ - breakdownDimensions?: string[]; + breakdownDimensions?: string[] | null; /** * The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern. */ - creativeId?: string; + creativeId?: string | null; /** * The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern. */ - dealId?: string; + dealId?: string | null; /** * The environment on which to filter; optional. */ - environment?: string; + environment?: string | null; /** * The list of formats on which to filter; may be empty. The filters represented by multiple formats are ORed together (i.e., if non-empty, results must match any one of the formats). */ - formats?: string[]; + formats?: string[] | null; /** * A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/x/filterSets/x (for accessing bidder-level troubleshooting data) - `bidders/x/accounts/x/filterSets/x (for accessing account-level troubleshooting data) This field is required in create operations. */ - name?: string; + name?: string | null; /** * The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). */ - platforms?: string[]; + platforms?: string[] | null; /** * For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. */ - publisherIdentifiers?: string[]; + publisherIdentifiers?: string[] | null; /** * An open-ended realtime time range, defined by the aggregation start timestamp. */ @@ -954,11 +954,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. */ - sellerNetworkIds?: number[]; + sellerNetworkIds?: number[] | null; /** * The granularity of time intervals if a time series breakdown is desired; optional. */ - timeSeriesGranularity?: string; + timeSeriesGranularity?: string | null; } /** * Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. @@ -967,11 +967,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * A list of application IDs to be excluded. */ - excludedAppIds?: string[]; + excludedAppIds?: string[] | null; /** * A list of application IDs to be included. */ - targetedAppIds?: string[]; + targetedAppIds?: string[] | null; } /** * Frequency cap. @@ -980,15 +980,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * The maximum number of impressions that can be served to a user within the specified time period. */ - maxImpressions?: number; + maxImpressions?: number | null; /** * The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. */ - numTimeUnits?: number; + numTimeUnits?: number | null; /** * The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. */ - timeUnitType?: string; + timeUnitType?: string | null; } /** * Terms for Programmatic Guaranteed Deals. @@ -1001,15 +1001,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. */ - guaranteedImpressions?: string; + guaranteedImpressions?: string | null; /** * Count of guaranteed looks. Required for deal, optional for product. */ - guaranteedLooks?: string; + guaranteedLooks?: string | null; /** * Daily minimum looks for CPD deal types. */ - minimumDailyLooks?: string; + minimumDailyLooks?: string | null; } /** * HTML content for a creative. @@ -1018,15 +1018,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * The height of the HTML snippet in pixels. */ - height?: number; + height?: number | null; /** * The HTML snippet that displays the ad when inserted in the web page. */ - snippet?: string; + snippet?: string | null; /** * The width of the HTML snippet in pixels. */ - width?: number; + width?: number | null; } /** * An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. @@ -1035,15 +1035,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * Image height in pixels. */ - height?: number; + height?: number | null; /** * The URL of the image. */ - url?: string; + url?: string | null; /** * Image width in pixels. */ - width?: number; + width?: number | null; } /** * The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel. @@ -1098,7 +1098,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all reasons that bid responses resulted in an error. @@ -1111,7 +1111,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListBidResponseErrorsRequest.pageToken field in the subsequent call to the bidResponseErrors.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all reasons that bid responses were considered to have no applicable bids. @@ -1124,7 +1124,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to the bidResponsesWithoutBids.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListClientsResponse { /** @@ -1134,7 +1134,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListClientUserInvitationsResponse { /** @@ -1144,13 +1144,13 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListClientUsersResponse { /** * A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The returned list of client users. */ @@ -1167,7 +1167,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all creatives associated with a given filtered bid reason. @@ -1180,7 +1180,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent call to the filteredBids.creatives.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all details associated with a given filtered bid reason. @@ -1189,7 +1189,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The type of detail that the detail IDs represent. */ - detailType?: string; + detailType?: string | null; /** * List of rows, with counts of bids with a given creative status aggregated by detail. */ @@ -1197,7 +1197,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent call to the filteredBids.details.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A response for listing creative and deal associations @@ -1210,7 +1210,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all reasons that bid requests were filtered and not sent to the buyer. @@ -1223,7 +1223,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the filteredBidRequests.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all reasons that bids were filtered from the auction. @@ -1236,7 +1236,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing filter sets. @@ -1249,7 +1249,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing the metrics that are measured in number of impressions. @@ -1262,7 +1262,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListImpressionMetricsRequest.pageToken field in the subsequent call to the impressionMetrics.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all reasons that bids lost in the auction. @@ -1275,7 +1275,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for listing all reasons for which a buyer was not billed for a winning bid. @@ -1284,7 +1284,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of rows, with counts of bids not billed aggregated by reason. */ @@ -1297,7 +1297,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * List pagination support. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of matching products at their head revision number. */ @@ -1310,7 +1310,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of proposals. */ @@ -1323,7 +1323,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * List pagination support */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of matching publisher profiles. */ @@ -1336,7 +1336,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. */ - geoCriteriaIds?: number[]; + geoCriteriaIds?: number[] | null; } /** * Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. @@ -1370,11 +1370,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The expected value of the metric. */ - value?: string; + value?: string | null; /** * The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value */ - variance?: string; + variance?: string | null; } /** * Mobile application targeting settings. @@ -1392,15 +1392,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * The 3-letter currency code defined in ISO 4217. */ - currencyCode?: string; + currencyCode?: string | null; /** * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ - nanos?: number; + nanos?: number | null; /** * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ - units?: string; + units?: string | null; } /** * Native content for a creative. @@ -1409,7 +1409,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The name of the advertiser or sponsor, to be displayed in the ad creative. */ - advertiserName?: string; + advertiserName?: string | null; /** * The app icon, for app download ads. */ @@ -1417,23 +1417,23 @@ export namespace adexchangebuyer2_v2beta1 { /** * A long description of the ad. */ - body?: string; + body?: string | null; /** * A label for the button that the user is supposed to click. */ - callToAction?: string; + callToAction?: string | null; /** * The URL that the browser/SDK will load when the user clicks the ad. */ - clickLinkUrl?: string; + clickLinkUrl?: string | null; /** * The URL to use for click tracking. */ - clickTrackingUrl?: string; + clickTrackingUrl?: string | null; /** * A short title for the ad. */ - headline?: string; + headline?: string | null; /** * A large image. */ @@ -1445,19 +1445,19 @@ export namespace adexchangebuyer2_v2beta1 { /** * The price of the promoted app including currency info. */ - priceDisplayText?: string; + priceDisplayText?: string | null; /** * The app rating in the app store. Must be in the range [0-5]. */ - starRating?: number; + starRating?: number | null; /** * The URL to the app store to purchase/download the promoted app. */ - storeUrl?: string; + storeUrl?: string | null; /** * The URL to fetch a native video ad. */ - videoUrl?: string; + videoUrl?: string | null; } /** * The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status. @@ -1474,7 +1474,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The status specifying why the winning bids were not billed. */ - status?: string; + status?: string | null; } /** * Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. @@ -1483,7 +1483,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * True if open auction buyers are allowed to compete with invited buyers in this private auction. */ - autoOptimizePrivateAuction?: boolean; + autoOptimizePrivateAuction?: boolean | null; /** * Reserve price for the specified buyer. */ @@ -1505,23 +1505,23 @@ export namespace adexchangebuyer2_v2beta1 { /** * Output only. The timestamp for when this note was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The role of the person (buyer/seller) creating the note. */ - creatorRole?: string; + creatorRole?: string | null; /** * The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ - note?: string; + note?: string | null; /** * Output only. The unique ID for the note. */ - noteId?: string; + noteId?: string | null; /** * Output only. The revision number of the proposal when the note is created. */ - proposalRevision?: string; + proposalRevision?: string | null; } /** * Represents targeting information for operating systems. @@ -1543,7 +1543,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.) */ - reason?: string; + reason?: string | null; } /** * Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. @@ -1565,7 +1565,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The platforms this restriction applies to. */ - platforms?: string[]; + platforms?: string[] | null; } /** * Represents a price and a pricing type for a product / deal. @@ -1578,7 +1578,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The pricing type for the deal/product. (default: CPM) */ - pricingType?: string; + pricingType?: string | null; } /** * Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. @@ -1587,7 +1587,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. */ - advertiserIds?: string[]; + advertiserIds?: string[] | null; /** * The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). */ @@ -1604,7 +1604,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). */ - referenceId?: string; + referenceId?: string | null; } /** * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. @@ -1613,15 +1613,15 @@ export namespace adexchangebuyer2_v2beta1 { /** * The proposed end time for the deal. The field will be truncated to the order of seconds during serving. */ - availableEndTime?: string; + availableEndTime?: string | null; /** * Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving. */ - availableStartTime?: string; + availableStartTime?: string | null; /** * Creation time. */ - createTime?: string; + createTime?: string | null; /** * Optional contact information for the creator of this product. */ @@ -1629,23 +1629,23 @@ export namespace adexchangebuyer2_v2beta1 { /** * The display name for this product as set by the seller. */ - displayName?: string; + displayName?: string | null; /** * If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. */ - hasCreatorSignedOff?: boolean; + hasCreatorSignedOff?: boolean | null; /** * The unique ID for the product. */ - productId?: string; + productId?: string | null; /** * The revision number of the product (auto-assigned by Marketplace). */ - productRevision?: string; + productRevision?: string | null; /** * An ID which can be used by the Publisher Profile API to get more information about the seller that created this product. */ - publisherProfileId?: string; + publisherProfileId?: string | null; /** * Information about the seller that created this product. */ @@ -1653,7 +1653,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The syndication product associated with the deal. */ - syndicationProduct?: string; + syndicationProduct?: string | null; /** * Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values. */ @@ -1665,11 +1665,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * Time of last update. */ - updateTime?: string; + updateTime?: string | null; /** * The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal. */ - webPropertyCode?: string; + webPropertyCode?: string | null; } /** * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. @@ -1698,19 +1698,19 @@ export namespace adexchangebuyer2_v2beta1 { /** * The name for the proposal. */ - displayName?: string; + displayName?: string | null; /** * Output only. True if the proposal is being renegotiated. */ - isRenegotiating?: boolean; + isRenegotiating?: boolean | null; /** * Output only. True, if the buyside inventory setup is complete for this proposal. */ - isSetupComplete?: boolean; + isSetupComplete?: boolean | null; /** * Output only. The role of the last user that either updated the proposal or left a comment. */ - lastUpdaterOrCommentorRole?: string; + lastUpdaterOrCommentorRole?: string | null; /** * Output only. The notes associated with this proposal. */ @@ -1718,23 +1718,23 @@ export namespace adexchangebuyer2_v2beta1 { /** * Output only. Indicates whether the buyer/seller created the proposal. */ - originatorRole?: string; + originatorRole?: string | null; /** * Output only. Private auction ID if this proposal is a private auction proposal. */ - privateAuctionId?: string; + privateAuctionId?: string | null; /** * Output only. The unique ID of the proposal. */ - proposalId?: string; + proposalId?: string | null; /** * Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. */ - proposalRevision?: string; + proposalRevision?: string | null; /** * Output only. The current state of the proposal. */ - proposalState?: string; + proposalState?: string | null; /** * Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ @@ -1746,7 +1746,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * Output only. The time when the proposal was last revised. */ - updateTime?: string; + updateTime?: string | null; } /** * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise. @@ -1755,55 +1755,55 @@ export namespace adexchangebuyer2_v2beta1 { /** * Description on the publisher's audience. */ - audienceDescription?: string; + audienceDescription?: string | null; /** * Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher. */ - buyerPitchStatement?: string; + buyerPitchStatement?: string | null; /** * Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. */ - directDealsContact?: string; + directDealsContact?: string | null; /** * Name of the publisher profile. */ - displayName?: string; + displayName?: string | null; /** * The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". */ - domains?: string[]; + domains?: string[] | null; /** * URL to publisher's Google+ page. */ - googlePlusUrl?: string; + googlePlusUrl?: string | null; /** * A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image. */ - logoUrl?: string; + logoUrl?: string | null; /** * URL to additional marketing and sales materials. */ - mediaKitUrl?: string; + mediaKitUrl?: string | null; /** * Overview of the publisher. */ - overview?: string; + overview?: string | null; /** * Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. */ - programmaticDealsContact?: string; + programmaticDealsContact?: string | null; /** * Unique ID for publisher profile. */ - publisherProfileId?: string; + publisherProfileId?: string | null; /** * URL to a publisher rate card. */ - rateCardInfoUrl?: string; + rateCardInfoUrl?: string | null; /** * URL to a sample content page. */ - samplePageUrl?: string; + samplePageUrl?: string | null; /** * Seller of the publisher profile. */ @@ -1811,7 +1811,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * Up to three key metrics and rankings. Max 100 characters each. For example "#1 Mobile News Site for 20 Straight Months". */ - topHeadlines?: string[]; + topHeadlines?: string[] | null; } /** * An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. @@ -1820,7 +1820,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The start timestamp of the real-time RTB metrics aggregation. */ - startTimestamp?: string; + startTimestamp?: string | null; } /** * A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 @@ -1829,11 +1829,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. */ - durationDays?: number; + durationDays?: number | null; /** * The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. */ - offsetDays?: number; + offsetDays?: number | null; } /** * A request for removing the association between a deal and a creative. @@ -1855,7 +1855,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. */ - publisherIdentifier?: string; + publisherIdentifier?: string | null; /** * The time interval that this row represents. */ @@ -1868,7 +1868,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The security types in this context. */ - securities?: string[]; + securities?: string[] | null; } /** * Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. @@ -1877,11 +1877,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. */ - accountId?: string; + accountId?: string | null; /** * Optional sub-account ID for the seller. */ - subAccountId?: string; + subAccountId?: string | null; } /** * The serving context for this restriction. @@ -1890,7 +1890,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * Matches all contexts. */ - all?: string; + all?: string | null; /** * Matches impressions for a particular app type. */ @@ -1931,7 +1931,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). */ - status?: string; + status?: string | null; } /** * Message depicting the size of the creative. The units of width and height depend on the type of the targeting. @@ -1940,11 +1940,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The height of the creative. */ - height?: number; + height?: number | null; /** * The width of the creative */ - width?: number; + width?: number | null; } /** * A request for stopping notifications for changes to creative Status. @@ -1965,7 +1965,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. */ - key?: string; + key?: string | null; } /** * A polymorphic targeting value used as part of Shared Targeting. @@ -1982,11 +1982,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The long value to include/exclude. */ - longValue?: string; + longValue?: string | null; /** * The string value to include/exclude. */ - stringValue?: string; + stringValue?: string | null; } /** * Represents targeting about various types of technology. @@ -2012,11 +2012,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The timestamp marking the end of the range (exclusive) for which data is included. */ - endTime?: string; + endTime?: string | null; /** * The timestamp marking the start of the range (inclusive) for which data is included. */ - startTime?: string; + startTime?: string | null; } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. @@ -2025,19 +2025,19 @@ export namespace adexchangebuyer2_v2beta1 { /** * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ - hours?: number; + hours?: number | null; /** * Minutes of hour of day. Must be from 0 to 59. */ - minutes?: number; + minutes?: number | null; /** * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ - nanos?: number; + nanos?: number | null; /** * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ - seconds?: number; + seconds?: number | null; } /** * Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. @@ -2046,11 +2046,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * A list of URLs to be excluded. */ - excludedUrls?: string[]; + excludedUrls?: string[] | null; /** * A list of URLs to be included. */ - targetedUrls?: string[]; + targetedUrls?: string[] | null; } /** * Video content for a creative. @@ -2059,11 +2059,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * The URL to fetch a video ad. */ - videoUrl?: string; + videoUrl?: string | null; /** * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. */ - videoVastXml?: string; + videoVastXml?: string | null; } /** * Represents targeting information about video. @@ -2072,11 +2072,11 @@ export namespace adexchangebuyer2_v2beta1 { /** * A list of video positions to be excluded. Position types can either be included or excluded (XOR). */ - excludedPositionTypes?: string[]; + excludedPositionTypes?: string[] | null; /** * A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. */ - targetedPositionTypes?: string[]; + targetedPositionTypes?: string[] | null; } /** * A request for watching changes to creative Status. @@ -2085,7 +2085,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format. */ - topic?: string; + topic?: string | null; } export class Resource$Accounts { diff --git a/src/apis/adexperiencereport/v1.ts b/src/apis/adexperiencereport/v1.ts index 867b4af51e6..e300ee5d6ca 100644 --- a/src/apis/adexperiencereport/v1.ts +++ b/src/apis/adexperiencereport/v1.ts @@ -126,31 +126,31 @@ export namespace adexperiencereport_v1 { /** * The site's Ad Experience Report status on this platform. */ - betterAdsStatus?: string; + betterAdsStatus?: string | null; /** * The time at which [enforcement](https://support.google.com/webtools/answer/7308033) against the site began or will begin on this platform. Not set when the filter_status is OFF. */ - enforcementTime?: string; + enforcementTime?: string | null; /** * The site's [enforcement status](https://support.google.com/webtools/answer/7308033) on this platform. */ - filterStatus?: string; + filterStatus?: string | null; /** * The time at which the site's status last changed on this platform. */ - lastChangeTime?: string; + lastChangeTime?: string | null; /** * The site's regions on this platform. No longer populated, because there is no longer any semantic difference between sites in different regions. */ - region?: string[]; + region?: string[] | null; /** * A link to the full Ad Experience Report for the site on this platform.. Not set in ViolatingSitesResponse. Note that you must complete the [Search Console verification process](https://support.google.com/webmasters/answer/9008080) for the site before you can access the full report. */ - reportUrl?: string; + reportUrl?: string | null; /** * Whether the site is currently under review on this platform. */ - underReview?: boolean; + underReview?: boolean | null; } /** * Response message for GetSiteSummary. @@ -167,7 +167,7 @@ export namespace adexperiencereport_v1 { /** * The name of the reviewed site, e.g. `google.com`. */ - reviewedSite?: string; + reviewedSite?: string | null; } /** * Response message for ListViolatingSites. diff --git a/src/apis/admin/datatransfer_v1.ts b/src/apis/admin/datatransfer_v1.ts index 482f15aedae..c79cf87f719 100644 --- a/src/apis/admin/datatransfer_v1.ts +++ b/src/apis/admin/datatransfer_v1.ts @@ -110,19 +110,19 @@ export namespace admin_datatransfer_v1 { /** * Etag of the resource. */ - etag?: string; + etag?: string | null; /** * The application's ID. */ - id?: string; + id?: string | null; /** * Identifies the resource as a DataTransfer Application Resource. */ - kind?: string; + kind?: string | null; /** * The application's name. */ - name?: string; + name?: string | null; /** * The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered. */ @@ -135,7 +135,7 @@ export namespace admin_datatransfer_v1 { /** * The application's ID. */ - applicationId?: string; + applicationId?: string | null; /** * The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application. */ @@ -143,7 +143,7 @@ export namespace admin_datatransfer_v1 { /** * Current status of transfer for this application. (Read-only) */ - applicationTransferStatus?: string; + applicationTransferStatus?: string | null; } /** * Template for a collection of Applications. @@ -156,15 +156,15 @@ export namespace admin_datatransfer_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Identifies the resource as a collection of Applications. */ - kind?: string; + kind?: string | null; /** * Continuation token which will be used to specify next page in list API. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Template for application transfer parameters. @@ -173,11 +173,11 @@ export namespace admin_datatransfer_v1 { /** * The type of the transfer parameter. eg: 'PRIVACY_LEVEL' */ - key?: string; + key?: string | null; /** * The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED' */ - value?: string[]; + value?: string[] | null; } /** * The JSON template for a DataTransfer resource. @@ -190,31 +190,31 @@ export namespace admin_datatransfer_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The transfer's ID (Read-only). */ - id?: string; + id?: string | null; /** * Identifies the resource as a DataTransfer request. */ - kind?: string; + kind?: string | null; /** * ID of the user to whom the data is being transfered. */ - newOwnerUserId?: string; + newOwnerUserId?: string | null; /** * ID of the user whose data is being transfered. */ - oldOwnerUserId?: string; + oldOwnerUserId?: string | null; /** * Overall transfer status (Read-only). */ - overallTransferStatusCode?: string; + overallTransferStatusCode?: string | null; /** * The time at which the data transfer was requested (Read-only). */ - requestTime?: string; + requestTime?: string | null; } /** * Template for a collection of DataTransfer resources. @@ -227,15 +227,15 @@ export namespace admin_datatransfer_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Identifies the resource as a collection of data transfer requests. */ - kind?: string; + kind?: string | null; /** * Continuation token which will be used to specify next page in list API. */ - nextPageToken?: string; + nextPageToken?: string | null; } export class Resource$Applications { diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 1b332af023f..9457c1c8a66 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -148,23 +148,23 @@ export namespace admin_directory_v1 { /** * A alias email */ - alias?: string; + alias?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Unique id of the group (Read-only) Unique id of the user (Read-only) */ - id?: string; + id?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Group's primary email (Read-only) User's primary email (Read-only) */ - primaryEmail?: string; + primaryEmail?: string | null; } /** * JSON response template to list aliases in Directory API. @@ -173,15 +173,15 @@ export namespace admin_directory_v1 { /** * List of alias objects. */ - aliases?: any[]; + aliases?: any[] | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; } /** * JSON template for App Access Collections Resource object in Directory API. @@ -190,35 +190,35 @@ export namespace admin_directory_v1 { /** * List of blocked api access buckets. */ - blockedApiAccessBuckets?: string[]; + blockedApiAccessBuckets?: string[] | null; /** * Boolean to indicate whether to enforce app access settings on Android Drive or not. */ - enforceSettingsForAndroidDrive?: boolean; + enforceSettingsForAndroidDrive?: boolean | null; /** * Error message provided by the Admin that will be shown to the user when an app is blocked. */ - errorMessage?: string; + errorMessage?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Identifies the resource as an app access collection. Value: admin#directory#appaccesscollection */ - kind?: string; + kind?: string | null; /** * Unique ID of app access collection. (Readonly) */ - resourceId?: string; + resourceId?: string | null; /** * Resource name given by the customer while creating/updating. Should be unique under given customer. */ - resourceName?: string; + resourceName?: string | null; /** * Boolean that indicates whether to trust domain owned apps. */ - trustDomainOwnedApps?: boolean; + trustDomainOwnedApps?: boolean | null; } /** * The template that returns individual ASP (Access Code) data. @@ -227,37 +227,37 @@ export namespace admin_directory_v1 { /** * The unique ID of the ASP. */ - codeId?: number; + codeId?: number | null; /** * The time when the ASP was created. Expressed in Unix time format. */ - creationTime?: string; + creationTime?: string | null; /** * ETag of the ASP. */ - etag?: string; + etag?: string | null; /** * The type of the API resource. This is always admin#directory#asp. */ - kind?: string; + kind?: string | null; /** * The time when the ASP was last used. Expressed in Unix time format. */ - lastTimeUsed?: string; + lastTimeUsed?: string | null; /** * The name of the application that the user, represented by their userId, entered when the ASP was created. */ - name?: string; + name?: string | null; /** * The unique ID of the user who issued the ASP. */ - userKey?: string; + userKey?: string | null; } export interface Schema$Asps { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * A list of ASP resources. */ @@ -265,7 +265,7 @@ export namespace admin_directory_v1 { /** * The type of the API resource. This is always admin#directory#aspList. */ - kind?: string; + kind?: string | null; } /** * JSON template for Building object in Directory API. @@ -278,11 +278,11 @@ export namespace admin_directory_v1 { /** * Unique identifier for the building. The maximum length is 100 characters. */ - buildingId?: string; + buildingId?: string | null; /** * The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters. */ - buildingName?: string; + buildingName?: string | null; /** * The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. */ @@ -290,19 +290,19 @@ export namespace admin_directory_v1 { /** * A brief description of the building. For example, "Chelsea Market". */ - description?: string; + description?: string | null; /** * ETag of the resource. */ - etags?: string; + etags?: string | null; /** * The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry. */ - floorNames?: string[]; + floorNames?: string[] | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; } /** * JSON template for the postal address of a building in Directory API. @@ -311,31 +311,31 @@ export namespace admin_directory_v1 { /** * Unstructured address lines describing the lower levels of an address. */ - addressLines?: string[]; + addressLines?: string[] | null; /** * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. */ - administrativeArea?: string; + administrativeArea?: string | null; /** * Optional. BCP-47 language code of the contents of this address (if known). */ - languageCode?: string; + languageCode?: string | null; /** * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines. */ - locality?: string; + locality?: string | null; /** * Optional. Postal code of the address. */ - postalCode?: string; + postalCode?: string | null; /** * Required. CLDR region code of the country/region of the address. */ - regionCode?: string; + regionCode?: string | null; /** * Optional. Sublocality of the address. */ - sublocality?: string; + sublocality?: string | null; } /** * JSON template for coordinates of a building in Directory API. @@ -344,11 +344,11 @@ export namespace admin_directory_v1 { /** * Latitude in decimal degrees. */ - latitude?: number; + latitude?: number | null; /** * Longitude in decimal degrees. */ - longitude?: number; + longitude?: number | null; } /** * JSON template for Building List Response object in Directory API. @@ -361,15 +361,15 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * JSON template for Calendar Resource object in Directory API. @@ -378,60 +378,60 @@ export namespace admin_directory_v1 { /** * Unique ID for the building a resource is located in. */ - buildingId?: string; + buildingId?: string | null; /** * Capacity of a resource, number of seats in a room. */ - capacity?: number; + capacity?: number | null; /** * ETag of the resource. */ - etags?: string; - featureInstances?: any; + etags?: string | null; + featureInstances?: any | null; /** * Name of the floor a resource is located on. */ - floorName?: string; + floorName?: string | null; /** * Name of the section within a floor a resource is located in. */ - floorSection?: string; + floorSection?: string | null; /** * The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, "NYC-2-Training Room 1A (16)". */ - generatedResourceName?: string; + generatedResourceName?: string | null; /** * The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource. */ - kind?: string; + kind?: string | null; /** * The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. */ - resourceCategory?: string; + resourceCategory?: string | null; /** * Description of the resource, visible only to admins. */ - resourceDescription?: string; + resourceDescription?: string | null; /** * The read-only email for the calendar resource. Generated as part of creating a new calendar resource. */ - resourceEmail?: string; + resourceEmail?: string | null; /** * The unique ID for the calendar resource. */ - resourceId?: string; + resourceId?: string | null; /** * The name of the calendar resource. For example, "Training Room 1A". */ - resourceName?: string; + resourceName?: string | null; /** * The type of the calendar resource, intended for non-room resources. */ - resourceType?: string; + resourceType?: string | null; /** * Description of the resource, visible to users and admins. */ - userVisibleDescription?: string; + userVisibleDescription?: string | null; } /** * JSON template for Calendar Resource List Response object in Directory API. @@ -440,7 +440,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The CalendarResources in this page of results. */ @@ -448,11 +448,11 @@ export namespace admin_directory_v1 { /** * Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An notification channel used to watch for resource changes. @@ -461,43 +461,43 @@ export namespace admin_directory_v1 { /** * The address where notifications are delivered for this channel. */ - address?: string; + address?: string | null; /** * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ - expiration?: string; + expiration?: string | null; /** * A UUID or similar unique string that identifies this channel. */ - id?: string; + id?: string | null; /** * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ - kind?: string; + kind?: string | null; /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: {[key: string]: string}; + params?: {[key: string]: string} | null; /** * A Boolean value to indicate whether payload is wanted. Optional. */ - payload?: boolean; + payload?: boolean | null; /** * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ - resourceId?: string; + resourceId?: string | null; /** * A version-specific identifier for the watched resource. */ - resourceUri?: string; + resourceUri?: string | null; /** * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ - token?: string; + token?: string | null; /** * The type of delivery mechanism used for this channel. */ - type?: string; + type?: string | null; } /** * JSON template for Chrome Os Device resource in Directory API. @@ -506,27 +506,27 @@ export namespace admin_directory_v1 { /** * List of active time ranges (Read-only) */ - activeTimeRanges?: Array<{activeTime?: number; date?: string}>; + activeTimeRanges?: Array<{activeTime?: number; date?: string}> | null; /** * AssetId specified during enrollment or through later annotation */ - annotatedAssetId?: string; + annotatedAssetId?: string | null; /** * Address or location of the device as noted by the administrator */ - annotatedLocation?: string; + annotatedLocation?: string | null; /** * User of the device */ - annotatedUser?: string; + annotatedUser?: string | null; /** * (Read-only) The timestamp after which the device will stop receiving Chrome updates or support */ - autoUpdateExpiration?: string; + autoUpdateExpiration?: string | null; /** * Chromebook boot mode (Read-only) */ - bootMode?: string; + bootMode?: string | null; /** * Reports of CPU utilization and temperature (Read-only) */ @@ -534,7 +534,7 @@ export namespace admin_directory_v1 { cpuTemperatureInfo?: Array<{label?: string; temperature?: number}>; cpuUtilizationPercentageInfo?: number[]; reportTime?: string; - }>; + }> | null; /** * List of device files to download (Read-only) */ @@ -543,11 +543,11 @@ export namespace admin_directory_v1 { downloadUrl?: string; name?: string; type?: string; - }>; + }> | null; /** * Unique identifier of Chrome OS Device (Read-only) */ - deviceId?: string; + deviceId?: string | null; /** * Reports of disk space and other info about mounted/connected volumes. */ @@ -557,102 +557,102 @@ export namespace admin_directory_v1 { storageTotal?: string; volumeId?: string; }>; - }>; + }> | null; /** * (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. */ - dockMacAddress?: string; + dockMacAddress?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Chromebook Mac Address on ethernet network interface (Read-only) */ - ethernetMacAddress?: string; + ethernetMacAddress?: string | null; /** * (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. */ - ethernetMacAddress0?: string; + ethernetMacAddress0?: string | null; /** * Chromebook firmware version (Read-only) */ - firmwareVersion?: string; + firmwareVersion?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Date and time the device was last enrolled (Read-only) */ - lastEnrollmentTime?: string; + lastEnrollmentTime?: string | null; /** * Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) */ - lastSync?: string; + lastSync?: string | null; /** * Chromebook Mac Address on wifi network interface (Read-only) */ - macAddress?: string; + macAddress?: string | null; /** * (Read-only) The date the device was manufactured in yyyy-mm-dd format. */ - manufactureDate?: string; + manufactureDate?: string | null; /** * Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only) */ - meid?: string; + meid?: string | null; /** * Chromebook Model (Read-only) */ - model?: string; + model?: string | null; /** * Notes added by the administrator */ - notes?: string; + notes?: string | null; /** * Chromebook order number (Read-only) */ - orderNumber?: string; + orderNumber?: string | null; /** * OrgUnit of the device */ - orgUnitPath?: string; + orgUnitPath?: string | null; /** * Chromebook Os Version (Read-only) */ - osVersion?: string; + osVersion?: string | null; /** * Chromebook platform version (Read-only) */ - platformVersion?: string; + platformVersion?: string | null; /** * List of recent device users, in descending order by last login time (Read-only) */ - recentUsers?: Array<{email?: string; type?: string}>; + recentUsers?: Array<{email?: string; type?: string}> | null; /** * Chromebook serial number (Read-only) */ - serialNumber?: string; + serialNumber?: string | null; /** * status of the device (Read-only) */ - status?: string; + status?: string | null; /** * Final date the device will be supported (Read-only) */ - supportEndDate?: string; + supportEndDate?: string | null; /** * Reports of amounts of available RAM memory (Read-only) */ systemRamFreeReports?: Array<{ reportTime?: string; systemRamFreeInfo?: string[]; - }>; + }> | null; /** * Total RAM on the device [in bytes] (Read-only) */ - systemRamTotal?: string; + systemRamTotal?: string | null; /** * Trusted Platform Module (TPM) (Read-only) */ @@ -663,11 +663,11 @@ export namespace admin_directory_v1 { specLevel?: string; tpmModel?: string; vendorSpecific?: string; - }; + } | null; /** * Will Chromebook auto renew after support end date (Read-only) */ - willAutoRenew?: boolean; + willAutoRenew?: boolean | null; } /** * JSON request template for firing actions on ChromeOs Device in Directory Devices API. @@ -676,8 +676,8 @@ export namespace admin_directory_v1 { /** * Action to be taken on the ChromeOs Device */ - action?: string; - deprovisionReason?: string; + action?: string | null; + deprovisionReason?: string | null; } /** * JSON response template for List Chrome OS Devices operation in Directory API. @@ -690,15 +690,15 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Token used to access next page of this result. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * JSON request template for moving ChromeOs Device to given OU in Directory Devices API. @@ -707,7 +707,7 @@ export namespace admin_directory_v1 { /** * ChromeOs Devices to be moved to OU */ - deviceIds?: string[]; + deviceIds?: string[] | null; } /** * JSON template for Customer Resource object in Directory API. @@ -716,35 +716,35 @@ export namespace admin_directory_v1 { /** * The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain */ - alternateEmail?: string; + alternateEmail?: string | null; /** * The customer's creation time (Readonly) */ - customerCreationTime?: string; + customerCreationTime?: string | null; /** * The customer's primary domain name string. Do not include the www prefix when creating a new customer. */ - customerDomain?: string; + customerDomain?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The unique ID for the customer's G Suite account. (Readonly) */ - id?: string; + id?: string | null; /** * Identifies the resource as a customer. Value: admin#directory#customer */ - kind?: string; + kind?: string | null; /** * The customer's ISO 639-2 language code. The default value is en-US */ - language?: string; + language?: string | null; /** * The customer's contact phone number in E.164 format. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * The customer's postal address information. */ @@ -757,39 +757,39 @@ export namespace admin_directory_v1 { /** * A customer's physical address. The address can be composed of one to three lines. */ - addressLine1?: string; + addressLine1?: string | null; /** * Address line 2 of the address. */ - addressLine2?: string; + addressLine2?: string | null; /** * Address line 3 of the address. */ - addressLine3?: string; + addressLine3?: string | null; /** * The customer contact's name. */ - contactName?: string; + contactName?: string | null; /** * This is a required property. For countryCode information see the ISO 3166 country code elements. */ - countryCode?: string; + countryCode?: string | null; /** * Name of the locality. An example of a locality value is the city of San Francisco. */ - locality?: string; + locality?: string | null; /** * The company or company division name. */ - organizationName?: string; + organizationName?: string | null; /** * The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element. */ - postalCode?: string; + postalCode?: string | null; /** * Name of the region. An example of a region value is NY for the state of New York. */ - region?: string; + region?: string | null; } /** * JSON template for Domain Alias object in Directory API. @@ -798,27 +798,27 @@ export namespace admin_directory_v1 { /** * The creation time of the domain alias. (Read-only). */ - creationTime?: string; + creationTime?: string | null; /** * The domain alias name. */ - domainAliasName?: string; + domainAliasName?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer. */ - parentDomainName?: string; + parentDomainName?: string | null; /** * Indicates the verification state of a domain alias. (Read-only) */ - verified?: boolean; + verified?: boolean | null; } /** * JSON response template to list domain aliases in Directory API. @@ -831,11 +831,11 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; } /** * JSON template for Domain object in Directory API. @@ -844,7 +844,7 @@ export namespace admin_directory_v1 { /** * Creation time of the domain. (Read-only). */ - creationTime?: string; + creationTime?: string | null; /** * List of domain alias objects. (Read-only) */ @@ -852,23 +852,23 @@ export namespace admin_directory_v1 { /** * The domain name of the customer. */ - domainName?: string; + domainName?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Indicates if the domain is a primary domain (Read-only). */ - isPrimary?: boolean; + isPrimary?: boolean | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Indicates the verification state of a domain. (Read-only). */ - verified?: boolean; + verified?: boolean | null; } /** * JSON response template to list Domains in Directory API. @@ -881,11 +881,11 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; } /** * JSON template for Feature object in Directory API. @@ -894,15 +894,15 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etags?: string; + etags?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * The name of the feature. */ - name?: string; + name?: string | null; } /** * JSON template for a "feature instance". @@ -920,7 +920,7 @@ export namespace admin_directory_v1 { /** * New name of the feature. */ - newName?: string; + newName?: string | null; } /** * JSON template for Feature List Response object in Directory API. @@ -929,7 +929,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The Features in this page of results. */ @@ -937,11 +937,11 @@ export namespace admin_directory_v1 { /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * JSON template for Group resource in Directory API. @@ -950,43 +950,43 @@ export namespace admin_directory_v1 { /** * Is the group created by admin (Read-only) * */ - adminCreated?: boolean; + adminCreated?: boolean | null; /** * List of aliases (Read-only) */ - aliases?: string[]; + aliases?: string[] | null; /** * Description of the group */ - description?: string; + description?: string | null; /** * Group direct members count */ - directMembersCount?: string; + directMembersCount?: string | null; /** * Email of Group */ - email?: string; + email?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Unique identifier of Group (Read-only) */ - id?: string; + id?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Group name */ - name?: string; + name?: string | null; /** * List of non editable aliases (Read-only) */ - nonEditableAliases?: string[]; + nonEditableAliases?: string[] | null; } /** * JSON response template for List Groups operation in Directory API. @@ -995,7 +995,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * List of group objects. */ @@ -1003,11 +1003,11 @@ export namespace admin_directory_v1 { /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Token used to access next page of this result. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * JSON template for Member resource in Directory API. @@ -1016,35 +1016,35 @@ export namespace admin_directory_v1 { /** * Delivery settings of member */ - delivery_settings?: string; + delivery_settings?: string | null; /** * Email of member (Read-only) */ - email?: string; + email?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The unique ID of the group member. A member id can be used as a member request URI's memberKey. Unique identifier of group (Read-only) Unique identifier of member (Read-only) */ - id?: string; + id?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Role of member */ - role?: string; + role?: string | null; /** * Status of member (Immutable) */ - status?: string; + status?: string | null; /** * Type of member (Immutable) */ - type?: string; + type?: string | null; } /** * JSON response template for List Members operation in Directory API. @@ -1053,11 +1053,11 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * List of member objects. */ @@ -1065,7 +1065,7 @@ export namespace admin_directory_v1 { /** * Token used to access next page of this result. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * JSON template for Has Member response in Directory API. @@ -1074,7 +1074,7 @@ export namespace admin_directory_v1 { /** * Identifies whether the given user is a member of the group. Membership can be direct or nested. */ - isMember?: boolean; + isMember?: boolean | null; } /** * JSON template for Mobile Device resource in Directory API. @@ -1083,7 +1083,7 @@ export namespace admin_directory_v1 { /** * Adb (USB debugging) enabled or disabled on device (Read-only) */ - adbStatus?: boolean; + adbStatus?: boolean | null; /** * List of applications installed on Mobile Device */ @@ -1093,159 +1093,159 @@ export namespace admin_directory_v1 { permission?: string[]; versionCode?: number; versionName?: string; - }>; + }> | null; /** * Mobile Device Baseband version (Read-only) */ - basebandVersion?: string; + basebandVersion?: string | null; /** * Mobile Device Bootloader version (Read-only) */ - bootloaderVersion?: string; + bootloaderVersion?: string | null; /** * Mobile Device Brand (Read-only) */ - brand?: string; + brand?: string | null; /** * Mobile Device Build number (Read-only) */ - buildNumber?: string; + buildNumber?: string | null; /** * The default locale used on the Mobile Device (Read-only) */ - defaultLanguage?: string; + defaultLanguage?: string | null; /** * Developer options enabled or disabled on device (Read-only) */ - developerOptionsStatus?: boolean; + developerOptionsStatus?: boolean | null; /** * Mobile Device compromised status (Read-only) */ - deviceCompromisedStatus?: string; + deviceCompromisedStatus?: string | null; /** * Mobile Device serial number (Read-only) */ - deviceId?: string; + deviceId?: string | null; /** * DevicePasswordStatus (Read-only) */ - devicePasswordStatus?: string; + devicePasswordStatus?: string | null; /** * List of owner user's email addresses (Read-only) */ - email?: string[]; + email?: string[] | null; /** * Mobile Device Encryption Status (Read-only) */ - encryptionStatus?: string; + encryptionStatus?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only) */ - firstSync?: string; + firstSync?: string | null; /** * Mobile Device Hardware (Read-only) */ - hardware?: string; + hardware?: string | null; /** * Mobile Device Hardware Id (Read-only) */ - hardwareId?: string; + hardwareId?: string | null; /** * Mobile Device IMEI number (Read-only) */ - imei?: string; + imei?: string | null; /** * Mobile Device Kernel version (Read-only) */ - kernelVersion?: string; + kernelVersion?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) */ - lastSync?: string; + lastSync?: string | null; /** * Boolean indicating if this account is on owner/primary profile or not (Read-only) */ - managedAccountIsOnOwnerProfile?: boolean; + managedAccountIsOnOwnerProfile?: boolean | null; /** * Mobile Device manufacturer (Read-only) */ - manufacturer?: string; + manufacturer?: string | null; /** * Mobile Device MEID number (Read-only) */ - meid?: string; + meid?: string | null; /** * Name of the model of the device */ - model?: string; + model?: string | null; /** * List of owner user's names (Read-only) */ - name?: string[]; + name?: string[] | null; /** * Mobile Device mobile or network operator (if available) (Read-only) */ - networkOperator?: string; + networkOperator?: string | null; /** * Name of the mobile operating system */ - os?: string; + os?: string | null; /** * List of accounts added on device (Read-only) */ - otherAccountsInfo?: string[]; + otherAccountsInfo?: string[] | null; /** * DMAgentPermission (Read-only) */ - privilege?: string; + privilege?: string | null; /** * Mobile Device release version version (Read-only) */ - releaseVersion?: string; + releaseVersion?: string | null; /** * Unique identifier of Mobile Device (Read-only) */ - resourceId?: string; + resourceId?: string | null; /** * Mobile Device Security patch level (Read-only) */ - securityPatchLevel?: string; + securityPatchLevel?: string | null; /** * Mobile Device SSN or Serial Number (Read-only) */ - serialNumber?: string; + serialNumber?: string | null; /** * Status of the device (Read-only) */ - status?: string; + status?: string | null; /** * Work profile supported on device (Read-only) */ - supportsWorkProfile?: boolean; + supportsWorkProfile?: boolean | null; /** * The type of device (Read-only) */ - type?: string; + type?: string | null; /** * Unknown sources enabled or disabled on device (Read-only) */ - unknownSourcesStatus?: boolean; + unknownSourcesStatus?: boolean | null; /** * Mobile Device user agent */ - userAgent?: string; + userAgent?: string | null; /** * Mobile Device WiFi MAC address (Read-only) */ - wifiMacAddress?: string; + wifiMacAddress?: string | null; } /** * JSON request template for firing commands on Mobile Device in Directory Devices API. @@ -1254,7 +1254,7 @@ export namespace admin_directory_v1 { /** * Action to be taken on the Mobile Device */ - action?: string; + action?: string | null; } /** * JSON response template for List Mobile Devices operation in Directory API. @@ -1263,11 +1263,11 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * List of Mobile Device objects. */ @@ -1275,7 +1275,7 @@ export namespace admin_directory_v1 { /** * Token used to access next page of this result. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Template for a notification resource. @@ -1284,32 +1284,32 @@ export namespace admin_directory_v1 { /** * Body of the notification (Read-only) */ - body?: string; + body?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Address from which the notification is received (Read-only) */ - fromAddress?: string; + fromAddress?: string | null; /** * Boolean indicating whether the notification is unread or not. */ - isUnread?: boolean; + isUnread?: boolean | null; /** * The type of the resource. */ - kind?: string; - notificationId?: string; + kind?: string | null; + notificationId?: string | null; /** * Time at which notification was sent (Read-only) */ - sendTime?: string; + sendTime?: string | null; /** * Subject of the notification (Read-only) */ - subject?: string; + subject?: string | null; } /** * Template for notifications list response. @@ -1318,7 +1318,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * List of notifications in this page. */ @@ -1326,15 +1326,15 @@ export namespace admin_directory_v1 { /** * The type of the resource. */ - kind?: string; + kind?: string | null; /** * Token for fetching the next page of notifications. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Number of unread notification for the domain. */ - unreadNotificationsCount?: number; + unreadNotificationsCount?: number | null; } /** * JSON template for Org Unit resource in Directory API. @@ -1343,39 +1343,39 @@ export namespace admin_directory_v1 { /** * Should block inheritance */ - blockInheritance?: boolean; + blockInheritance?: boolean | null; /** * Description of OrgUnit */ - description?: string; + description?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Name of OrgUnit */ - name?: string; + name?: string | null; /** * Id of OrgUnit */ - orgUnitId?: string; + orgUnitId?: string | null; /** * Path of OrgUnit */ - orgUnitPath?: string; + orgUnitPath?: string | null; /** * Id of parent OrgUnit */ - parentOrgUnitId?: string; + parentOrgUnitId?: string | null; /** * Path of parent OrgUnit */ - parentOrgUnitPath?: string; + parentOrgUnitPath?: string | null; } /** * JSON response template for List Organization Units operation in Directory API. @@ -1384,11 +1384,11 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * List of user objects. */ @@ -1405,27 +1405,27 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * If the privilege can be restricted to an organization unit. */ - isOuScopable?: boolean; + isOuScopable?: boolean | null; /** * The type of the API resource. This is always admin#directory#privilege. */ - kind?: string; + kind?: string | null; /** * The name of the privilege. */ - privilegeName?: string; + privilegeName?: string | null; /** * The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list(). */ - serviceId?: string; + serviceId?: string | null; /** * The name of the service this privilege is for. */ - serviceName?: string; + serviceName?: string | null; } /** * JSON response template for List privileges operation in Directory API. @@ -1434,7 +1434,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * A list of Privilege resources. */ @@ -1442,7 +1442,7 @@ export namespace admin_directory_v1 { /** * The type of the API resource. This is always admin#directory#privileges. */ - kind?: string; + kind?: string | null; } /** * JSON template for role resource in Directory API. @@ -1451,35 +1451,35 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Returns true if the role is a super admin role. */ - isSuperAdminRole?: boolean; + isSuperAdminRole?: boolean | null; /** * Returns true if this is a pre-defined system role. */ - isSystemRole?: boolean; + isSystemRole?: boolean | null; /** * The type of the API resource. This is always admin#directory#role. */ - kind?: string; + kind?: string | null; /** * A short description of the role. */ - roleDescription?: string; + roleDescription?: string | null; /** * ID of the role. */ - roleId?: string; + roleId?: string | null; /** * Name of the role. */ - roleName?: string; + roleName?: string | null; /** * The set of privileges that are granted to this role. */ - rolePrivileges?: Array<{privilegeName?: string; serviceId?: string}>; + rolePrivileges?: Array<{privilegeName?: string; serviceId?: string}> | null; } /** * JSON template for roleAssignment resource in Directory API. @@ -1488,31 +1488,31 @@ export namespace admin_directory_v1 { /** * The unique ID of the user this role is assigned to. */ - assignedTo?: string; + assignedTo?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The type of the API resource. This is always admin#directory#roleAssignment. */ - kind?: string; + kind?: string | null; /** * If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. */ - orgUnitId?: string; + orgUnitId?: string | null; /** * ID of this roleAssignment. */ - roleAssignmentId?: string; + roleAssignmentId?: string | null; /** * The ID of the role that is assigned. */ - roleId?: string; + roleId?: string | null; /** * The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT */ - scopeType?: string; + scopeType?: string | null; } /** * JSON response template for List roleAssignments operation in Directory API. @@ -1521,7 +1521,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * A list of RoleAssignment resources. */ @@ -1529,8 +1529,8 @@ export namespace admin_directory_v1 { /** * The type of the API resource. This is always admin#directory#roleAssignments. */ - kind?: string; - nextPageToken?: string; + kind?: string | null; + nextPageToken?: string | null; } /** * JSON response template for List roles operation in Directory API. @@ -1539,7 +1539,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * A list of Role resources. */ @@ -1547,8 +1547,8 @@ export namespace admin_directory_v1 { /** * The type of the API resource. This is always admin#directory#roles. */ - kind?: string; - nextPageToken?: string; + kind?: string | null; + nextPageToken?: string | null; } /** * JSON template for Schema resource in Directory API. @@ -1557,11 +1557,11 @@ export namespace admin_directory_v1 { /** * Display name for the schema. */ - displayName?: string; + displayName?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Fields of Schema */ @@ -1569,15 +1569,15 @@ export namespace admin_directory_v1 { /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Unique identifier of Schema (Read-only) */ - schemaId?: string; + schemaId?: string | null; /** * Schema name */ - schemaName?: string; + schemaName?: string | null; } /** * JSON template for FieldSpec resource for Schemas in Directory API. @@ -1586,43 +1586,43 @@ export namespace admin_directory_v1 { /** * Display Name of the field. */ - displayName?: string; + displayName?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Unique identifier of Field (Read-only) */ - fieldId?: string; + fieldId?: string | null; /** * Name of the field. */ - fieldName?: string; + fieldName?: string | null; /** * Type of the field. */ - fieldType?: string; + fieldType?: string | null; /** * Boolean specifying whether the field is indexed or not. */ - indexed?: boolean; + indexed?: boolean | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Boolean specifying whether this is a multi-valued field or not. */ - multiValued?: boolean; + multiValued?: boolean | null; /** * Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. */ - numericIndexingSpec?: {maxValue?: number; minValue?: number}; + numericIndexingSpec?: {maxValue?: number; minValue?: number} | null; /** * Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". */ - readAccessType?: string; + readAccessType?: string | null; } /** * JSON response template for List Schema operation in Directory API. @@ -1631,11 +1631,11 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * List of UserSchema objects. */ @@ -1648,35 +1648,35 @@ export namespace admin_directory_v1 { /** * Whether the application is registered with Google. The value is true if the application has an anonymous Client ID. */ - anonymous?: boolean; + anonymous?: boolean | null; /** * The Client ID of the application the token is issued to. */ - clientId?: string; + clientId?: string | null; /** * The displayable name of the application the token is issued to. */ - displayText?: string; + displayText?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The type of the API resource. This is always admin#directory#token. */ - kind?: string; + kind?: string | null; /** * Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device. */ - nativeApp?: boolean; + nativeApp?: boolean | null; /** * A list of authorization scopes the application is granted. */ - scopes?: string[]; + scopes?: string[] | null; /** * The unique ID of the user that issued the token. */ - userKey?: string; + userKey?: string | null; } /** * JSON response template for List tokens operation in Directory API. @@ -1685,7 +1685,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * A list of Token resources. */ @@ -1693,7 +1693,7 @@ export namespace admin_directory_v1 { /** * The type of the API resource. This is always admin#directory#tokenList. */ - kind?: string; + kind?: string | null; } /** * JSON template for Trusted App Ids Resource object in Directory API. @@ -1702,20 +1702,20 @@ export namespace admin_directory_v1 { /** * Android package name. */ - androidPackageName?: string; + androidPackageName?: string | null; /** * SHA1 signature of the app certificate. */ - certificateHashSHA1?: string; + certificateHashSHA1?: string | null; /** * SHA256 signature of the app certificate. */ - certificateHashSHA256?: string; - etag?: string; + certificateHashSHA256?: string | null; + etag?: string | null; /** * Identifies the resource as a trusted AppId. */ - kind?: string; + kind?: string | null; } /** * JSON template for Trusted Apps response object of a user in Directory API. @@ -1724,12 +1724,12 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Identifies the resource as trusted apps response. */ - kind?: string; - nextPageToken?: string; + kind?: string | null; + nextPageToken?: string | null; /** * Trusted Apps list. */ @@ -1739,91 +1739,91 @@ export namespace admin_directory_v1 { * JSON template for User object in Directory API. */ export interface Schema$User { - addresses?: any; + addresses?: any | null; /** * Indicates if user has agreed to terms (Read-only) */ - agreedToTerms?: boolean; + agreedToTerms?: boolean | null; /** * List of aliases (Read-only) */ - aliases?: string[]; + aliases?: string[] | null; /** * Indicates if user is archived. */ - archived?: boolean; + archived?: boolean | null; /** * Boolean indicating if the user should change password in next login */ - changePasswordAtNextLogin?: boolean; + changePasswordAtNextLogin?: boolean | null; /** * User's G Suite account creation time. (Read-only) */ - creationTime?: string; + creationTime?: string | null; /** * CustomerId of User (Read-only) */ - customerId?: string; + customerId?: string | null; /** * Custom fields of the user. */ - customSchemas?: {[key: string]: Schema$UserCustomProperties}; - deletionTime?: string; - emails?: any; + customSchemas?: {[key: string]: Schema$UserCustomProperties} | null; + deletionTime?: string | null; + emails?: any | null; /** * ETag of the resource. */ - etag?: string; - externalIds?: any; - gender?: any; + etag?: string | null; + externalIds?: any | null; + gender?: any | null; /** * Hash function name for password. Supported are MD5, SHA-1 and crypt */ - hashFunction?: string; + hashFunction?: string | null; /** * Unique identifier of User (Read-only) */ - id?: string; - ims?: any; + id?: string | null; + ims?: any | null; /** * Boolean indicating if user is included in Global Address List */ - includeInGlobalAddressList?: boolean; + includeInGlobalAddressList?: boolean | null; /** * Boolean indicating if ip is whitelisted */ - ipWhitelisted?: boolean; + ipWhitelisted?: boolean | null; /** * Boolean indicating if the user is admin (Read-only) */ - isAdmin?: boolean; + isAdmin?: boolean | null; /** * Boolean indicating if the user is delegated admin (Read-only) */ - isDelegatedAdmin?: boolean; + isDelegatedAdmin?: boolean | null; /** * Is 2-step verification enforced (Read-only) */ - isEnforcedIn2Sv?: boolean; + isEnforcedIn2Sv?: boolean | null; /** * Is enrolled in 2-step verification (Read-only) */ - isEnrolledIn2Sv?: boolean; + isEnrolledIn2Sv?: boolean | null; /** * Is mailbox setup (Read-only) */ - isMailboxSetup?: boolean; - keywords?: any; + isMailboxSetup?: boolean | null; + keywords?: any | null; /** * Kind of resource this is. */ - kind?: string; - languages?: any; + kind?: string | null; + languages?: any | null; /** * User's last login time. (Read-only) */ - lastLoginTime?: string; - locations?: any; + lastLoginTime?: string | null; + locations?: any | null; /** * User's name */ @@ -1831,50 +1831,50 @@ export namespace admin_directory_v1 { /** * List of non editable aliases (Read-only) */ - nonEditableAliases?: string[]; - notes?: any; - organizations?: any; + nonEditableAliases?: string[] | null; + notes?: any | null; + organizations?: any | null; /** * OrgUnit of User */ - orgUnitPath?: string; + orgUnitPath?: string | null; /** * User's password */ - password?: string; - phones?: any; - posixAccounts?: any; + password?: string | null; + phones?: any | null; + posixAccounts?: any | null; /** * username of User */ - primaryEmail?: string; + primaryEmail?: string | null; /** * Recovery email of the user. */ - recoveryEmail?: string; + recoveryEmail?: string | null; /** * Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212. */ - recoveryPhone?: string; - relations?: any; - sshPublicKeys?: any; + recoveryPhone?: string | null; + relations?: any | null; + sshPublicKeys?: any | null; /** * Indicates if user is suspended. */ - suspended?: boolean; + suspended?: boolean | null; /** * Suspension reason if user is suspended (Read-only) */ - suspensionReason?: string; + suspensionReason?: string | null; /** * ETag of the user's photo (Read-only) */ - thumbnailPhotoEtag?: string; + thumbnailPhotoEtag?: string | null; /** * Photo Url of the user (Read-only) */ - thumbnailPhotoUrl?: string; - websites?: any; + thumbnailPhotoUrl?: string | null; + websites?: any | null; } /** * JSON template for About (notes) of a user in Directory API. @@ -1883,11 +1883,11 @@ export namespace admin_directory_v1 { /** * About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text. */ - contentType?: string; + contentType?: string | null; /** * Actual value of notes. */ - value?: string; + value?: string | null; } /** * JSON template for address. @@ -1896,55 +1896,55 @@ export namespace admin_directory_v1 { /** * Country. */ - country?: string; + country?: string | null; /** * Country code. */ - countryCode?: string; + countryCode?: string | null; /** * Custom type. */ - customType?: string; + customType?: string | null; /** * Extended Address. */ - extendedAddress?: string; + extendedAddress?: string | null; /** * Formatted address. */ - formatted?: string; + formatted?: string | null; /** * Locality. */ - locality?: string; + locality?: string | null; /** * Other parts of address. */ - poBox?: string; + poBox?: string | null; /** * Postal code. */ - postalCode?: string; + postalCode?: string | null; /** * If this is user's primary address. Only one entry could be marked as primary. */ - primary?: boolean; + primary?: boolean | null; /** * Region. */ - region?: string; + region?: string | null; /** * User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses, but any values will eventually be clobbered. */ - sourceIsStructured?: boolean; + sourceIsStructured?: boolean | null; /** * Street. */ - streetAddress?: string; + streetAddress?: string | null; /** * Each entry can have a type which indicates standard values of that entry. For example address could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value. */ - type?: string; + type?: string | null; } /** * JSON template for a set of custom properties (i.e. all fields in a particular schema) @@ -1957,19 +1957,19 @@ export namespace admin_directory_v1 { /** * Email id of the user. */ - address?: string; + address?: string | null; /** * Custom Type. */ - customType?: string; + customType?: string | null; /** * If this is user's primary email. Only one entry could be marked as primary. */ - primary?: boolean; + primary?: boolean | null; /** * Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value. */ - type?: string; + type?: string | null; } /** * JSON template for an externalId entry. @@ -1978,29 +1978,29 @@ export namespace admin_directory_v1 { /** * Custom type. */ - customType?: string; + customType?: string | null; /** * The type of the Id. */ - type?: string; + type?: string | null; /** * The value of the id. */ - value?: string; + value?: string | null; } export interface Schema$UserGender { /** * AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans, for example "he/him/his" or "they/them/their". */ - addressMeAs?: string; + addressMeAs?: string | null; /** * Custom gender. */ - customGender?: string; + customGender?: string | null; /** * Gender. */ - type?: string; + type?: string | null; } /** * JSON template for instant messenger of an user. @@ -2009,27 +2009,27 @@ export namespace admin_directory_v1 { /** * Custom protocol. */ - customProtocol?: string; + customProtocol?: string | null; /** * Custom type. */ - customType?: string; + customType?: string | null; /** * Instant messenger id. */ - im?: string; + im?: string | null; /** * If this is user's primary im. Only one entry could be marked as primary. */ - primary?: boolean; + primary?: boolean | null; /** * Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and specify the custom name in customProtocol field. */ - protocol?: string; + protocol?: string | null; /** * Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value. */ - type?: string; + type?: string | null; } /** * JSON template for a keyword entry. @@ -2038,15 +2038,15 @@ export namespace admin_directory_v1 { /** * Custom Type. */ - customType?: string; + customType?: string | null; /** * Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. */ - type?: string; + type?: string | null; /** * Keyword. */ - value?: string; + value?: string | null; } /** * JSON template for a language entry. @@ -2055,11 +2055,11 @@ export namespace admin_directory_v1 { /** * Other language. User can provide own language name if there is no corresponding Google III language code. If this is set LanguageCode can't be set */ - customLanguage?: string; + customLanguage?: string | null; /** * Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException. */ - languageCode?: string; + languageCode?: string | null; } /** * JSON template for a location entry. @@ -2068,31 +2068,31 @@ export namespace admin_directory_v1 { /** * Textual location. This is most useful for display purposes to concisely describe the location. For example, "Mountain View, CA", "Near Seattle", "US-NYC-9TH 9A209A". */ - area?: string; + area?: string | null; /** * Building Identifier. */ - buildingId?: string; + buildingId?: string | null; /** * Custom Type. */ - customType?: string; + customType?: string | null; /** * Most specific textual code of individual desk location. */ - deskCode?: string; + deskCode?: string | null; /** * Floor name/number. */ - floorName?: string; + floorName?: string | null; /** * Floor section. More specific location within the floor. For example, if a floor is divided into sections "A", "B", and "C", this field would identify one of those values. */ - floorSection?: string; + floorSection?: string | null; /** * Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type, an entry can have a custom type and can give it any name. Such types should have "custom" as type and also have a customType value. */ - type?: string; + type?: string | null; } /** * JSON request template for setting/revoking admin status of a user in Directory API. @@ -2101,7 +2101,7 @@ export namespace admin_directory_v1 { /** * Boolean indicating new admin status of the user */ - status?: boolean; + status?: boolean | null; } /** * JSON template for name of a user in Directory API. @@ -2110,15 +2110,15 @@ export namespace admin_directory_v1 { /** * Last Name */ - familyName?: string; + familyName?: string | null; /** * Full Name */ - fullName?: string; + fullName?: string | null; /** * First Name */ - givenName?: string; + givenName?: string | null; } /** * JSON template for an organization entry. @@ -2127,51 +2127,51 @@ export namespace admin_directory_v1 { /** * The cost center of the users department. */ - costCenter?: string; + costCenter?: string | null; /** * Custom type. */ - customType?: string; + customType?: string | null; /** * Department within the organization. */ - department?: string; + department?: string | null; /** * Description of the organization. */ - description?: string; + description?: string | null; /** * The domain to which the organization belongs to. */ - domain?: string; + domain?: string | null; /** * The full-time equivalent millipercent within the organization (100000 = 100%). */ - fullTimeEquivalent?: number; + fullTimeEquivalent?: number | null; /** * Location of the organization. This need not be fully qualified address. */ - location?: string; + location?: string | null; /** * Name of the organization */ - name?: string; + name?: string | null; /** * If it user's primary organization. */ - primary?: boolean; + primary?: boolean | null; /** * Symbol of the organization. */ - symbol?: string; + symbol?: string | null; /** * Title (designation) of the user in the organization. */ - title?: string; + title?: string | null; /** * Each entry can have a type which indicates standard types of that entry. For example organization could be of school, work etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value. */ - type?: string; + type?: string | null; } /** * JSON template for a phone entry. @@ -2180,19 +2180,19 @@ export namespace admin_directory_v1 { /** * Custom Type. */ - customType?: string; + customType?: string | null; /** * If this is user's primary phone or not. */ - primary?: boolean; + primary?: boolean | null; /** * Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax, work, mobile etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. */ - type?: string; + type?: string | null; /** * Phone number. */ - value?: string; + value?: string | null; } /** * JSON template for Photo object in Directory API. @@ -2201,35 +2201,35 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Height in pixels of the photo */ - height?: number; + height?: number | null; /** * Unique identifier of User (Read-only) */ - id?: string; + id?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Mime Type of the photo */ - mimeType?: string; + mimeType?: string | null; /** * Base64 encoded photo data */ - photoData?: string; + photoData?: string | null; /** * Primary email of User (Read-only) */ - primaryEmail?: string; + primaryEmail?: string | null; /** * Width in pixels of the photo */ - width?: number; + width?: number | null; } /** * JSON template for a POSIX account entry. Description of the field family: go/fbs-posix. @@ -2238,43 +2238,43 @@ export namespace admin_directory_v1 { /** * A POSIX account field identifier. */ - accountId?: string; + accountId?: string | null; /** * The GECOS (user information) for this account. */ - gecos?: string; + gecos?: string | null; /** * The default group ID. */ - gid?: string; + gid?: string | null; /** * The path to the home directory for this account. */ - homeDirectory?: string; + homeDirectory?: string | null; /** * The operating system type for this account. */ - operatingSystemType?: string; + operatingSystemType?: string | null; /** * If this is user's primary account within the SystemId. */ - primary?: boolean; + primary?: boolean | null; /** * The path to the login shell for this account. */ - shell?: string; + shell?: string | null; /** * System identifier for which account Username or Uid apply to. */ - systemId?: string; + systemId?: string | null; /** * The POSIX compliant user ID. */ - uid?: string; + uid?: string | null; /** * The username of the account. */ - username?: string; + username?: string | null; } /** * JSON template for a relation entry. @@ -2283,15 +2283,15 @@ export namespace admin_directory_v1 { /** * Custom Type. */ - customType?: string; + customType?: string | null; /** * The relation of the user. Some of the possible values are mother, father, sister, brother, manager, assistant, partner. */ - type?: string; + type?: string | null; /** * The name of the relation. */ - value?: string; + value?: string | null; } /** * JSON response template for List Users operation in Apps Directory API. @@ -2300,19 +2300,19 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Token used to access next page of this result. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Event that triggered this response (only used in case of Push Response) */ - trigger_event?: string; + trigger_event?: string | null; /** * List of user objects. */ @@ -2325,15 +2325,15 @@ export namespace admin_directory_v1 { /** * An expiration time in microseconds since epoch. */ - expirationTimeUsec?: string; + expirationTimeUsec?: string | null; /** * A SHA-256 fingerprint of the SSH public key. (Read-only) */ - fingerprint?: string; + fingerprint?: string | null; /** * An SSH public key. */ - key?: string; + key?: string | null; } /** * JSON request template to undelete a user in Directory API. @@ -2342,7 +2342,7 @@ export namespace admin_directory_v1 { /** * OrgUnit of User */ - orgUnitPath?: string; + orgUnitPath?: string | null; } /** * JSON template for a website entry. @@ -2351,19 +2351,19 @@ export namespace admin_directory_v1 { /** * Custom Type. */ - customType?: string; + customType?: string | null; /** * If this is user's primary website or not. */ - primary?: boolean; + primary?: boolean | null; /** * Each entry can have a type which indicates standard types of that entry. For example website could be of home, work, blog etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. */ - type?: string; + type?: string | null; /** * Website. */ - value?: string; + value?: string | null; } /** * JSON template for verification codes in Directory API. @@ -2372,19 +2372,19 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The type of the resource. This is always admin#directory#verificationCode. */ - kind?: string; + kind?: string | null; /** * The obfuscated unique ID of the user. */ - userId?: string; + userId?: string | null; /** * A current verification code for the user. Invalidated or used verification codes are not returned as part of the result. */ - verificationCode?: string; + verificationCode?: string | null; } /** * JSON response template for List verification codes operation in Directory API. @@ -2393,7 +2393,7 @@ export namespace admin_directory_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * A list of verification code resources. */ @@ -2401,7 +2401,7 @@ export namespace admin_directory_v1 { /** * The type of the resource. This is always admin#directory#verificationCodesList. */ - kind?: string; + kind?: string | null; } export class Resource$Asps { diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index 04d803a496e..b5b6a58f19f 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -118,7 +118,7 @@ export namespace admin_reports_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Each record in read response. */ @@ -126,11 +126,11 @@ export namespace admin_reports_v1 { /** * Kind of list response this is. */ - kind?: string; + kind?: string | null; /** * Token for retrieving the next page */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * JSON template for the activity resource. @@ -144,11 +144,11 @@ export namespace admin_reports_v1 { email?: string; key?: string; profileId?: string; - }; + } | null; /** * ETag of the entry. */ - etag?: string; + etag?: string | null; /** * Activity events. */ @@ -165,7 +165,7 @@ export namespace admin_reports_v1 { value?: string; }>; type?: string; - }>; + }> | null; /** * Unique identifier for each activity record. */ @@ -174,19 +174,19 @@ export namespace admin_reports_v1 { customerId?: string; time?: string; uniqueQualifier?: string; - }; + } | null; /** * IP Address of the user doing the action. */ - ipAddress?: string; + ipAddress?: string | null; /** * Kind of resource this is. */ - kind?: string; + kind?: string | null; /** * Domain of source customer. */ - ownerDomain?: string; + ownerDomain?: string | null; } /** * An notification channel used to watch for resource changes. @@ -195,43 +195,43 @@ export namespace admin_reports_v1 { /** * The address where notifications are delivered for this channel. */ - address?: string; + address?: string | null; /** * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ - expiration?: string; + expiration?: string | null; /** * A UUID or similar unique string that identifies this channel. */ - id?: string; + id?: string | null; /** * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ - kind?: string; + kind?: string | null; /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: {[key: string]: string}; + params?: {[key: string]: string} | null; /** * A Boolean value to indicate whether payload is wanted. Optional. */ - payload?: boolean; + payload?: boolean | null; /** * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ - resourceId?: string; + resourceId?: string | null; /** * A version-specific identifier for the watched resource. */ - resourceUri?: string; + resourceUri?: string | null; /** * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ - token?: string; + token?: string | null; /** * The type of delivery mechanism used for this channel. */ - type?: string; + type?: string | null; } /** * JSON template for a parameter used in various reports. @@ -240,31 +240,31 @@ export namespace admin_reports_v1 { /** * Boolean value of the parameter. */ - boolValue?: boolean; + boolValue?: boolean | null; /** * Integral value of the parameter. */ - intValue?: string; + intValue?: string | null; /** * Multiple boolean values of the parameter. */ - multiBoolValue?: boolean[]; + multiBoolValue?: boolean[] | null; /** * Multiple integral values of the parameter. */ - multiIntValue?: string[]; + multiIntValue?: string[] | null; /** * Multiple string values of the parameter. */ - multiValue?: string[]; + multiValue?: string[] | null; /** * The name of the parameter. */ - name?: string; + name?: string | null; /** * String value of the parameter. */ - value?: string; + value?: string | null; } /** * JSON template for a usage report. @@ -273,7 +273,7 @@ export namespace admin_reports_v1 { /** * The date to which the record belongs. */ - date?: string; + date?: string | null; /** * Information about the type of the item. */ @@ -283,15 +283,15 @@ export namespace admin_reports_v1 { profileId?: string; type?: string; userEmail?: string; - }; + } | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The kind of object. */ - kind?: string; + kind?: string | null; /** * Parameter value pairs for various applications. */ @@ -302,7 +302,7 @@ export namespace admin_reports_v1 { msgValue?: Array<{[key: string]: any}>; name?: string; stringValue?: string; - }>; + }> | null; } /** * JSON template for a collection of usage reports. @@ -311,15 +311,15 @@ export namespace admin_reports_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The kind of object. */ - kind?: string; + kind?: string | null; /** * Token for retrieving the next page */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Various application parameter records. */ @@ -331,7 +331,7 @@ export namespace admin_reports_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } export class Resource$Activities { diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts index a3a0a7a2101..e50b74c0acb 100644 --- a/src/apis/adsense/v1.4.ts +++ b/src/apis/adsense/v1.4.ts @@ -120,23 +120,23 @@ export namespace adsense_v1_4 { } export interface Schema$Account { - creation_time?: string; + creation_time?: string | null; /** * Unique identifier of this account. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#account. */ - kind?: string; + kind?: string | null; /** * Name of this account. */ - name?: string; + name?: string | null; /** * Whether this account is premium. */ - premium?: boolean; + premium?: boolean | null; /** * Sub accounts of the this account. */ @@ -144,13 +144,13 @@ export namespace adsense_v1_4 { /** * AdSense timezone of this account. */ - timezone?: string; + timezone?: string | null; } export interface Schema$Accounts { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The accounts returned in this list response. */ @@ -158,39 +158,39 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#accounts. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$AdClient { /** * Whether this ad client is opted in to ARC. */ - arcOptIn?: boolean; + arcOptIn?: boolean | null; /** * Unique identifier of this ad client. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#adClient. */ - kind?: string; + kind?: string | null; /** * This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. */ - productCode?: string; + productCode?: string | null; /** * Whether this ad client supports being reported on. */ - supportsReporting?: boolean; + supportsReporting?: boolean | null; } export interface Schema$AdClients { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ad clients returned in this list response. */ @@ -198,67 +198,67 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#adClients. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$AdCode { /** * The Auto ad code snippet. The ad code snippet. */ - adCode?: string; + adCode?: string | null; /** * The AMP Auto ad code snippet that goes in the body of an AMP page. */ - ampBody?: string; + ampBody?: string | null; /** * The AMP Auto ad code snippet that goes in the head of an AMP page. */ - ampHead?: string; + ampHead?: string | null; /** * Kind this is, in this case adsense#adCode. */ - kind?: string; + kind?: string | null; } export interface Schema$AdsenseReportsGenerateResponse { /** * The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ - averages?: string[]; + averages?: string[] | null; /** * The requested end date in yyyy-mm-dd format. */ - endDate?: string; + endDate?: string | null; /** * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. */ - headers?: Array<{currency?: string; name?: string; type?: string}>; + headers?: Array<{currency?: string; name?: string; type?: string}> | null; /** * Kind this is, in this case adsense#report. */ - kind?: string; + kind?: string | null; /** * The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers. */ - rows?: string[][]; + rows?: string[][] | null; /** * The requested start date in yyyy-mm-dd format. */ - startDate?: string; + startDate?: string | null; /** * The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit. */ - totalMatchedRows?: string; + totalMatchedRows?: string | null; /** * The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ - totals?: string[]; + totals?: string[] | null; /** * Any warnings associated with generation of the report. */ - warnings?: string[]; + warnings?: string[] | null; } export interface Schema$AdStyle { /** @@ -270,25 +270,25 @@ export namespace adsense_v1_4 { text?: string; title?: string; url?: string; - }; + } | null; /** * The style of the corners in the ad (deprecated: never populated, ignored). */ - corners?: string; + corners?: string | null; /** * The font which is included in the style. */ - font?: {family?: string; size?: string}; + font?: {family?: string; size?: string} | null; /** * Kind this is, in this case adsense#adStyle. */ - kind?: string; + kind?: string | null; } export interface Schema$AdUnit { /** * Identity code of this ad unit, not necessarily unique across ad clients. */ - code?: string; + code?: string | null; /** * Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). */ @@ -296,7 +296,7 @@ export namespace adsense_v1_4 { backupOption?: {color?: string; type?: string; url?: string}; size?: string; type?: string; - }; + } | null; /** * Custom style information specific to this ad unit. */ @@ -309,15 +309,15 @@ export namespace adsense_v1_4 { frequency?: number; minimumWordCount?: number; type?: string; - }; + } | null; /** * Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#adUnit. */ - kind?: string; + kind?: string | null; /** * Settings specific to WAP mobile content ads (AFMC) - deprecated. */ @@ -326,25 +326,25 @@ export namespace adsense_v1_4 { scriptingLanguage?: string; size?: string; type?: string; - }; + } | null; /** * Name of this ad unit. */ - name?: string; + name?: string | null; /** * ID of the saved ad style which holds this ad unit's style information. */ - savedStyleId?: string; + savedStyleId?: string | null; /** * Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days. */ - status?: string; + status?: string | null; } export interface Schema$AdUnits { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ad units returned in this list response. */ @@ -352,37 +352,37 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#adUnits. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$Alert { /** * Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Whether this alert can be dismissed. */ - isDismissible?: boolean; + isDismissible?: boolean | null; /** * Kind of resource this is, in this case adsense#alert. */ - kind?: string; + kind?: string | null; /** * The localized alert message. */ - message?: string; + message?: string | null; /** * Severity of this alert. Possible values: INFO, WARNING, SEVERE. */ - severity?: string; + severity?: string | null; /** * Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD. */ - type?: string; + type?: string | null; } export interface Schema$Alerts { /** @@ -392,25 +392,25 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#alerts. */ - kind?: string; + kind?: string | null; } export interface Schema$CustomChannel { /** * Code of this custom channel, not necessarily unique across ad clients. */ - code?: string; + code?: string | null; /** * Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#customChannel. */ - kind?: string; + kind?: string | null; /** * Name of this custom channel. */ - name?: string; + name?: string | null; /** * The targeting information of this custom channel, if activated. */ @@ -419,13 +419,13 @@ export namespace adsense_v1_4 { description?: string; location?: string; siteLanguage?: string; - }; + } | null; } export interface Schema$CustomChannels { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The custom channels returned in this list response. */ @@ -433,40 +433,40 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#customChannels. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$Metadata { items?: Schema$ReportingMetadataEntry[]; /** * Kind of list this is, in this case adsense#metadata. */ - kind?: string; + kind?: string | null; } export interface Schema$Payment { /** * Unique identifier of this Payment. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#payment. */ - kind?: string; + kind?: string | null; /** * The amount to be paid. */ - paymentAmount?: string; + paymentAmount?: string | null; /** * The currency code for the amount to be paid. */ - paymentAmountCurrencyCode?: string; + paymentAmountCurrencyCode?: string | null; /** * The date this payment was/will be credited to the user, or none if the payment threshold has not been met. */ - paymentDate?: string; + paymentDate?: string | null; } export interface Schema$Payments { /** @@ -476,37 +476,37 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#payments. */ - kind?: string; + kind?: string | null; } export interface Schema$ReportingMetadataEntry { /** * For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to. */ - compatibleDimensions?: string[]; + compatibleDimensions?: string[] | null; /** * The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with. */ - compatibleMetrics?: string[]; + compatibleMetrics?: string[] | null; /** * Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#reportingMetadataEntry. */ - kind?: string; + kind?: string | null; /** * The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. */ - requiredDimensions?: string[]; + requiredDimensions?: string[] | null; /** * The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. */ - requiredMetrics?: string[]; + requiredMetrics?: string[] | null; /** * The codes of the projects supported by the dimension or metric this reporting metadata entry describes. */ - supportedProducts?: string[]; + supportedProducts?: string[] | null; } export interface Schema$SavedAdStyle { /** @@ -516,21 +516,21 @@ export namespace adsense_v1_4 { /** * Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#savedAdStyle. */ - kind?: string; + kind?: string | null; /** * The user selected name of this SavedAdStyle. */ - name?: string; + name?: string | null; } export interface Schema$SavedAdStyles { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The saved ad styles returned in this list response. */ @@ -538,31 +538,31 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#savedAdStyles. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$SavedReport { /** * Unique identifier of this saved report. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#savedReport. */ - kind?: string; + kind?: string | null; /** * This saved report's name. */ - name?: string; + name?: string | null; } export interface Schema$SavedReports { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The saved reports returned in this list response. */ @@ -570,31 +570,31 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#savedReports. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$UrlChannel { /** * Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsense#urlChannel. */ - kind?: string; + kind?: string | null; /** * URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home */ - urlPattern?: string; + urlPattern?: string | null; } export interface Schema$UrlChannels { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The URL channels returned in this list response. */ @@ -602,11 +602,11 @@ export namespace adsense_v1_4 { /** * Kind of list this is, in this case adsense#urlChannels. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export class Resource$Accounts { diff --git a/src/apis/adsensehost/v4.1.ts b/src/apis/adsensehost/v4.1.ts index 50f1976db9e..b36e3a66fae 100644 --- a/src/apis/adsensehost/v4.1.ts +++ b/src/apis/adsensehost/v4.1.ts @@ -115,25 +115,25 @@ export namespace adsensehost_v4_1 { /** * Unique identifier of this account. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsensehost#account. */ - kind?: string; + kind?: string | null; /** * Name of this account. */ - name?: string; + name?: string | null; /** * Approval status of this account. One of: PENDING, APPROVED, DISABLED. */ - status?: string; + status?: string | null; } export interface Schema$Accounts { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The accounts returned in this list response. */ @@ -141,35 +141,35 @@ export namespace adsensehost_v4_1 { /** * Kind of list this is, in this case adsensehost#accounts. */ - kind?: string; + kind?: string | null; } export interface Schema$AdClient { /** * Whether this ad client is opted in to ARC. */ - arcOptIn?: boolean; + arcOptIn?: boolean | null; /** * Unique identifier of this ad client. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsensehost#adClient. */ - kind?: string; + kind?: string | null; /** * This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. */ - productCode?: string; + productCode?: string | null; /** * Whether this ad client supports being reported on. */ - supportsReporting?: boolean; + supportsReporting?: boolean | null; } export interface Schema$AdClients { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ad clients returned in this list response. */ @@ -177,21 +177,21 @@ export namespace adsensehost_v4_1 { /** * Kind of list this is, in this case adsensehost#adClients. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$AdCode { /** * The ad code snippet. */ - adCode?: string; + adCode?: string | null; /** * Kind this is, in this case adsensehost#adCode. */ - kind?: string; + kind?: string | null; } export interface Schema$AdStyle { /** @@ -203,25 +203,25 @@ export namespace adsensehost_v4_1 { text?: string; title?: string; url?: string; - }; + } | null; /** * The style of the corners in the ad (deprecated: never populated, ignored). */ - corners?: string; + corners?: string | null; /** * The font which is included in the style. */ - font?: {family?: string; size?: string}; + font?: {family?: string; size?: string} | null; /** * Kind this is, in this case adsensehost#adStyle. */ - kind?: string; + kind?: string | null; } export interface Schema$AdUnit { /** * Identity code of this ad unit, not necessarily unique across ad clients. */ - code?: string; + code?: string | null; /** * Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). */ @@ -229,7 +229,7 @@ export namespace adsensehost_v4_1 { backupOption?: {color?: string; type?: string; url?: string}; size?: string; type?: string; - }; + } | null; /** * Custom style information specific to this ad unit. */ @@ -237,11 +237,11 @@ export namespace adsensehost_v4_1 { /** * Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsensehost#adUnit. */ - kind?: string; + kind?: string | null; /** * Settings specific to WAP mobile content ads (AFMC - deprecated). */ @@ -250,21 +250,21 @@ export namespace adsensehost_v4_1 { scriptingLanguage?: string; size?: string; type?: string; - }; + } | null; /** * Name of this ad unit. */ - name?: string; + name?: string | null; /** * Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days. */ - status?: string; + status?: string | null; } export interface Schema$AdUnits { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ad units returned in this list response. */ @@ -272,73 +272,73 @@ export namespace adsensehost_v4_1 { /** * Kind of list this is, in this case adsensehost#adUnits. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$AssociationSession { /** * Hosted account id of the associated publisher after association. Present if status is ACCEPTED. */ - accountId?: string; + accountId?: string | null; /** * Unique identifier of this association session. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsensehost#associationSession. */ - kind?: string; + kind?: string | null; /** * The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated) */ - productCodes?: string[]; + productCodes?: string[] | null; /** * Redirect URL of this association session. Used to redirect users into the AdSense association flow. */ - redirectUrl?: string; + redirectUrl?: string | null; /** * Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR. */ - status?: string; + status?: string | null; /** * The preferred locale of the user themselves when going through the AdSense association flow. */ - userLocale?: string; + userLocale?: string | null; /** * The locale of the user's hosted website. */ - websiteLocale?: string; + websiteLocale?: string | null; /** * The URL of the user's hosted website. */ - websiteUrl?: string; + websiteUrl?: string | null; } export interface Schema$CustomChannel { /** * Code of this custom channel, not necessarily unique across ad clients. */ - code?: string; + code?: string | null; /** * Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsensehost#customChannel. */ - kind?: string; + kind?: string | null; /** * Name of this custom channel. */ - name?: string; + name?: string | null; } export interface Schema$CustomChannels { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The custom channels returned in this list response. */ @@ -346,61 +346,61 @@ export namespace adsensehost_v4_1 { /** * Kind of list this is, in this case adsensehost#customChannels. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$Report { /** * The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ - averages?: string[]; + averages?: string[] | null; /** * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. */ - headers?: Array<{currency?: string; name?: string; type?: string}>; + headers?: Array<{currency?: string; name?: string; type?: string}> | null; /** * Kind this is, in this case adsensehost#report. */ - kind?: string; + kind?: string | null; /** * The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers. */ - rows?: string[][]; + rows?: string[][] | null; /** * The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit. */ - totalMatchedRows?: string; + totalMatchedRows?: string | null; /** * The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ - totals?: string[]; + totals?: string[] | null; /** * Any warnings associated with generation of the report. */ - warnings?: string[]; + warnings?: string[] | null; } export interface Schema$UrlChannel { /** * Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ - id?: string; + id?: string | null; /** * Kind of resource this is, in this case adsensehost#urlChannel. */ - kind?: string; + kind?: string | null; /** * URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home */ - urlPattern?: string; + urlPattern?: string | null; } export interface Schema$UrlChannels { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The URL channels returned in this list response. */ @@ -408,11 +408,11 @@ export namespace adsensehost_v4_1 { /** * Kind of list this is, in this case adsensehost#urlChannels. */ - kind?: string; + kind?: string | null; /** * Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ - nextPageToken?: string; + nextPageToken?: string | null; } export class Resource$Accounts { diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index b68e744696c..caec48f80d9 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -126,7 +126,7 @@ export namespace alertcenter_v1beta1 { /** * Required. The email of the user that this event belongs to. */ - email?: string; + email?: string | null; /** * Optional. Details of the login action associated with the warning event. This is only available for: * Suspicious login * Suspicious login (less secure app) * Suspicious programmatic login * User suspended (suspicious activity) */ @@ -139,51 +139,51 @@ export namespace alertcenter_v1beta1 { /** * List of action names associated with the rule threshold. */ - actionNames?: string[]; + actionNames?: string[] | null; /** * Rule create timestamp. */ - createTime?: string; + createTime?: string | null; /** * Description of the rule. */ - description?: string; + description?: string | null; /** * Alert display name. */ - displayName?: string; + displayName?: string | null; /** * Rule name. */ - name?: string; + name?: string | null; /** * Query that is used to get the data from the associated source. */ - query?: string; + query?: string | null; /** * List of alert ids superseded by this alert. It is used to indicate that this alert is essentially extension of superseded alerts and we found the relationship after creating these alerts. */ - supersededAlerts?: string[]; + supersededAlerts?: string[] | null; /** * Alert id superseding this alert. It is used to indicate that superseding alert is essentially extension of this alert and we found the relationship after creating both alerts. */ - supersedingAlert?: string; + supersedingAlert?: string | null; /** * Alert threshold is for example “COUNT > 5”. */ - threshold?: string; + threshold?: string | null; /** * The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * USER_EVENTS */ - triggerSource?: string; + triggerSource?: string | null; /** * The timestamp of the last update to the rule. */ - updateTime?: string; + updateTime?: string | null; /** * Rule window size. Possible values are 1 hour or 24 hours. */ - windowSize?: string; + windowSize?: string | null; } /** * An alert affecting a customer. @@ -192,31 +192,31 @@ export namespace alertcenter_v1beta1 { /** * Output only. The unique identifier for the alert. */ - alertId?: string; + alertId?: string | null; /** * Output only. The time this alert was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The unique identifier of the Google account of the customer. */ - customerId?: string; + customerId?: string | null; /** * Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised. */ - data?: {[key: string]: any}; + data?: {[key: string]: any} | null; /** * Output only. `True` if this alert is marked for deletion. */ - deleted?: boolean; + deleted?: boolean | null; /** * Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert. */ - endTime?: string; + endTime?: string | null; /** * Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly. */ - etag?: string; + etag?: string | null; /** * Output only. The metadata associated with this alert. */ @@ -224,23 +224,23 @@ export namespace alertcenter_v1beta1 { /** * Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert. */ - securityInvestigationToolLink?: string; + securityInvestigationToolLink?: string | null; /** * Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity */ - source?: string; + source?: string | null; /** * Required. The time the event that caused this alert was started or detected. */ - startTime?: string; + startTime?: string | null; /** * Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). */ - type?: string; + type?: string | null; /** * Output only. The time this alert was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * A customer feedback about an alert. @@ -249,27 +249,27 @@ export namespace alertcenter_v1beta1 { /** * Output only. The alert identifier. */ - alertId?: string; + alertId?: string | null; /** * Output only. The time this feedback was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The unique identifier of the Google account of the customer. */ - customerId?: string; + customerId?: string | null; /** * Output only. The email of the user that provided the feedback. */ - email?: string; + email?: string | null; /** * Output only. The unique identifier for the feedback. */ - feedbackId?: string; + feedbackId?: string | null; /** * Required. The type of the feedback. */ - type?: string; + type?: string | null; } /** * An alert metadata. @@ -278,31 +278,40 @@ export namespace alertcenter_v1beta1 { /** * Output only. The alert identifier. */ - alertId?: string; + alertId?: string | null; /** * The email address of the user assigned to the alert. */ - assignee?: string; + assignee?: string | null; /** * Output only. The unique identifier of the Google account of the customer. */ - customerId?: string; + customerId?: string | null; /** * Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly. */ - etag?: string; + etag?: string | null; /** * The severity value of the alert. Alert Center will set this field at alert creation time, default's to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW */ - severity?: string; + severity?: string | null; /** * The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED */ - status?: string; + status?: string | null; /** * Output only. The time this metadata was last updated. */ - updateTime?: string; + updateTime?: string | null; + } + /** + * Alerts from App Maker to notify admins to set up default SQL instance. + */ + export interface Schema$AppMakerSqlSetupNotification { + /** + * List of applications with requests for default SQL set up. + */ + requestInfo?: Schema$RequestInfo[]; } /** * Attachment with application-specific information about an alert. @@ -332,7 +341,7 @@ export namespace alertcenter_v1beta1 { /** * The source IP address of the malicious email, for example, `127.0.0.1`. */ - sourceIp?: string; + sourceIp?: string | null; } /** * A request to perform batch delete on alerts. @@ -341,11 +350,11 @@ export namespace alertcenter_v1beta1 { /** * Required. list of alert ids. */ - alertId?: string[]; + alertId?: string[] | null; /** * Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. */ - customerId?: string; + customerId?: string | null; } /** * Response to batch delete operation on alerts. @@ -354,11 +363,11 @@ export namespace alertcenter_v1beta1 { /** * The status details for each failed alert_id. */ - failedAlertStatus?: {[key: string]: Schema$Status}; + failedAlertStatus?: {[key: string]: Schema$Status} | null; /** * The successful list of alert ids. */ - successAlertIds?: string[]; + successAlertIds?: string[] | null; } /** * A request to perform batch undelete on alerts. @@ -367,11 +376,11 @@ export namespace alertcenter_v1beta1 { /** * Required. list of alert ids. */ - alertId?: string[]; + alertId?: string[] | null; /** * Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. */ - customerId?: string; + customerId?: string | null; } /** * Response to batch undelete operation on alerts. @@ -380,11 +389,11 @@ export namespace alertcenter_v1beta1 { /** * The status details for each failed alert_id. */ - failedAlertStatus?: {[key: string]: Schema$Status}; + failedAlertStatus?: {[key: string]: Schema$Status} | null; /** * The successful list of alert ids. */ - successAlertIds?: string[]; + successAlertIds?: string[] | null; } /** * A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. @@ -393,11 +402,11 @@ export namespace alertcenter_v1beta1 { /** * Optional. The format of the payload that would be sent. If not specified the format will be JSON. */ - payloadFormat?: string; + payloadFormat?: string | null; /** * The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). */ - topicName?: string; + topicName?: string | null; } /** * A representation of a CSV file attachment, as a list of column headers and a list of data rows. @@ -410,7 +419,7 @@ export namespace alertcenter_v1beta1 { /** * The list of headers for data columns in a CSV file. */ - headers?: string[]; + headers?: string[] | null; } /** * A representation of a single data row in a CSV file. @@ -419,7 +428,7 @@ export namespace alertcenter_v1beta1 { /** * The data entries in a CSV file row, as a string array rather than a single comma-separated string. */ - entries?: string[]; + entries?: string[] | null; } /** * A mobile device compromised alert. Derived from audit logs. @@ -428,7 +437,7 @@ export namespace alertcenter_v1beta1 { /** * The email of the user this alert was created for. */ - email?: string; + email?: string | null; /** * Required. The list of security events. */ @@ -441,31 +450,31 @@ export namespace alertcenter_v1beta1 { /** * The device compromised state. Possible values are "`Compromised`" or "`Not Compromised`". */ - deviceCompromisedState?: string; + deviceCompromisedState?: string | null; /** * Required. The device ID. */ - deviceId?: string; + deviceId?: string | null; /** * The model of the device. */ - deviceModel?: string; + deviceModel?: string | null; /** * The type of the device. */ - deviceType?: string; + deviceType?: string | null; /** * Required for iOS, empty for others. */ - iosVendorId?: string; + iosVendorId?: string | null; /** * The device resource ID. */ - resourceId?: string; + resourceId?: string | null; /** * The serial number of the device. */ - serialNumber?: string; + serialNumber?: string | null; } /** * Domain ID of Gmail phishing alerts. @@ -474,7 +483,7 @@ export namespace alertcenter_v1beta1 { /** * The primary domain for the customer. */ - customerPrimaryDomain?: string; + customerPrimaryDomain?: string | null; } /** * A takeout operation for the entire domain was initiated by an admin. Derived from audit logs. @@ -483,11 +492,11 @@ export namespace alertcenter_v1beta1 { /** * The email of the admin who initiated the takeout. */ - email?: string; + email?: string | null; /** * The takeout request ID. */ - takeoutRequestId?: string; + takeoutRequestId?: 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 `{}`. @@ -500,35 +509,35 @@ export namespace alertcenter_v1beta1 { /** * The `SHA256` hash of email's attachment and all MIME parts. */ - attachmentsSha256Hash?: string[]; + attachmentsSha256Hash?: string[] | null; /** * The date the malicious email was sent. */ - date?: string; + date?: string | null; /** * The hash of the message body text. */ - md5HashMessageBody?: string; + md5HashMessageBody?: string | null; /** * The MD5 Hash of email's subject (only available for reported emails). */ - md5HashSubject?: string; + md5HashSubject?: string | null; /** * The snippet of the message body text (only available for reported emails). */ - messageBodySnippet?: string; + messageBodySnippet?: string | null; /** * The message ID. */ - messageId?: string; + messageId?: string | null; /** * The recipient of this email. */ - recipient?: string; + recipient?: string | null; /** * The email subject text (only available for reported emails). */ - subjectText?: string; + subjectText?: string | null; } /** * An incident reported by Google Operations for a G Suite application. @@ -537,7 +546,7 @@ export namespace alertcenter_v1beta1 { /** * The list of emails which correspond to the users directly affected by the incident. */ - affectedUserEmails?: string[]; + affectedUserEmails?: string[] | null; /** * Optional. Application-specific data for an incident, provided when the G Suite application which reported the incident cannot be completely restored to a valid state. */ @@ -545,11 +554,11 @@ export namespace alertcenter_v1beta1 { /** * A detailed, freeform incident description. */ - description?: string; + description?: string | null; /** * A one-line incident description. */ - title?: string; + title?: string | null; } /** * Response message for an alert feedback listing request. @@ -571,7 +580,7 @@ export namespace alertcenter_v1beta1 { /** * The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The details of the login action. @@ -580,11 +589,11 @@ export namespace alertcenter_v1beta1 { /** * Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event. */ - ipAddress?: string; + ipAddress?: string | null; /** * Optional. The successful login time that is associated with the warning event. This will not be present for blocked login attempts. */ - loginTime?: string; + loginTime?: string | null; } /** * Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification @@ -597,7 +606,7 @@ export namespace alertcenter_v1beta1 { /** * If `true`, the email originated from within the organization. */ - isInternal?: boolean; + isInternal?: boolean | null; /** * The entity whose actions triggered a Gmail phishing alert. */ @@ -614,11 +623,11 @@ export namespace alertcenter_v1beta1 { /** * The header from display name. */ - displayName?: string; + displayName?: string | null; /** * The sender email address. */ - fromHeader?: string; + fromHeader?: string | null; } /** * Settings for callback notifications. For more details see [G Suite Alert Notification](/admin-sdk/alertcenter/guides/notifications). @@ -640,7 +649,7 @@ export namespace alertcenter_v1beta1 { /** * If `true`, the email originated from within the organization. */ - isInternal?: boolean; + isInternal?: boolean | null; /** * The entity whose actions triggered a Gmail phishing alert. */ @@ -650,6 +659,23 @@ export namespace alertcenter_v1beta1 { */ messages?: Schema$GmailMessageInfo[]; } + /** + * Requests for one application that needs default SQL setup. + */ + export interface Schema$RequestInfo { + /** + * List of app developers who triggered notifications for above application. + */ + appDeveloperEmail?: string[] | null; + /** + * Required. The application that requires the SQL setup. + */ + appKey?: string | null; + /** + * Required. Number of requests sent for this application to set up default SQL instance. + */ + numberOfRequests?: string | null; + } /** * Customer-level settings. */ @@ -666,7 +692,7 @@ export namespace alertcenter_v1beta1 { /** * The email of the user this incident was created for. */ - email?: string; + email?: 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). @@ -675,15 +701,15 @@ export namespace alertcenter_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A mobile suspicious activity alert. Derived from audit logs. @@ -692,7 +718,7 @@ export namespace alertcenter_v1beta1 { /** * The email of the user this alert was created for. */ - email?: string; + email?: string | null; /** * Required. The list of security events. */ @@ -705,39 +731,39 @@ export namespace alertcenter_v1beta1 { /** * Required. The device ID. */ - deviceId?: string; + deviceId?: string | null; /** * The model of the device. */ - deviceModel?: string; + deviceModel?: string | null; /** * The device property which was changed. */ - deviceProperty?: string; + deviceProperty?: string | null; /** * The type of the device. */ - deviceType?: string; + deviceType?: string | null; /** * Required for iOS, empty for others. */ - iosVendorId?: string; + iosVendorId?: string | null; /** * The new value of the device property after the change. */ - newValue?: string; + newValue?: string | null; /** * The old value of the device property before the change. */ - oldValue?: string; + oldValue?: string | null; /** * The device resource ID. */ - resourceId?: string; + resourceId?: string | null; /** * The serial number of the device. */ - serialNumber?: string; + serialNumber?: string | null; } /** * A request to undelete a specific alert that was marked for deletion. @@ -746,7 +772,7 @@ export namespace alertcenter_v1beta1 { /** * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. */ - customerId?: string; + customerId?: string | null; } export class Resource$Alerts { diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index d94e62075fc..fface13682a 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -116,39 +116,39 @@ export namespace analytics_v3 { /** * Child link for an account entry. Points to the list of web properties for this account. */ - childLink?: {href?: string; type?: string}; + childLink?: {href?: string; type?: string} | null; /** * Time the account was created. */ - created?: string; + created?: string | null; /** * Account ID. */ - id?: string; + id?: string | null; /** * Resource type for Analytics account. */ - kind?: string; + kind?: string | null; /** * Account name. */ - name?: string; + name?: string | null; /** * Permissions the user has for this account. */ - permissions?: {effective?: string[]}; + permissions?: {effective?: string[]} | null; /** * Link for this account. */ - selfLink?: string; + selfLink?: string | null; /** * Indicates whether this account is starred or not. */ - starred?: boolean; + starred?: boolean | null; /** * Time the account was last modified. */ - updated?: string; + updated?: string | null; } /** * JSON template for a linked account. @@ -157,19 +157,19 @@ export namespace analytics_v3 { /** * Link for this account. */ - href?: string; + href?: string | null; /** * Account ID. */ - id?: string; + id?: string | null; /** * Analytics account reference. */ - kind?: string; + kind?: string | null; /** * Account name. */ - name?: string; + name?: string | null; } /** * An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account. @@ -182,31 +182,31 @@ export namespace analytics_v3 { /** * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Next link for this account collection. */ - nextLink?: string; + nextLink?: string | null; /** * Previous link for this account collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary. @@ -219,31 +219,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this AccountSummary collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this AccountSummary collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles. @@ -252,19 +252,19 @@ export namespace analytics_v3 { /** * Account ID. */ - id?: string; + id?: string | null; /** * Resource type for Analytics AccountSummary. */ - kind?: string; + kind?: string | null; /** * Account name. */ - name?: string; + name?: string | null; /** * Indicates whether this account is starred or not. */ - starred?: boolean; + starred?: boolean | null; /** * List of web properties under this account. */ @@ -281,11 +281,11 @@ export namespace analytics_v3 { /** * Account ticket ID used to access the account ticket. */ - id?: string; + id?: string | null; /** * Resource type for account ticket. */ - kind?: string; + kind?: string | null; /** * View (Profile) for the account. */ @@ -293,7 +293,7 @@ export namespace analytics_v3 { /** * Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL. */ - redirectUri?: string; + redirectUri?: string | null; /** * Web property for the account. */ @@ -303,15 +303,15 @@ export namespace analytics_v3 { * JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields. */ export interface Schema$AccountTreeRequest { - accountName?: string; + accountName?: string | null; /** * Resource type for account ticket. */ - kind?: string; - profileName?: string; - timezone?: string; - webpropertyName?: string; - websiteUrl?: string; + kind?: string | null; + profileName?: string | null; + timezone?: string | null; + webpropertyName?: string | null; + websiteUrl?: string | null; } /** * JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile). @@ -324,7 +324,7 @@ export namespace analytics_v3 { /** * Resource type for account ticket. */ - kind?: string; + kind?: string | null; /** * View (Profile) for the account. */ @@ -341,15 +341,15 @@ export namespace analytics_v3 { /** * True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. */ - autoTaggingEnabled?: boolean; + autoTaggingEnabled?: boolean | null; /** * Customer ID. This field is required when creating a Google Ads link. */ - customerId?: string; + customerId?: string | null; /** * Resource type for Google Ads account. */ - kind?: string; + kind?: string | null; } /** * Request template for the delete upload data request. @@ -358,7 +358,7 @@ export namespace analytics_v3 { /** * A list of upload UIDs. */ - customDataImportUids?: string[]; + customDataImportUids?: string[] | null; } /** * JSON template for a metadata column. @@ -367,15 +367,15 @@ export namespace analytics_v3 { /** * Map of attribute name and value for this column. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * Column id. */ - id?: string; + id?: string | null; /** * Resource type for Analytics column. */ - kind?: string; + kind?: string | null; } /** * Lists columns (dimensions and metrics) for a particular report type. @@ -384,11 +384,11 @@ export namespace analytics_v3 { /** * List of attributes names returned by columns. */ - attributeNames?: string[]; + attributeNames?: string[] | null; /** * Etag of collection. This etag can be compared with the last response etag to check if response has changed. */ - etag?: string; + etag?: string | null; /** * List of columns for a report type. */ @@ -396,11 +396,11 @@ export namespace analytics_v3 { /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Total number of columns returned in the response. */ - totalResults?: number; + totalResults?: number | null; } /** * JSON template for an Analytics custom data source. @@ -409,61 +409,61 @@ export namespace analytics_v3 { /** * Account ID to which this custom data source belongs. */ - accountId?: string; - childLink?: {href?: string; type?: string}; + accountId?: string | null; + childLink?: {href?: string; type?: string} | null; /** * Time this custom data source was created. */ - created?: string; + created?: string | null; /** * Description of custom data source. */ - description?: string; + description?: string | null; /** * Custom data source ID. */ - id?: string; - importBehavior?: string; + id?: string | null; + importBehavior?: string | null; /** * Resource type for Analytics custom data source. */ - kind?: string; + kind?: string | null; /** * Name of this custom data source. */ - name?: string; + name?: string | null; /** * Parent link for this custom data source. Points to the web property to which this custom data source belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * IDs of views (profiles) linked to the custom data source. */ - profilesLinked?: string[]; + profilesLinked?: string[] | null; /** * Collection of schema headers of the custom data source. */ - schema?: string[]; + schema?: string[] | null; /** * Link for this Analytics custom data source. */ - selfLink?: string; + selfLink?: string | null; /** * Type of the custom data source. */ - type?: string; + type?: string | null; /** * Time this custom data source was last modified. */ - updated?: string; + updated?: string | null; /** * Upload type of the custom data source. */ - uploadType?: string; + uploadType?: string | null; /** * Web property ID of the form UA-XXXXX-YY to which this custom data source belongs. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source. @@ -476,31 +476,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this custom data source collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this custom data source collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for Analytics Custom Dimension. @@ -509,51 +509,51 @@ export namespace analytics_v3 { /** * Account ID. */ - accountId?: string; + accountId?: string | null; /** * Boolean indicating whether the custom dimension is active. */ - active?: boolean; + active?: boolean | null; /** * Time the custom dimension was created. */ - created?: string; + created?: string | null; /** * Custom dimension ID. */ - id?: string; + id?: string | null; /** * Index of the custom dimension. */ - index?: number; + index?: number | null; /** * Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. */ - kind?: string; + kind?: string | null; /** * Name of the custom dimension. */ - name?: string; + name?: string | null; /** * Parent link for the custom dimension. Points to the property to which the custom dimension belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. */ - scope?: string; + scope?: string | null; /** * Link for the custom dimension */ - selfLink?: string; + selfLink?: string | null; /** * Time the custom dimension was last modified. */ - updated?: string; + updated?: string | null; /** * Property ID. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension. @@ -566,31 +566,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this custom dimension collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this custom dimension collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for Analytics Custom Metric. @@ -599,63 +599,63 @@ export namespace analytics_v3 { /** * Account ID. */ - accountId?: string; + accountId?: string | null; /** * Boolean indicating whether the custom metric is active. */ - active?: boolean; + active?: boolean | null; /** * Time the custom metric was created. */ - created?: string; + created?: string | null; /** * Custom metric ID. */ - id?: string; + id?: string | null; /** * Index of the custom metric. */ - index?: number; + index?: number | null; /** * Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. */ - kind?: string; + kind?: string | null; /** * Max value of custom metric. */ - max_value?: string; + max_value?: string | null; /** * Min value of custom metric. */ - min_value?: string; + min_value?: string | null; /** * Name of the custom metric. */ - name?: string; + name?: string | null; /** * Parent link for the custom metric. Points to the property to which the custom metric belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * Scope of the custom metric: HIT or PRODUCT. */ - scope?: string; + scope?: string | null; /** * Link for the custom metric */ - selfLink?: string; + selfLink?: string | null; /** * Data type of custom metric. */ - type?: string; + type?: string | null; /** * Time the custom metric was last modified. */ - updated?: string; + updated?: string | null; /** * Property ID. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric. @@ -668,31 +668,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this custom metric collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this custom metric collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for Analytics Entity Google Ads Link. @@ -705,27 +705,27 @@ export namespace analytics_v3 { /** * Web property being linked. */ - entity?: {webPropertyRef?: Schema$WebPropertyRef}; + entity?: {webPropertyRef?: Schema$WebPropertyRef} | null; /** * Entity Google Ads link ID */ - id?: string; + id?: string | null; /** * Resource type for entity Google Ads link. */ - kind?: string; + kind?: string | null; /** * Name of the link. This field is required when creating a Google Ads link. */ - name?: string; + name?: string | null; /** * IDs of linked Views (Profiles) represented as strings. */ - profileIds?: string[]; + profileIds?: string[] | null; /** * URL link for this Google Analytics - Google Ads link. */ - selfLink?: string; + selfLink?: string | null; } /** * An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link. @@ -738,27 +738,27 @@ export namespace analytics_v3 { /** * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Next link for this Google Ads link collection. */ - nextLink?: string; + nextLink?: string | null; /** * Previous link for this Google Ads link collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; } /** * JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. @@ -771,23 +771,23 @@ export namespace analytics_v3 { accountRef?: Schema$AccountRef; profileRef?: Schema$ProfileRef; webPropertyRef?: Schema$WebPropertyRef; - }; + } | null; /** * Entity user link ID */ - id?: string; + id?: string | null; /** * Resource type for entity user link. */ - kind?: string; + kind?: string | null; /** * Permissions the user has for this entity. */ - permissions?: {effective?: string[]; local?: string[]}; + permissions?: {effective?: string[]; local?: string[]} | null; /** * Self link for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * User reference. */ @@ -804,27 +804,27 @@ export namespace analytics_v3 { /** * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Next link for this account collection. */ - nextLink?: string; + nextLink?: string | null; /** * Previous link for this account collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; } /** * JSON template for Analytics experiment resource. @@ -833,99 +833,99 @@ export namespace analytics_v3 { /** * Account ID to which this experiment belongs. This field is read-only. */ - accountId?: string; + accountId?: string | null; /** * Time the experiment was created. This field is read-only. */ - created?: string; + created?: string | null; /** * Notes about this experiment. */ - description?: string; + description?: string | null; /** * If true, the end user will be able to edit the experiment via the Google Analytics user interface. */ - editableInGaUi?: boolean; + editableInGaUi?: boolean | null; /** * The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only. */ - endTime?: string; + endTime?: string | null; /** * Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED. */ - equalWeighting?: boolean; + equalWeighting?: boolean | null; /** * Experiment ID. Required for patch and update. Disallowed for create. */ - id?: string; + id?: string | null; /** * Internal ID for the web property to which this experiment belongs. This field is read-only. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Resource type for an Analytics experiment. This field is read-only. */ - kind?: string; + kind?: string | null; /** * An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED. */ - minimumExperimentLengthInDays?: number; + minimumExperimentLengthInDays?: number | null; /** * Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment. */ - name?: string; + name?: string | null; /** * The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API". */ - objectiveMetric?: string; + objectiveMetric?: string | null; /** * Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED". */ - optimizationType?: string; + optimizationType?: string | null; /** * Parent link for an experiment. Points to the view (profile) to which this experiment belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * View (Profile) ID to which this experiment belongs. This field is read-only. */ - profileId?: string; + profileId?: string | null; /** * Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only. */ - reasonExperimentEnded?: string; + reasonExperimentEnded?: string | null; /** * Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED. */ - rewriteVariationUrlsAsOriginal?: boolean; + rewriteVariationUrlsAsOriginal?: boolean | null; /** * Link for this experiment. This field is read-only. */ - selfLink?: string; + selfLink?: string | null; /** * The framework used to serve the experiment variations and evaluate the results. One of: - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results. */ - servingFramework?: string; + servingFramework?: string | null; /** * The snippet of code to include on the control page(s). This field is read-only. */ - snippet?: string; + snippet?: string | null; /** * The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only. */ - startTime?: string; + startTime?: string | null; /** * Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment. */ - status?: string; + status?: string | null; /** * A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED. */ - trafficCoverage?: number; + trafficCoverage?: number | null; /** * Time the experiment was last modified. This field is read-only. */ - updated?: string; + updated?: string | null; /** * Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING. */ @@ -935,19 +935,19 @@ export namespace analytics_v3 { url?: string; weight?: number; won?: boolean; - }>; + }> | null; /** * Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only. */ - webPropertyId?: string; + webPropertyId?: string | null; /** * A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED. */ - winnerConfidenceLevel?: number; + winnerConfidenceLevel?: number | null; /** * Boolean specifying whether a winner has been found for this experiment. This field is read-only. */ - winnerFound?: boolean; + winnerFound?: boolean | null; } /** * An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment. @@ -960,31 +960,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this experiment collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this experiment collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of resources in the result. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for an Analytics account filter. @@ -993,7 +993,7 @@ export namespace analytics_v3 { /** * Account ID to which this filter belongs. */ - accountId?: string; + accountId?: string | null; /** * Details for the filter of the type ADVANCED. */ @@ -1011,11 +1011,11 @@ export namespace analytics_v3 { outputToField?: string; outputToFieldIndex?: number; overrideOutputField?: boolean; - }; + } | null; /** * Time this filter was created. */ - created?: string; + created?: string | null; /** * Details for the filter of the type EXCLUDE. */ @@ -1023,7 +1023,7 @@ export namespace analytics_v3 { /** * Filter ID. */ - id?: string; + id?: string | null; /** * Details for the filter of the type INCLUDE. */ @@ -1031,19 +1031,19 @@ export namespace analytics_v3 { /** * Resource type for Analytics filter. */ - kind?: string; + kind?: string | null; /** * Details for the filter of the type LOWER. */ - lowercaseDetails?: {field?: string; fieldIndex?: number}; + lowercaseDetails?: {field?: string; fieldIndex?: number} | null; /** * Name of this filter. */ - name?: string; + name?: string | null; /** * Parent link for this filter. Points to the account to which this filter belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * Details for the filter of the type SEARCH_AND_REPLACE. */ @@ -1053,23 +1053,23 @@ export namespace analytics_v3 { fieldIndex?: number; replaceString?: string; searchString?: string; - }; + } | null; /** * Link for this filter. */ - selfLink?: string; + selfLink?: string | null; /** * Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. */ - type?: string; + type?: string | null; /** * Time this filter was last modified. */ - updated?: string; + updated?: string | null; /** * Details for the filter of the type UPPER. */ - uppercaseDetails?: {field?: string; fieldIndex?: number}; + uppercaseDetails?: {field?: string; fieldIndex?: number} | null; } /** * JSON template for an Analytics filter expression. @@ -1078,27 +1078,27 @@ export namespace analytics_v3 { /** * Determines if the filter is case sensitive. */ - caseSensitive?: boolean; + caseSensitive?: boolean | null; /** * Filter expression value */ - expressionValue?: string; + expressionValue?: string | null; /** * Field to filter. Possible values: - Content and Traffic - PAGE_REQUEST_URI, - PAGE_HOSTNAME, - PAGE_TITLE, - REFERRAL, - COST_DATA_URI (Campaign target URL), - HIT_TYPE, - INTERNAL_SEARCH_TERM, - INTERNAL_SEARCH_TYPE, - SOURCE_PROPERTY_TRACKING_ID, - Campaign or AdGroup - CAMPAIGN_SOURCE, - CAMPAIGN_MEDIUM, - CAMPAIGN_NAME, - CAMPAIGN_AD_GROUP, - CAMPAIGN_TERM, - CAMPAIGN_CONTENT, - CAMPAIGN_CODE, - CAMPAIGN_REFERRAL_PATH, - E-Commerce - TRANSACTION_COUNTRY, - TRANSACTION_REGION, - TRANSACTION_CITY, - TRANSACTION_AFFILIATION (Store or order location), - ITEM_NAME, - ITEM_CODE, - ITEM_VARIATION, - TRANSACTION_ID, - TRANSACTION_CURRENCY_CODE, - PRODUCT_ACTION_TYPE, - Audience/Users - BROWSER, - BROWSER_VERSION, - BROWSER_SIZE, - PLATFORM, - PLATFORM_VERSION, - LANGUAGE, - SCREEN_RESOLUTION, - SCREEN_COLORS, - JAVA_ENABLED (Boolean Field), - FLASH_VERSION, - GEO_SPEED (Connection speed), - VISITOR_TYPE, - GEO_ORGANIZATION (ISP organization), - GEO_DOMAIN, - GEO_IP_ADDRESS, - GEO_IP_VERSION, - Location - GEO_COUNTRY, - GEO_REGION, - GEO_CITY, - Event - EVENT_CATEGORY, - EVENT_ACTION, - EVENT_LABEL, - Other - CUSTOM_FIELD_1, - CUSTOM_FIELD_2, - USER_DEFINED_VALUE, - Application - APP_ID, - APP_INSTALLER_ID, - APP_NAME, - APP_VERSION, - SCREEN, - IS_APP (Boolean Field), - IS_FATAL_EXCEPTION (Boolean Field), - EXCEPTION_DESCRIPTION, - Mobile device - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), - DEVICE_CATEGORY, - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - MOBILE_HAS_NFC_SUPPORT (Boolean Field), - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - MOBILE_BRAND_NAME, - MOBILE_MODEL_NAME, - MOBILE_MARKETING_NAME, - MOBILE_POINTING_METHOD, - Social - SOCIAL_NETWORK, - SOCIAL_ACTION, - SOCIAL_ACTION_TARGET, - Custom dimension - CUSTOM_DIMENSION (See accompanying field index), */ - field?: string; + field?: string | null; /** * The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. */ - fieldIndex?: number; + fieldIndex?: number | null; /** * Kind value for filter expression */ - kind?: string; + kind?: string | null; /** * Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES. */ - matchType?: string; + matchType?: string | null; } /** * JSON template for a profile filter link. @@ -1107,23 +1107,23 @@ export namespace analytics_v3 { /** * Account ID to which this filter belongs. */ - accountId?: string; + accountId?: string | null; /** * Link for this filter. */ - href?: string; + href?: string | null; /** * Filter ID. */ - id?: string; + id?: string | null; /** * Kind value for filter reference. */ - kind?: string; + kind?: string | null; /** * Name of this filter. */ - name?: string; + name?: string | null; } /** * A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter. @@ -1136,31 +1136,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this filter collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this filter collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * Analytics data for a given view (profile). @@ -1173,39 +1173,39 @@ export namespace analytics_v3 { columnType?: string; dataType?: string; name?: string; - }>; + }> | null; /** * Determines if Analytics data contains samples. */ - containsSampledData?: boolean; + containsSampledData?: boolean | null; /** * The last refreshed time in seconds for Analytics data. */ - dataLastRefreshed?: string; + dataLastRefreshed?: string | null; dataTable?: { cols?: Array<{id?: string; label?: string; type?: string}>; rows?: Array<{c?: Array<{v?: string}>}>; - }; + } | null; /** * Unique ID for this data response. */ - id?: string; + id?: string | null; /** * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this Analytics data query. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this Analytics data query. */ - previousLink?: string; + previousLink?: string | null; /** * Information for the view (profile), for which the Analytics data was requested. */ @@ -1216,7 +1216,7 @@ export namespace analytics_v3 { profileName?: string; tableId?: string; webPropertyId?: string; - }; + } | null; /** * Analytics data request query parameters. */ @@ -1232,31 +1232,31 @@ export namespace analytics_v3 { sort?: string[]; 'start-date'?: string; 'start-index'?: number; - }; + } | null; /** * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. */ - rows?: string[][]; + rows?: string[][] | null; /** * The number of samples used to calculate the result. */ - sampleSize?: string; + sampleSize?: string | null; /** * Total size of the sample space from which the samples were selected. */ - sampleSpace?: string; + sampleSpace?: string | null; /** * Link to this page. */ - selfLink?: string; + selfLink?: string | null; /** * The total number of rows for the query, regardless of the number of rows in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. */ - totalsForAllResults?: {[key: string]: string}; + totalsForAllResults?: {[key: string]: string} | null; } /** * JSON template for Analytics goal resource. @@ -1265,15 +1265,15 @@ export namespace analytics_v3 { /** * Account ID to which this goal belongs. */ - accountId?: string; + accountId?: string | null; /** * Determines whether this goal is active. */ - active?: boolean; + active?: boolean | null; /** * Time this goal was created. */ - created?: string; + created?: string | null; /** * Details for the goal of the type EVENT. */ @@ -1286,43 +1286,43 @@ export namespace analytics_v3 { type?: string; }>; useEventValue?: boolean; - }; + } | null; /** * Goal ID. */ - id?: string; + id?: string | null; /** * Internal ID for the web property to which this goal belongs. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Resource type for an Analytics goal. */ - kind?: string; + kind?: string | null; /** * Goal name. */ - name?: string; + name?: string | null; /** * Parent link for a goal. Points to the view (profile) to which this goal belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * View (Profile) ID to which this goal belongs. */ - profileId?: string; + profileId?: string | null; /** * Link for this goal. */ - selfLink?: string; + selfLink?: string | null; /** * Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT. */ - type?: string; + type?: string | null; /** * Time this goal was last modified. */ - updated?: string; + updated?: string | null; /** * Details for the goal of the type URL_DESTINATION. */ @@ -1332,26 +1332,29 @@ export namespace analytics_v3 { matchType?: string; steps?: Array<{name?: string; number?: number; url?: string}>; url?: string; - }; + } | null; /** * Goal value. */ - value?: number; + value?: number | null; /** * Details for the goal of the type VISIT_NUM_PAGES. */ - visitNumPagesDetails?: {comparisonType?: string; comparisonValue?: string}; + visitNumPagesDetails?: { + comparisonType?: string; + comparisonValue?: string; + } | null; /** * Details for the goal of the type VISIT_TIME_ON_SITE. */ visitTimeOnSiteDetails?: { comparisonType?: string; comparisonValue?: string; - }; + } | null; /** * Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal. @@ -1364,48 +1367,48 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this goal collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this goal collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of resources in the result. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for a hash Client Id request resource. */ export interface Schema$HashClientIdRequest { - clientId?: string; - kind?: string; - webPropertyId?: string; + clientId?: string | null; + kind?: string | null; + webPropertyId?: string | null; } /** * JSON template for a hash Client Id response resource. */ export interface Schema$HashClientIdResponse { - clientId?: string; - hashedClientId?: string; - kind?: string; - webPropertyId?: string; + clientId?: string | null; + hashedClientId?: string | null; + kind?: string | null; + webPropertyId?: string | null; } /** * JSON template for an Analytics Remarketing Include Conditions. @@ -1414,23 +1417,23 @@ export namespace analytics_v3 { /** * The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. */ - daysToLookBack?: number; + daysToLookBack?: number | null; /** * Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 */ - isSmartList?: boolean; + isSmartList?: boolean | null; /** * Resource type for include conditions. */ - kind?: string; + kind?: string | null; /** * Number of days (in the range 1 to 540) a user remains in the audience. */ - membershipDurationDays?: number; + membershipDurationDays?: number | null; /** * The segment condition that will cause a user to be added to an audience. */ - segment?: string; + segment?: string | null; } /** * JSON template for an Analytics Remarketing Audience Foreign Link. @@ -1439,43 +1442,43 @@ export namespace analytics_v3 { /** * Account ID to which this linked foreign account belongs. */ - accountId?: string; + accountId?: string | null; /** * Boolean indicating whether this is eligible for search. */ - eligibleForSearch?: boolean; + eligibleForSearch?: boolean | null; /** * Entity ad account link ID. */ - id?: string; + id?: string | null; /** * Internal ID for the web property to which this linked foreign account belongs. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Resource type for linked foreign account. */ - kind?: string; + kind?: string | null; /** * The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. */ - linkedAccountId?: string; + linkedAccountId?: string | null; /** * Remarketing audience ID to which this linked foreign account belongs. */ - remarketingAudienceId?: string; + remarketingAudienceId?: string | null; /** * The status of this foreign account link. */ - status?: string; + status?: string | null; /** * The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. */ - type?: string; + type?: string | null; /** * Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * Multi-Channel Funnels data for a given view (profile). @@ -1488,31 +1491,31 @@ export namespace analytics_v3 { columnType?: string; dataType?: string; name?: string; - }>; + }> | null; /** * Determines if the Analytics data contains sampled data. */ - containsSampledData?: boolean; + containsSampledData?: boolean | null; /** * Unique ID for this data response. */ - id?: string; + id?: string | null; /** * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this Analytics data query. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this Analytics data query. */ - previousLink?: string; + previousLink?: string | null; /** * Information for the view (profile), for which the Analytics data was requested. */ @@ -1523,7 +1526,7 @@ export namespace analytics_v3 { profileName?: string; tableId?: string; webPropertyId?: string; - }; + } | null; /** * Analytics data request query parameters. */ @@ -1539,7 +1542,7 @@ export namespace analytics_v3 { sort?: string[]; 'start-date'?: string; 'start-index'?: number; - }; + } | null; /** * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. */ @@ -1551,27 +1554,27 @@ export namespace analytics_v3 { }>; primitiveValue?: string; }> - >; + > | null; /** * The number of samples used to calculate the result. */ - sampleSize?: string; + sampleSize?: string | null; /** * Total size of the sample space from which the samples were selected. */ - sampleSpace?: string; + sampleSpace?: string | null; /** * Link to this page. */ - selfLink?: string; + selfLink?: string | null; /** * The total number of rows for the query, regardless of the number of rows in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. */ - totalsForAllResults?: {[key: string]: string}; + totalsForAllResults?: {[key: string]: string} | null; } /** * JSON template for an Analytics view (profile). @@ -1580,107 +1583,107 @@ export namespace analytics_v3 { /** * Account ID to which this view (profile) belongs. */ - accountId?: string; + accountId?: string | null; /** * Indicates whether bot filtering is enabled for this view (profile). */ - botFilteringEnabled?: boolean; + botFilteringEnabled?: boolean | null; /** * Child link for this view (profile). Points to the list of goals for this view (profile). */ - childLink?: {href?: string; type?: string}; + childLink?: {href?: string; type?: string} | null; /** * Time this view (profile) was created. */ - created?: string; + created?: string | null; /** * The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL */ - currency?: string; + currency?: string | null; /** * Default page for this view (profile). */ - defaultPage?: string; + defaultPage?: string | null; /** * Indicates whether ecommerce tracking is enabled for this view (profile). */ - eCommerceTracking?: boolean; + eCommerceTracking?: boolean | null; /** * Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. */ - enhancedECommerceTracking?: boolean; + enhancedECommerceTracking?: boolean | null; /** * The query parameters that are excluded from this view (profile). */ - excludeQueryParameters?: string; + excludeQueryParameters?: string | null; /** * View (Profile) ID. */ - id?: string; + id?: string | null; /** * Internal ID for the web property to which this view (profile) belongs. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Resource type for Analytics view (profile). */ - kind?: string; + kind?: string | null; /** * Name of this view (profile). */ - name?: string; + name?: string | null; /** * Parent link for this view (profile). Points to the web property to which this view (profile) belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * Permissions the user has for this view (profile). */ - permissions?: {effective?: string[]}; + permissions?: {effective?: string[]} | null; /** * Link for this view (profile). */ - selfLink?: string; + selfLink?: string | null; /** * Site search category parameters for this view (profile). */ - siteSearchCategoryParameters?: string; + siteSearchCategoryParameters?: string | null; /** * The site search query parameters for this view (profile). */ - siteSearchQueryParameters?: string; + siteSearchQueryParameters?: string | null; /** * Indicates whether this view (profile) is starred or not. */ - starred?: boolean; + starred?: boolean | null; /** * Whether or not Analytics will strip search category parameters from the URLs in your reports. */ - stripSiteSearchCategoryParameters?: boolean; + stripSiteSearchCategoryParameters?: boolean | null; /** * Whether or not Analytics will strip search query parameters from the URLs in your reports. */ - stripSiteSearchQueryParameters?: boolean; + stripSiteSearchQueryParameters?: boolean | null; /** * Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. */ - timezone?: string; + timezone?: string | null; /** * View (Profile) type. Supported types: WEB or APP. */ - type?: string; + type?: string | null; /** * Time this view (profile) was last modified. */ - updated?: string; + updated?: string | null; /** * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. */ - webPropertyId?: string; + webPropertyId?: string | null; /** * Website URL for this view (profile). */ - websiteUrl?: string; + websiteUrl?: string | null; } /** * JSON template for an Analytics profile filter link. @@ -1693,11 +1696,11 @@ export namespace analytics_v3 { /** * Profile filter link ID. */ - id?: string; + id?: string | null; /** * Resource type for Analytics filter. */ - kind?: string; + kind?: string | null; /** * View (Profile) for this link. */ @@ -1705,11 +1708,11 @@ export namespace analytics_v3 { /** * The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1. */ - rank?: number; + rank?: number | null; /** * Link for this profile filter link. */ - selfLink?: string; + selfLink?: string | null; } /** * A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link. @@ -1722,31 +1725,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this profile filter link collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this profile filter link collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for a linked view (profile). @@ -1755,31 +1758,31 @@ export namespace analytics_v3 { /** * Account ID to which this view (profile) belongs. */ - accountId?: string; + accountId?: string | null; /** * Link for this view (profile). */ - href?: string; + href?: string | null; /** * View (Profile) ID. */ - id?: string; + id?: string | null; /** * Internal ID for the web property to which this view (profile) belongs. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Analytics view (profile) reference. */ - kind?: string; + kind?: string | null; /** * Name of this view (profile). */ - name?: string; + name?: string | null; /** * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile). @@ -1792,31 +1795,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this view (profile) collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this view (profile) collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile. @@ -1825,23 +1828,23 @@ export namespace analytics_v3 { /** * View (profile) ID. */ - id?: string; + id?: string | null; /** * Resource type for Analytics ProfileSummary. */ - kind?: string; + kind?: string | null; /** * View (profile) name. */ - name?: string; + name?: string | null; /** * Indicates whether this view (profile) is starred or not. */ - starred?: boolean; + starred?: boolean | null; /** * View (Profile) type. Supported types: WEB or APP. */ - type?: string; + type?: string | null; } /** * Real time data for a given view (profile). @@ -1854,15 +1857,15 @@ export namespace analytics_v3 { columnType?: string; dataType?: string; name?: string; - }>; + }> | null; /** * Unique ID for this data response. */ - id?: string; + id?: string | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Information for the view (profile), for which the real time data was requested. */ @@ -1873,7 +1876,7 @@ export namespace analytics_v3 { profileName?: string; tableId?: string; webPropertyId?: string; - }; + } | null; /** * Real time data request query parameters. */ @@ -1884,23 +1887,23 @@ export namespace analytics_v3 { 'max-results'?: number; metrics?: string[]; sort?: string[]; - }; + } | null; /** * Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. */ - rows?: string[][]; + rows?: string[][] | null; /** * Link to this page. */ - selfLink?: string; + selfLink?: string | null; /** * The total number of rows for the query, regardless of the number of rows in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. */ - totalsForAllResults?: {[key: string]: string}; + totalsForAllResults?: {[key: string]: string} | null; } /** * JSON template for an Analytics remarketing audience. @@ -1909,35 +1912,35 @@ export namespace analytics_v3 { /** * Account ID to which this remarketing audience belongs. */ - accountId?: string; + accountId?: string | null; /** * The simple audience definition that will cause a user to be added to an audience. */ - audienceDefinition?: {includeConditions?: Schema$IncludeConditions}; + audienceDefinition?: {includeConditions?: Schema$IncludeConditions} | null; /** * The type of audience, either SIMPLE or STATE_BASED. */ - audienceType?: string; + audienceType?: string | null; /** * Time this remarketing audience was created. */ - created?: string; + created?: string | null; /** * The description of this remarketing audience. */ - description?: string; + description?: string | null; /** * Remarketing Audience ID. */ - id?: string; + id?: string | null; /** * Internal ID for the web property to which this remarketing audience belongs. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. */ @@ -1945,26 +1948,26 @@ export namespace analytics_v3 { /** * The views (profiles) that this remarketing audience is linked to. */ - linkedViews?: string[]; + linkedViews?: string[] | null; /** * The name of this remarketing audience. */ - name?: string; + name?: string | null; /** * A state based audience definition that will cause a user to be added or removed from an audience. */ stateBasedAudienceDefinition?: { excludeConditions?: {exclusionDuration?: string; segment?: string}; includeConditions?: Schema$IncludeConditions; - }; + } | null; /** * Time this remarketing audience was last modified. */ - updated?: string; + updated?: string | null; /** * Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience. @@ -1977,31 +1980,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this remarketing audience collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this view (profile) collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for an Analytics segment. @@ -2010,39 +2013,39 @@ export namespace analytics_v3 { /** * Time the segment was created. */ - created?: string; + created?: string | null; /** * Segment definition. */ - definition?: string; + definition?: string | null; /** * Segment ID. */ - id?: string; + id?: string | null; /** * Resource type for Analytics segment. */ - kind?: string; + kind?: string | null; /** * Segment name. */ - name?: string; + name?: string | null; /** * Segment ID. Can be used with the 'segment' parameter in Core Reporting API. */ - segmentId?: string; + segmentId?: string | null; /** * Link for this segment. */ - selfLink?: string; + selfLink?: string | null; /** * Type for a segment. Possible values are "BUILT_IN" or "CUSTOM". */ - type?: string; + type?: string | null; /** * Time the segment was last modified. */ - updated?: string; + updated?: string | null; } /** * An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment. @@ -2055,31 +2058,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type for segments. */ - kind?: string; + kind?: string | null; /** * Link to next page for this segment collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this segment collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for Analytics unsampled report resource. @@ -2088,79 +2091,79 @@ export namespace analytics_v3 { /** * Account ID to which this unsampled report belongs. */ - accountId?: string; + accountId?: string | null; /** * Download details for a file stored in Google Cloud Storage. */ - cloudStorageDownloadDetails?: {bucketId?: string; objectId?: string}; + cloudStorageDownloadDetails?: {bucketId?: string; objectId?: string} | null; /** * Time this unsampled report was created. */ - created?: string; + created?: string | null; /** * The dimensions for the unsampled report. */ - dimensions?: string; + dimensions?: string | null; /** * The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. */ - downloadType?: string; + downloadType?: string | null; /** * Download details for a file stored in Google Drive. */ - driveDownloadDetails?: {documentId?: string}; + driveDownloadDetails?: {documentId?: string} | null; /** * The end date for the unsampled report. */ - 'end-date'?: string; + 'end-date'?: string | null; /** * The filters for the unsampled report. */ - filters?: string; + filters?: string | null; /** * Unsampled report ID. */ - id?: string; + id?: string | null; /** * Resource type for an Analytics unsampled report. */ - kind?: string; + kind?: string | null; /** * The metrics for the unsampled report. */ - metrics?: string; + metrics?: string | null; /** * View (Profile) ID to which this unsampled report belongs. */ - profileId?: string; + profileId?: string | null; /** * The segment for the unsampled report. */ - segment?: string; + segment?: string | null; /** * Link for this unsampled report. */ - selfLink?: string; + selfLink?: string | null; /** * The start date for the unsampled report. */ - 'start-date'?: string; + 'start-date'?: string | null; /** * Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. */ - status?: string; + status?: string | null; /** * Title of the unsampled report. */ - title?: string; + title?: string | null; /** * Time this unsampled report was last modified. */ - updated?: string; + updated?: string | null; /** * Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report. @@ -2173,31 +2176,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this unsampled report collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this unsampled report collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of resources in the result. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * Metadata returned for an upload operation. @@ -2206,31 +2209,31 @@ export namespace analytics_v3 { /** * Account Id to which this upload belongs. */ - accountId?: string; + accountId?: string | null; /** * Custom data source Id to which this data import belongs. */ - customDataSourceId?: string; + customDataSourceId?: string | null; /** * Data import errors collection. */ - errors?: string[]; + errors?: string[] | null; /** * A unique ID for this upload. */ - id?: string; + id?: string | null; /** * Resource type for Analytics upload. */ - kind?: string; + kind?: string | null; /** * Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED. */ - status?: string; + status?: string | null; /** * Time this file is uploaded. */ - uploadTime?: string; + uploadTime?: string | null; } /** * Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload. @@ -2243,27 +2246,27 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this upload collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this upload collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of resources in the result. */ - totalResults?: number; + totalResults?: number | null; } /** * JSON template for a user deletion request resource. @@ -2272,27 +2275,27 @@ export namespace analytics_v3 { /** * This marks the point in time for which all user data before should be deleted */ - deletionRequestTime?: string; + deletionRequestTime?: string | null; /** * Firebase Project Id */ - firebaseProjectId?: string; + firebaseProjectId?: string | null; /** * User ID. */ - id?: {type?: string; userId?: string}; + id?: {type?: string; userId?: string} | null; /** * Value is "analytics#userDeletionRequest". */ - kind?: string; + kind?: string | null; /** * Property ID */ - propertyId?: string; + propertyId?: string | null; /** * Web property ID of the form UA-XXXXX-YY. */ - webPropertyId?: string; + webPropertyId?: string | null; } /** * JSON template for a user reference. @@ -2301,12 +2304,12 @@ export namespace analytics_v3 { /** * Email ID of this user. */ - email?: string; + email?: string | null; /** * User ID. */ - id?: string; - kind?: string; + id?: string | null; + kind?: string | null; } /** * A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property. @@ -2319,31 +2322,31 @@ export namespace analytics_v3 { /** * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * Collection type. */ - kind?: string; + kind?: string | null; /** * Link to next page for this web property collection. */ - nextLink?: string; + nextLink?: string | null; /** * Link to previous page for this web property collection. */ - previousLink?: string; + previousLink?: string | null; /** * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ - startIndex?: number; + startIndex?: number | null; /** * The total number of results for the query, regardless of the number of results in the response. */ - totalResults?: number; + totalResults?: number | null; /** * Email ID of the authenticated user */ - username?: string; + username?: string | null; } /** * JSON template for an Analytics web property. @@ -2352,79 +2355,79 @@ export namespace analytics_v3 { /** * Account ID to which this web property belongs. */ - accountId?: string; + accountId?: string | null; /** * Child link for this web property. Points to the list of views (profiles) for this web property. */ - childLink?: {href?: string; type?: string}; + childLink?: {href?: string; type?: string} | null; /** * Time this web property was created. */ - created?: string; + created?: string | null; /** * Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert. */ - dataRetentionResetOnNewActivity?: boolean; + dataRetentionResetOnNewActivity?: boolean | null; /** * The length of time for which user and event data is retained. This property cannot be set on insert. */ - dataRetentionTtl?: string; + dataRetentionTtl?: string | null; /** * Default view (profile) ID. */ - defaultProfileId?: string; + defaultProfileId?: string | null; /** * Web property ID of the form UA-XXXXX-YY. */ - id?: string; + id?: string | null; /** * The industry vertical/category selected for this web property. */ - industryVertical?: string; + industryVertical?: string | null; /** * Internal ID for this web property. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Resource type for Analytics WebProperty. */ - kind?: string; + kind?: string | null; /** * Level for this web property. Possible values are STANDARD or PREMIUM. */ - level?: string; + level?: string | null; /** * Name of this web property. */ - name?: string; + name?: string | null; /** * Parent link for this web property. Points to the account to which this web property belongs. */ - parentLink?: {href?: string; type?: string}; + parentLink?: {href?: string; type?: string} | null; /** * Permissions the user has for this web property. */ - permissions?: {effective?: string[]}; + permissions?: {effective?: string[]} | null; /** * View (Profile) count for this web property. */ - profileCount?: number; + profileCount?: number | null; /** * Link for this web property. */ - selfLink?: string; + selfLink?: string | null; /** * Indicates whether this web property is starred or not. */ - starred?: boolean; + starred?: boolean | null; /** * Time this web property was last modified. */ - updated?: string; + updated?: string | null; /** * Website url for this web property. */ - websiteUrl?: string; + websiteUrl?: string | null; } /** * JSON template for a web property reference. @@ -2433,27 +2436,27 @@ export namespace analytics_v3 { /** * Account ID to which this web property belongs. */ - accountId?: string; + accountId?: string | null; /** * Link for this web property. */ - href?: string; + href?: string | null; /** * Web property ID of the form UA-XXXXX-YY. */ - id?: string; + id?: string | null; /** * Internal ID for this web property. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Analytics web property reference. */ - kind?: string; + kind?: string | null; /** * Name of this web property. */ - name?: string; + name?: string | null; } /** * JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property. @@ -2462,23 +2465,23 @@ export namespace analytics_v3 { /** * Web property ID of the form UA-XXXXX-YY. */ - id?: string; + id?: string | null; /** * Internal ID for this web property. */ - internalWebPropertyId?: string; + internalWebPropertyId?: string | null; /** * Resource type for Analytics WebPropertySummary. */ - kind?: string; + kind?: string | null; /** * Level for this web property. Possible values are STANDARD or PREMIUM. */ - level?: string; + level?: string | null; /** * Web property name. */ - name?: string; + name?: string | null; /** * List of profiles under this web property. */ @@ -2486,11 +2489,11 @@ export namespace analytics_v3 { /** * Indicates whether this web property is starred or not. */ - starred?: boolean; + starred?: boolean | null; /** * Website url for this web property. */ - websiteUrl?: string; + websiteUrl?: string | null; } export class Resource$Data { diff --git a/src/apis/analyticsreporting/v4.ts b/src/apis/analyticsreporting/v4.ts index a020f2458ee..03788fb61b3 100644 --- a/src/apis/analyticsreporting/v4.ts +++ b/src/apis/analyticsreporting/v4.ts @@ -124,13 +124,13 @@ export namespace analyticsreporting_v4 { */ export interface Schema$Activity { /** - * Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. + * Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two sessions. */ - activityTime?: string; + activityTime?: string | null; /** * Type of this activity. */ - activityType?: string; + activityType?: string | null; /** * This will be set if `activity_type` equals `SCREEN_VIEW`. */ @@ -138,11 +138,11 @@ export namespace analyticsreporting_v4 { /** * For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set). */ - campaign?: string; + campaign?: string | null; /** * The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings). */ - channelGrouping?: string; + channelGrouping?: string | null; /** * A list of all custom dimensions associated with this activity. */ @@ -162,19 +162,19 @@ export namespace analyticsreporting_v4 { /** * The hostname from which the tracking request was made. */ - hostname?: string; + hostname?: string | null; /** * For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set). */ - keyword?: string; + keyword?: string | null; /** * The first page in users' sessions, or the landing page. */ - landingPagePath?: string; + landingPagePath?: string | null; /** * The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none). */ - medium?: string; + medium?: string | null; /** * This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited. */ @@ -182,7 +182,7 @@ export namespace analyticsreporting_v4 { /** * The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct). */ - source?: string; + source?: string | null; } /** * Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort. @@ -195,11 +195,11 @@ export namespace analyticsreporting_v4 { /** * A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...]. */ - name?: string; + name?: string | null; /** * Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort. */ - type?: string; + type?: string | null; } /** * Defines a cohort group. For example: "cohortGroup": { "cohorts": [{ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" } },{ "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" } }] } @@ -212,7 +212,7 @@ export namespace analyticsreporting_v4 { /** * Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) */ - lifetimeValue?: boolean; + lifetimeValue?: boolean | null; } /** * Column headers. @@ -221,7 +221,7 @@ export namespace analyticsreporting_v4 { /** * The dimension names in the response. */ - dimensions?: string[]; + dimensions?: string[] | null; /** * Metric headers for the metrics in the response. */ @@ -234,11 +234,11 @@ export namespace analyticsreporting_v4 { /** * Slot number of custom dimension. */ - index?: number; + index?: number | null; /** * Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value. */ - value?: string; + value?: string | null; } /** * A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. @@ -247,11 +247,11 @@ export namespace analyticsreporting_v4 { /** * The end date for the query in the format `YYYY-MM-DD`. */ - endDate?: string; + endDate?: string | null; /** * The start date for the query in the format `YYYY-MM-DD`. */ - startDate?: string; + startDate?: string | null; } /** * Used to return a list of metrics for a single DateRange / dimension combination @@ -264,7 +264,7 @@ export namespace analyticsreporting_v4 { /** * Each value corresponds to each Metric in the request. */ - values?: string[]; + values?: string[] | null; } /** * [Dimensions](https://support.google.com/analytics/answer/1033861) are attributes of your data. For example, the dimension `ga:city` indicates the city, for example, "Paris" or "New York", from which a session originates. @@ -273,11 +273,11 @@ export namespace analyticsreporting_v4 { /** * If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of "0, 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0, dimension value "<0" - bucket #2: values in [0,1), dimension value "0" - bucket #3: values in [1,3), dimension value "1-2" - bucket #4: values in [3,4), dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" - bucket #6: values >= 7, dimension value "7+" NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is: "<50", "1001+", "121-1000", "50-120" And the ascending `HISTOGRAM_BUCKET` order is: "<50", "50-120", "121-1000", "1001+" The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension. */ - histogramBuckets?: string[]; + histogramBuckets?: string[] | null; /** * Name of the dimension to fetch, for example `ga:browser`. */ - name?: string; + name?: string | null; } /** * Dimension filter specifies the filtering options on a dimension. @@ -286,23 +286,23 @@ export namespace analyticsreporting_v4 { /** * Should the match be case sensitive? Default is false. */ - caseSensitive?: boolean; + caseSensitive?: boolean | null; /** * The dimension to filter on. A DimensionFilter must contain a dimension. */ - dimensionName?: string; + dimensionName?: string | null; /** * Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list is used to filter the dimensions as explained in the description of the `IN_LIST` operator. */ - expressions?: string[]; + expressions?: string[] | null; /** * Logical `NOT` operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false. */ - not?: boolean; + not?: boolean | null; /** * How to match the dimension to the expression. The default is REGEXP. */ - operator?: string; + operator?: string | null; } /** * A group of dimension filters. Set the operator value to specify how the filters are logically combined. @@ -315,7 +315,7 @@ export namespace analyticsreporting_v4 { /** * The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`. */ - operator?: string; + operator?: string | null; } /** * Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both. @@ -324,7 +324,7 @@ export namespace analyticsreporting_v4 { /** * The name of the dynamic segment. */ - name?: string; + name?: string | null; /** * Session Segment to select sessions to include in the segment. */ @@ -341,11 +341,11 @@ export namespace analyticsreporting_v4 { /** * Action associated with this e-commerce action. */ - actionType?: string; + actionType?: string | null; /** * The type of this e-commerce activity. */ - ecommerceType?: string; + ecommerceType?: string | null; /** * Details of the products in this transaction. */ @@ -362,23 +362,23 @@ export namespace analyticsreporting_v4 { /** * Type of interaction with the object. Eg: 'play'. */ - eventAction?: string; + eventAction?: string | null; /** * The object on the page that was interacted with. Eg: 'Video'. */ - eventCategory?: string; + eventCategory?: string | null; /** * Number of such events in this activity. */ - eventCount?: string; + eventCount?: string | null; /** * Label attached with the event. */ - eventLabel?: string; + eventLabel?: string | null; /** * Numeric value associated with the event. */ - eventValue?: string; + eventValue?: string | null; } /** * The batch request containing multiple report request. @@ -391,7 +391,7 @@ export namespace analyticsreporting_v4 { /** * Enables [resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is set to `True` the per view (profile) quotas are governed by the computational cost of the request. Note that using cost based quotas will higher enable sampling rates. (10 Million for `SMALL`, 100M for `LARGE`. See the [limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details. */ - useResourceQuotas?: boolean; + useResourceQuotas?: boolean | null; } /** * The main response class which holds the reports from the Reporting API `batchGet` call. @@ -400,7 +400,7 @@ export namespace analyticsreporting_v4 { /** * The amount of resource quota tokens deducted to execute the query. Includes all responses. */ - queryCost?: number; + queryCost?: number | null; /** * Responses corresponding to each of the request. */ @@ -417,35 +417,35 @@ export namespace analyticsreporting_v4 { /** * URL of the page where this goal was completed. */ - goalCompletionLocation?: string; + goalCompletionLocation?: string | null; /** * Total number of goal completions in this activity. */ - goalCompletions?: string; + goalCompletions?: string | null; /** * This identifies the goal as configured for the profile. */ - goalIndex?: number; + goalIndex?: number | null; /** * Name of the goal. */ - goalName?: string; + goalName?: string | null; /** * URL of the page one step prior to the goal completion. */ - goalPreviousStep1?: string; + goalPreviousStep1?: string | null; /** * URL of the page two steps prior to the goal completion. */ - goalPreviousStep2?: string; + goalPreviousStep2?: string | null; /** * URL of the page three steps prior to the goal completion. */ - goalPreviousStep3?: string; + goalPreviousStep3?: string | null; /** * Value in this goal. */ - goalValue?: number; + goalValue?: number | null; } /** * Represents a set of goals that were reached in an activity. @@ -463,15 +463,15 @@ export namespace analyticsreporting_v4 { /** * An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header. */ - alias?: string; + alias?: string | null; /** * A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results. */ - expression?: string; + expression?: string | null; /** * Specifies how the metric expression should be formatted, for example `INTEGER`. */ - formattingType?: string; + formattingType?: string | null; } /** * MetricFilter specifies the filter on a metric. @@ -480,19 +480,19 @@ export namespace analyticsreporting_v4 { /** * The value to compare against. */ - comparisonValue?: string; + comparisonValue?: string | null; /** * The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression. */ - metricName?: string; + metricName?: string | null; /** * Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false. */ - not?: boolean; + not?: boolean | null; /** * Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore the comparisonValue. */ - operator?: string; + operator?: string | null; } /** * Represents a group of metric filters. Set the operator value to specify how the filters are logically combined. @@ -505,7 +505,7 @@ export namespace analyticsreporting_v4 { /** * The operator for combining multiple metric filters. If unspecified, it is treated as an `OR`. */ - operator?: string; + operator?: string | null; } /** * The headers for the metrics. @@ -527,11 +527,11 @@ export namespace analyticsreporting_v4 { /** * The name of the header. */ - name?: string; + name?: string | null; /** * The type of the metric, for example `INTEGER`. */ - type?: string; + type?: string | null; } /** * Specifies the sorting options. @@ -540,15 +540,15 @@ export namespace analyticsreporting_v4 { /** * The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` is not valid. */ - fieldName?: string; + fieldName?: string | null; /** * The order type. The default orderType is `VALUE`. */ - orderType?: string; + orderType?: string | null; /** * The sorting order for the field. */ - sortOrder?: string; + sortOrder?: string | null; } /** * A list of segment filters in the `OR` group are combined with the logical OR operator. @@ -566,11 +566,11 @@ export namespace analyticsreporting_v4 { /** * The URL of the page that the visitor viewed. */ - pagePath?: string; + pagePath?: string | null; /** * The title of the page that the visitor viewed. */ - pageTitle?: string; + pageTitle?: string | null; } /** * The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension. @@ -587,7 +587,7 @@ export namespace analyticsreporting_v4 { /** * Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000. */ - maxGroupCount?: number; + maxGroupCount?: number | null; /** * The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request. */ @@ -595,7 +595,7 @@ export namespace analyticsreporting_v4 { /** * If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response. */ - startGroup?: number; + startGroup?: number | null; } /** * The headers for each of the pivot sections defined in the request. @@ -608,7 +608,7 @@ export namespace analyticsreporting_v4 { /** * The total number of groups for this pivot. */ - totalPivotGroupsCount?: number; + totalPivotGroupsCount?: number | null; } /** * The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response. @@ -617,11 +617,11 @@ export namespace analyticsreporting_v4 { /** * The name of the dimensions in the pivot response. */ - dimensionNames?: string[]; + dimensionNames?: string[] | null; /** * The values for the dimensions in the pivot. */ - dimensionValues?: string[]; + dimensionValues?: string[] | null; /** * The metric header for the metric in the pivot. */ @@ -634,7 +634,7 @@ export namespace analyticsreporting_v4 { /** * The values of the metrics in each of the pivot regions. */ - values?: string[]; + values?: string[] | null; } /** * Details of the products in an e-commerce transaction. @@ -643,19 +643,19 @@ export namespace analyticsreporting_v4 { /** * The total revenue from purchased product items. */ - itemRevenue?: number; + itemRevenue?: number | null; /** * The product name, supplied by the e-commerce tracking application, for the purchased items. */ - productName?: string; + productName?: string | null; /** * Total number of this product units in the transaction. */ - productQuantity?: string; + productQuantity?: string | null; /** * Unique code that represents the product. */ - productSku?: string; + productSku?: string | null; } /** * The data response corresponding to the request. @@ -672,7 +672,7 @@ export namespace analyticsreporting_v4 { /** * Page token to retrieve the next page of results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The data part of the report. @@ -681,11 +681,11 @@ export namespace analyticsreporting_v4 { /** * The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report. */ - dataLastRefreshed?: string; + dataLastRefreshed?: string | null; /** * Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time. */ - isDataGolden?: boolean; + isDataGolden?: boolean | null; /** * Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero. */ @@ -697,7 +697,7 @@ export namespace analyticsreporting_v4 { /** * Total number of matching rows for this query. */ - rowCount?: number; + rowCount?: number | null; /** * There's one ReportRow for every unique combination of dimensions. */ @@ -705,11 +705,11 @@ export namespace analyticsreporting_v4 { /** * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ - samplesReadCounts?: string[]; + samplesReadCounts?: string[] | null; /** * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ - samplingSpaceSizes?: string[]; + samplingSpaceSizes?: string[] | null; /** * For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. Totals are computed before pagination. */ @@ -738,19 +738,19 @@ export namespace analyticsreporting_v4 { /** * Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters). */ - filtersExpression?: string; + filtersExpression?: string | null; /** * If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals. */ - hideTotals?: boolean; + hideTotals?: boolean | null; /** * If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned. */ - hideValueRanges?: boolean; + hideValueRanges?: boolean | null; /** * If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows. */ - includeEmptyRows?: boolean; + includeEmptyRows?: boolean | null; /** * The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated. */ @@ -766,11 +766,11 @@ export namespace analyticsreporting_v4 { /** * Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value. */ - pageSize?: number; + pageSize?: number | null; /** * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request. */ - pageToken?: string; + pageToken?: string | null; /** * The pivot definitions. Requests can have a maximum of 2 pivots. */ @@ -778,7 +778,7 @@ export namespace analyticsreporting_v4 { /** * The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ - samplingLevel?: string; + samplingLevel?: string | null; /** * Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension. */ @@ -786,7 +786,7 @@ export namespace analyticsreporting_v4 { /** * The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`. */ - viewId?: string; + viewId?: string | null; } /** * A row in the report. @@ -795,7 +795,7 @@ export namespace analyticsreporting_v4 { /** * List of requested dimensions. */ - dimensions?: string[]; + dimensions?: string[] | null; /** * List of metrics for each requested DateRange. */ @@ -808,29 +808,29 @@ export namespace analyticsreporting_v4 { /** * Daily resource quota remaining remaining. */ - dailyQuotaTokensRemaining?: number; + dailyQuotaTokensRemaining?: number | null; /** * Hourly resource quota tokens remaining. */ - hourlyQuotaTokensRemaining?: number; + hourlyQuotaTokensRemaining?: number | null; } export interface Schema$ScreenviewData { /** * The application name. */ - appName?: string; + appName?: string | null; /** * Mobile manufacturer or branded name. Eg: "Google", "Apple" etc. */ - mobileDeviceBranding?: string; + mobileDeviceBranding?: string | null; /** * Mobile device model. Eg: "Pixel", "iPhone" etc. */ - mobileDeviceModel?: string; + mobileDeviceModel?: string | null; /** * The name of the screen. */ - screenName?: string; + screenName?: string | null; } /** * The request to fetch User Report from Reporting API `userActivity:get` call. @@ -839,7 +839,7 @@ export namespace analyticsreporting_v4 { /** * Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned. */ - activityTypes?: string[]; + activityTypes?: string[] | null; /** * Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). */ @@ -847,11 +847,11 @@ export namespace analyticsreporting_v4 { /** * Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page. */ - pageSize?: number; + pageSize?: number | null; /** * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the [SearchUserActivityRequest](#SearchUserActivityRequest) request. */ - pageToken?: string; + pageToken?: string | null; /** * Required. Unique user Id to query for. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this field. */ @@ -859,7 +859,7 @@ export namespace analyticsreporting_v4 { /** * Required. The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the `viewId`. */ - viewId?: string; + viewId?: string | null; } /** * The response from `userActivity:get` call. @@ -868,11 +868,11 @@ export namespace analyticsreporting_v4 { /** * This token should be passed to [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the next page. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * This field represents the [sampling rate](https://support.google.com/analytics/answer/2637192) for the given request and is a number between 0.0 to 1.0. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ - sampleRate?: number; + sampleRate?: number | null; /** * Each record represents a session (device details, duration, etc). */ @@ -880,7 +880,7 @@ export namespace analyticsreporting_v4 { /** * Total rows returned by this query (across different pages). */ - totalRows?: number; + totalRows?: number | null; } /** * The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city. @@ -893,7 +893,7 @@ export namespace analyticsreporting_v4 { /** * The segment ID of a built-in or custom segment, for example `gaid::-3`. */ - segmentId?: string; + segmentId?: string | null; } /** * SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical `AND` operation. @@ -911,27 +911,27 @@ export namespace analyticsreporting_v4 { /** * Should the match be case sensitive, ignored for `IN_LIST` operator. */ - caseSensitive?: boolean; + caseSensitive?: boolean | null; /** * Name of the dimension for which the filter is being applied. */ - dimensionName?: string; + dimensionName?: string | null; /** * The list of expressions, only the first element is used for all operators */ - expressions?: string[]; + expressions?: string[] | null; /** * Maximum comparison values for `BETWEEN` match type. */ - maxComparisonValue?: string; + maxComparisonValue?: string | null; /** * Minimum comparison values for `BETWEEN` match type. */ - minComparisonValue?: string; + minComparisonValue?: string | null; /** * The operator to use to match the dimension with the expressions. */ - operator?: string; + operator?: string | null; } /** * SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions. @@ -940,7 +940,7 @@ export namespace analyticsreporting_v4 { /** * If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] } }] }] }, "not": "True" }] }, */ - not?: boolean; + not?: boolean | null; /** * Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators. */ @@ -965,7 +965,7 @@ export namespace analyticsreporting_v4 { /** * Matches the complement (`!`) of the filter. */ - not?: boolean; + not?: boolean | null; } /** * Metric filter to be used in a segment filter clause. @@ -974,23 +974,23 @@ export namespace analyticsreporting_v4 { /** * The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value. */ - comparisonValue?: string; + comparisonValue?: string | null; /** * Max comparison value is only used for `BETWEEN` operator. */ - maxComparisonValue?: string; + maxComparisonValue?: string | null; /** * The metric that will be filtered on. A `metricFilter` must contain a metric name. */ - metricName?: string; + metricName?: string | null; /** * Specifies is the operation to perform to compare the metric. The default is `EQUAL`. */ - operator?: string; + operator?: string | null; /** * Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions. */ - scope?: string; + scope?: string | null; } /** * A segment sequence definition. @@ -999,7 +999,7 @@ export namespace analyticsreporting_v4 { /** * Specifies if the step immediately precedes or can be any time before the next step. */ - matchType?: string; + matchType?: string | null; /** * A sequence is specified with a list of Or grouped filters which are combined with `AND` operator. */ @@ -1012,7 +1012,7 @@ export namespace analyticsreporting_v4 { /** * If set, first step condition must match the first hit of the visitor (in the date range). */ - firstStepShouldMatchFirstHit?: boolean; + firstStepShouldMatchFirstHit?: boolean | null; /** * The list of steps in the sequence. */ @@ -1034,19 +1034,19 @@ export namespace analyticsreporting_v4 { /** * The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart. */ - transactionId?: string; + transactionId?: string | null; /** * The total sale revenue (excluding shipping and tax) of the transaction. */ - transactionRevenue?: number; + transactionRevenue?: number | null; /** * Total cost of shipping. */ - transactionShipping?: number; + transactionShipping?: number | null; /** * Total tax for the transaction. */ - transactionTax?: number; + transactionTax?: number | null; } /** * Contains information to identify a particular user uniquely. @@ -1055,11 +1055,11 @@ export namespace analyticsreporting_v4 { /** * Type of the user in the request. The field `userId` is associated with this type. */ - type?: string; + type?: string | null; /** * Unique Id of the user for which the data is being requested. */ - userId?: string; + userId?: string | null; } /** * This represents a user session performed on a specific device at a certain time over a period of time. @@ -1072,23 +1072,23 @@ export namespace analyticsreporting_v4 { /** * The data source of a hit. By default, hits sent from analytics.js are reported as "web" and hits sent from the mobile SDKs are reported as "app". These values can be overridden in the Measurement Protocol. */ - dataSource?: string; + dataSource?: string | null; /** * The type of device used: "mobile", "tablet" etc. */ - deviceCategory?: string; + deviceCategory?: string | null; /** * Platform on which the activity happened: "android", "ios" etc. */ - platform?: string; + platform?: string | null; /** * Date of this session in ISO-8601 format. */ - sessionDate?: string; + sessionDate?: string | null; /** * Unique ID of the session. */ - sessionId?: string; + sessionId?: string | null; } export class Resource$Reports { diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index f08a6038bcb..39ed49c1bf6 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -128,7 +128,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The ID of the customer for whom the device is being claimed. */ - customerId?: string; + customerId?: string | null; /** * Required. The device identifier of the device to claim. */ @@ -140,7 +140,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The section type of the device's provisioning record. */ - sectionType?: string; + sectionType?: string | null; } /** * Response message containing device id of the claim. @@ -149,11 +149,11 @@ export namespace androiddeviceprovisioning_v1 { /** * The device ID of the claimed device. */ - deviceId?: string; + deviceId?: string | null; /** * The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. */ - deviceName?: string; + deviceName?: string | null; } /** * Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal. @@ -171,27 +171,27 @@ export namespace androiddeviceprovisioning_v1 { /** * Optional. Input only. Email address of customer's users in the admin role. Each email address must be associated with a Google Account. */ - adminEmails?: string[]; + adminEmails?: string[] | null; /** * Output only. The ID of the company. Assigned by the server. */ - companyId?: string; + companyId?: string | null; /** * Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal. */ - companyName?: string; + companyName?: string | null; /** * Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. */ - name?: string; + name?: string | null; /** * Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. */ - ownerEmails?: string[]; + ownerEmails?: string[] | null; /** * Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus. */ - termsStatus?: string; + termsStatus?: string | null; } /** * A configuration collects the provisioning options for Android devices. Each configuration combines the following: * The EMM device policy controller (DPC) installed on the devices. * EMM policies enforced on the devices. * Metadata displayed on the device to help users during setup. Customers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases. @@ -200,43 +200,43 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning. */ - companyName?: string; + companyName?: string | null; /** * Output only. The ID of the configuration. Assigned by the server. */ - configurationId?: string; + configurationId?: string | null; /** * Required. A short name that describes the configuration's purpose. For example, _Sales team_ or _Temporary employees_. The zero-touch enrollment portal displays this name to IT admins. */ - configurationName?: string; + configurationName?: string | null; /** * Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input. */ - contactEmail?: string; + contactEmail?: string | null; /** * Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses. */ - contactPhone?: string; + contactPhone?: string | null; /** * A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned. */ - customMessage?: string; + customMessage?: string | null; /** * The JSON-formatted EMM provisioning extras that are passed to the DPC. */ - dpcExtras?: string; + dpcExtras?: string | null; /** * Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/x. To list the supported DPCs, call `customers.dpcs.list`. */ - dpcResourcePath?: string; + dpcResourcePath?: string | null; /** * Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`. */ - isDefault?: boolean; + isDefault?: boolean | null; /** * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server. */ - name?: string; + name?: string | null; } /** * Request message to create a customer. @@ -254,7 +254,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. */ - configuration?: string; + configuration?: string | null; /** * Required. The device the configuration is applied to. */ @@ -280,7 +280,7 @@ export namespace androiddeviceprovisioning_v1 { /** * A token used to access the next page of results. Omitted if no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message of customer's liting devices. @@ -293,7 +293,7 @@ export namespace androiddeviceprovisioning_v1 { /** * A token used to access the next page of results. Omitted if no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message of customer's listing DPCs. @@ -333,11 +333,11 @@ export namespace androiddeviceprovisioning_v1 { /** * Not available to resellers. */ - configuration?: string; + configuration?: string | null; /** * Output only. The ID of the device. Assigned by the server. */ - deviceId?: string; + deviceId?: string | null; /** * The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](/zero-touch/guides/identifiers). */ @@ -349,7 +349,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. */ - name?: string; + name?: string | null; } /** * A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim). @@ -358,23 +358,23 @@ export namespace androiddeviceprovisioning_v1 { /** * The ID of the Customer that purchased the device. */ - ownerCompanyId?: string; + ownerCompanyId?: string | null; /** * The ID of the reseller that claimed the device. */ - resellerId?: string; + resellerId?: string | null; /** * Output only. The type of claim made on the device. */ - sectionType?: string; + sectionType?: string | null; /** * The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'. */ - vacationModeExpireTime?: string; + vacationModeExpireTime?: string | null; /** * The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'. */ - vacationModeStartTime?: string; + vacationModeStartTime?: string | null; } /** * Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](/zero-touch/guides/identifiers). @@ -383,23 +383,23 @@ export namespace androiddeviceprovisioning_v1 { /** * The device’s IMEI number. Validated on input. */ - imei?: string; + imei?: string | null; /** * The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). */ - manufacturer?: string; + manufacturer?: string | null; /** * The device’s MEID number. */ - meid?: string; + meid?: string | null; /** * The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). */ - model?: string; + model?: string | null; /** * The manufacturer's serial number for the device. This value might not be unique across different device models. */ - serialNumber?: string; + serialNumber?: string | null; } /** * Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](/zero-touch/guides/metadata). @@ -408,7 +408,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Metadata entries recorded as key-value pairs. */ - entries?: {[key: string]: string}; + entries?: {[key: string]: string} | null; } /** * A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](/zero-touch/guides/identifiers). @@ -417,7 +417,7 @@ export namespace androiddeviceprovisioning_v1 { /** * The ID of the device. */ - deviceId?: string; + deviceId?: string | null; /** * The hardware IDs of the device. */ @@ -430,15 +430,15 @@ export namespace androiddeviceprovisioning_v1 { /** * The number of metadata updates in the operation. This might be different from the number of updates in the request if the API can't parse some of the updates. */ - devicesCount?: number; + devicesCount?: number | null; /** * The processing status of the operation. */ - processingStatus?: string; + processingStatus?: string | null; /** * The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesnt always mean the operation completed—check for the inclusion of a `done` field. */ - progress?: number; + progress?: number | null; } /** * Tracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). @@ -451,7 +451,7 @@ export namespace androiddeviceprovisioning_v1 { /** * A summary of how many items in the operation the server processed successfully. Updated as the operation progresses. */ - successCount?: number; + successCount?: number | null; } /** * An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a device to maintain the customer's mobile policies. All the DPCs listed by the API support zero-touch enrollment and are available in Google Play. @@ -460,15 +460,15 @@ export namespace androiddeviceprovisioning_v1 { /** * Output only. The title of the DPC app in Google Play. For example, _Google Apps Device Policy_. Useful in an application's user interface. */ - dpcName?: string; + dpcName?: string | null; /** * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across customer accounts, persist and match the last path component (`DPC_ID`). */ - name?: string; + name?: string | null; /** * Output only. The DPC's Android application ID that looks like a Java package name. Zero-touch enrollment installs the DPC app onto a device using this identifier. */ - packageName?: string; + packageName?: 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 `{}`. @@ -485,11 +485,11 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. */ - limit?: string; + limit?: string | null; /** * A token specifying which result page to return. */ - pageToken?: string; + pageToken?: string | null; } /** * Response containing found devices. @@ -502,11 +502,11 @@ export namespace androiddeviceprovisioning_v1 { /** * A token used to access the next page of results. Omitted if no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total count of items in the list irrespective of pagination. */ - totalSize?: number; + totalSize?: number | null; } /** * Request to find devices by customers. @@ -515,19 +515,19 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The list of customer IDs to search for. */ - customerId?: string[]; + customerId?: string[] | null; /** * Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. */ - limit?: string; + limit?: string | null; /** * A token specifying which result page to return. */ - pageToken?: string; + pageToken?: string | null; /** * Required. The section type of the device's provisioning record. */ - sectionType?: string; + sectionType?: string | null; } /** * Response containing found devices. @@ -540,11 +540,11 @@ export namespace androiddeviceprovisioning_v1 { /** * A token used to access the next page of results. Omitted if no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total count of items in the list irrespective of pagination. */ - totalSize?: number; + totalSize?: number | null; } /** * Response message of all customers related to this partner. @@ -557,11 +557,11 @@ export namespace androiddeviceprovisioning_v1 { /** * A token to retrieve the next page of results. Omitted if no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total count of items in the list irrespective of pagination. */ - totalSize?: number; + totalSize?: number | null; } /** * Response message to list customers of the vendor. @@ -574,11 +574,11 @@ export namespace androiddeviceprovisioning_v1 { /** * A token to retrieve the next page of results. Omitted if no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total count of items in the list irrespective of pagination. */ - totalSize?: number; + totalSize?: number | null; } /** * Response message to list vendors of the partner. @@ -587,11 +587,11 @@ export namespace androiddeviceprovisioning_v1 { /** * A token to retrieve the next page of results. Omitted if no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total count of items in the list irrespective of pagination. */ - totalSize?: number; + totalSize?: number | null; /** * List of vendors of the reseller partner. Fields `name`, `companyId` and `companyName` are populated to the Company object. */ @@ -604,7 +604,7 @@ export namespace androiddeviceprovisioning_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`. */ @@ -612,15 +612,15 @@ export namespace androiddeviceprovisioning_v1 { /** * This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A task for each device in the operation. Corresponds to each device change in the request. @@ -650,7 +650,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The ID of the customer for whom the device is being claimed. */ - customerId?: string; + customerId?: string | null; /** * Required. Device identifier of the device. */ @@ -662,7 +662,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The section type of the device's provisioning record. */ - sectionType?: string; + sectionType?: string | null; } /** * Identifies one unclaim request. @@ -671,7 +671,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Device ID of the device. */ - deviceId?: string; + deviceId?: string | null; /** * Device identifier of the device. */ @@ -679,15 +679,15 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The section type of the device's provisioning record. */ - sectionType?: string; + sectionType?: string | null; /** * The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours) */ - vacationModeDays?: number; + vacationModeDays?: number | null; /** * The expiration time of the vacation unlock. */ - vacationModeExpireTime?: string; + vacationModeExpireTime?: string | null; } /** * Captures the processing status for each device in the operation. @@ -696,19 +696,19 @@ export namespace androiddeviceprovisioning_v1 { /** * If processing succeeds, the device ID of the device. */ - deviceId?: string; + deviceId?: string | null; /** * If processing fails, the error type. */ - errorIdentifier?: string; + errorIdentifier?: string | null; /** * If processing fails, a developer message explaining what went wrong. */ - errorMessage?: string; + errorMessage?: string | null; /** * The result status of the device after processing. */ - status?: string; + status?: 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). @@ -717,15 +717,15 @@ export namespace androiddeviceprovisioning_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message to unclaim a device. @@ -734,7 +734,7 @@ export namespace androiddeviceprovisioning_v1 { /** * The device ID returned by `ClaimDevice`. */ - deviceId?: string; + deviceId?: string | null; /** * The device identifier you used when you claimed this device. */ @@ -742,15 +742,15 @@ export namespace androiddeviceprovisioning_v1 { /** * Required. The section type of the device's provisioning record. */ - sectionType?: string; + sectionType?: string | null; /** * The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours) */ - vacationModeDays?: number; + vacationModeDays?: number | null; /** * The expiration time of the vacation unlock. */ - vacationModeExpireTime?: string; + vacationModeExpireTime?: string | null; } /** * Request to unclaim devices asynchronously in batch. @@ -786,7 +786,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Device ID of the device. */ - deviceId?: string; + deviceId?: string | null; /** * Device identifier. */ diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 627d479f29b..4da8a83e95d 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -144,7 +144,7 @@ export namespace androidenterprise_v1 { /** * The admin's email address. */ - email?: string; + email?: string | null; } /** * A token authorizing an admin to access an iframe. @@ -153,11 +153,11 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebToken". */ - kind?: string; + kind?: string | null; /** * An opaque token to be passed to the Play front-end to generate an iframe. */ - token?: string; + token?: string | null; } /** * 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. @@ -166,7 +166,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebTokenSpec". */ - kind?: string; + kind?: string | null; /** * Options for displaying the Managed Configuration page. */ @@ -174,11 +174,11 @@ export namespace androidenterprise_v1 { /** * The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https. Use whitespaces to separate multiple parent URIs. */ - parent?: string; + parent?: string | null; /** * Deprecated. Use PlaySearch.approveApps. */ - permission?: string[]; + permission?: string[] | null; /** * Options for displaying the managed Play Search apps page. */ @@ -200,35 +200,35 @@ export namespace androidenterprise_v1 { /** * Whether the Managed Configuration page is displayed. Default is true. */ - enabled?: boolean; + enabled?: boolean | null; } export interface Schema$AdministratorWebTokenSpecPlaySearch { /** * Allow access to the iframe in approve mode. Default is false. */ - approveApps?: boolean; + approveApps?: boolean | null; /** * Whether the managed Play Search apps page is displayed. Default is true. */ - enabled?: boolean; + enabled?: boolean | null; } export interface Schema$AdministratorWebTokenSpecPrivateApps { /** * Whether the Private Apps page is displayed. Default is true. */ - enabled?: boolean; + enabled?: boolean | null; } export interface Schema$AdministratorWebTokenSpecStoreBuilder { /** * Whether the Organize apps page is displayed. Default is true. */ - enabled?: boolean; + enabled?: boolean | null; } export interface Schema$AdministratorWebTokenSpecWebApps { /** * Whether the Web Apps page is displayed. Default is true. */ - enabled?: boolean; + enabled?: boolean | null; } /** * Represents the list of app restrictions available to be pre-configured for the product. @@ -237,7 +237,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema". */ - kind?: string; + kind?: string | null; /** * The set of restrictions that make up this schema. */ @@ -250,7 +250,7 @@ export namespace androidenterprise_v1 { /** * The id of the product (e.g. "app:com.google.android.gm") for which the app restriction schema changed. This field will always be present. */ - productId?: string; + productId?: string | null; } /** * A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied. @@ -263,19 +263,19 @@ export namespace androidenterprise_v1 { /** * A longer description of the restriction, giving more detail of what it affects. */ - description?: string; + description?: string | null; /** * For choice or multiselect restrictions, the list of possible entries' human-readable names. */ - entry?: string[]; + entry?: string[] | null; /** * For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction. */ - entryValue?: string[]; + entryValue?: string[] | null; /** * The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname". */ - key?: string; + key?: string | null; /** * For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep. */ @@ -283,11 +283,11 @@ export namespace androidenterprise_v1 { /** * The type of the restriction. */ - restrictionType?: string; + restrictionType?: string | null; /** * The name of the restriction. */ - title?: string; + title?: string | null; } /** * A typed value for the restriction. @@ -296,23 +296,23 @@ export namespace androidenterprise_v1 { /** * The type of the value being provided. */ - type?: string; + type?: string | null; /** * The boolean value - this will only be present if type is bool. */ - valueBool?: boolean; + valueBool?: boolean | null; /** * The integer value - this will only be present if type is integer. */ - valueInteger?: number; + valueInteger?: number | null; /** * The list of string values - this will only be present if type is multiselect. */ - valueMultiselect?: string[]; + valueMultiselect?: string[] | null; /** * The string value - this will be present for types string, choice and hidden. */ - valueString?: string; + valueString?: string | null; } /** * Information on an approval URL. @@ -321,11 +321,11 @@ 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; + approvalUrl?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo". */ - kind?: string; + kind?: string | null; } /** * List of states set by the app. @@ -338,7 +338,7 @@ export namespace androidenterprise_v1 { /** * The package name of the app. This field will always be present. */ - packageName?: string; + packageName?: string | null; } /** * An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API. @@ -347,7 +347,7 @@ export namespace androidenterprise_v1 { /** * The id of the product (e.g. "app:com.google.android.gm") that was updated. This field will always be present. */ - productId?: string; + productId?: string | null; } /** * This represents a single version of the app. @@ -356,23 +356,23 @@ export namespace androidenterprise_v1 { /** * True if this version is a production APK. */ - isProduction?: boolean; + isProduction?: boolean | null; /** * Deprecated, use trackId instead. */ - track?: string; + track?: string | null; /** * Track ids that the app version is published in. Replaces the track field (deprecated), but doesn't include the production track (see isProduction instead). */ - trackId?: string[]; + trackId?: string[] | null; /** * Unique increasing identifier for the app version. */ - versionCode?: number; + versionCode?: number | null; /** * The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4"). */ - versionString?: string; + versionString?: string | null; } /** * An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device. @@ -381,11 +381,11 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken". */ - kind?: string; + 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. */ - token?: string; + token?: string | null; } /** * The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set. @@ -394,15 +394,15 @@ export namespace androidenterprise_v1 { /** * Charging state constraint. */ - chargingStateConstraint?: string; + chargingStateConstraint?: string | null; /** * Device idle state constraint. */ - deviceIdleStateConstraint?: string; + deviceIdleStateConstraint?: string | null; /** * Network type constraint. */ - networkTypeConstraint?: string; + networkTypeConstraint?: string | null; } export interface Schema$AutoInstallPolicy { /** @@ -412,15 +412,15 @@ export namespace androidenterprise_v1 { /** * The auto-install mode. If unset defaults to "doNotAutoInstall". */ - autoInstallMode?: string; + autoInstallMode?: string | null; /** * The priority of the install, as an unsigned integer. A lower number means higher priority. */ - autoInstallPriority?: number; + 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. */ - minimumVersionCode?: number; + minimumVersionCode?: number | null; } /** * 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. @@ -429,11 +429,11 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables". */ - kind?: string; + kind?: string | null; /** * The ID of the managed configurations settings. */ - mcmId?: string; + mcmId?: string | null; /** * The variable set that is attributed to the user. */ @@ -446,15 +446,15 @@ export namespace androidenterprise_v1 { /** * The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0". */ - androidId?: string; + androidId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device". */ - kind?: string; + 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. */ - managementType?: string; + managementType?: string | null; /** * The policy enforced on the device. */ @@ -475,7 +475,7 @@ export namespace androidenterprise_v1 { /** * The timestamp of the last report update in milliseconds since epoch. This field will always be present. */ - lastUpdatedTimestampMillis?: string; + lastUpdatedTimestampMillis?: string | null; } /** * An event generated when an updated device report is available. @@ -484,7 +484,7 @@ export namespace androidenterprise_v1 { /** * The Android ID of the device. This field will always be present. */ - deviceId?: string; + deviceId?: string | null; /** * The device report updated with the latest app states. This field will always be present. */ @@ -492,7 +492,7 @@ export namespace androidenterprise_v1 { /** * The ID of the user. This field will always be present. */ - userId?: string; + userId?: string | null; } /** * The device resources for the user. @@ -505,7 +505,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse". */ - kind?: string; + kind?: string | null; } /** * The state of a user's device, as accessed by the getState and setState methods on device resources. @@ -514,11 +514,11 @@ 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; + accountState?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState". */ - kind?: string; + kind?: string | null; } /** * An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. @@ -531,19 +531,19 @@ export namespace androidenterprise_v1 { /** * The unique ID for the enterprise. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". */ - kind?: string; + kind?: string | null; /** * The name of the enterprise, for example, "Example, Inc". */ - name?: string; + name?: string | null; /** * The enterprise's primary domain, such as "example.com". */ - primaryDomain?: string; + primaryDomain?: string | null; } /** * A service account that can be used to authenticate as the enterprise to API calls that require such authentication. @@ -552,11 +552,11 @@ export namespace androidenterprise_v1 { /** * The email address of the service account. */ - accountEmail?: string; + accountEmail?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount". */ - kind?: string; + kind?: string | null; } /** * The matching enterprise resources. @@ -569,17 +569,17 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$EnterprisesSendTestPushNotificationResponse { /** * The message ID of the test push notification that was sent. */ - messageId?: string; + messageId?: string | null; /** * The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent. */ - topicName?: string; + topicName?: string | null; } /** * 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. @@ -588,15 +588,15 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". */ - kind?: string; + kind?: string | null; /** * The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". */ - productId?: string; + productId?: string | null; /** * The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. */ - reason?: string; + reason?: string | null; } /** * The entitlement resources for the user. @@ -609,7 +609,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse". */ - kind?: string; + kind?: string | null; } /** * Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product. @@ -618,31 +618,31 @@ export namespace androidenterprise_v1 { /** * How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products). */ - acquisitionKind?: string; + acquisitionKind?: string | null; /** * 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; + approval?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense". */ - kind?: string; + kind?: string | null; /** * The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. */ - numProvisioned?: number; + numProvisioned?: number | null; /** * The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is "free"). */ - numPurchased?: number; + numPurchased?: number | null; /** * The permission approval status of the product. This field is only set if the product is approved. Possible states are: - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.), - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review. */ - permissions?: string; + permissions?: string | null; /** * The ID of the product that the license is for. For example, "app:com.google.android.gm". */ - productId?: string; + productId?: string | null; } /** * The grouplicense resources for the enterprise. @@ -655,7 +655,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicensesListResponse". */ - kind?: string; + kind?: string | null; } /** * The user resources for the group license. @@ -664,7 +664,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicenseUsersListResponse". */ - kind?: string; + kind?: string | null; /** * A user of an enterprise. */ @@ -677,19 +677,19 @@ 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; + installState?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". */ - kind?: string; + kind?: string | null; /** * The ID of the product that the install is for. For example, "app:com.google.android.gm". */ - productId?: string; + productId?: string | null; /** * The version of the installed product. Guaranteed to be set only if the install state is "installed". */ - versionCode?: number; + versionCode?: number | null; } /** * An event generated when an app installation failed on a device @@ -698,23 +698,23 @@ export namespace androidenterprise_v1 { /** * The Android ID of the device. This field will always be present. */ - deviceId?: string; + deviceId?: string | null; /** * Additional details on the failure if applicable. */ - failureDetails?: string; + failureDetails?: string | null; /** * The reason for the installation failure. This field will always be present. */ - failureReason?: string; + failureReason?: string | null; /** * The id of the product (e.g. "app:com.google.android.gm") for which the install failure event occured. This field will always be present. */ - productId?: string; + productId?: string | null; /** * The ID of the user. This field will always be present. */ - userId?: string; + userId?: string | null; } /** * The install resources for the device. @@ -727,7 +727,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse". */ - kind?: string; + kind?: string | null; } /** * Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data. @@ -736,23 +736,23 @@ export namespace androidenterprise_v1 { /** * Additional field intended for machine-readable data. For example, a number or JSON object. To prevent XSS, we recommend removing any HTML from the data before displaying it. */ - data?: string; + data?: string | null; /** * Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present. */ - key?: string; + key?: string | null; /** * Free-form, human-readable message describing the app state. For example, an error message. To prevent XSS, we recommend removing any HTML from the message before displaying it. */ - message?: string; + message?: string | null; /** * Severity of the app state. This field will always be present. */ - severity?: string; + severity?: string | null; /** * Timestamp of when the app set the state in milliseconds since epoch. This field will always be present. */ - stateTimestampMillis?: string; + stateTimestampMillis?: string | null; } /** * A localized string with its locale. @@ -761,11 +761,11 @@ export namespace androidenterprise_v1 { /** * The BCP47 tag for a locale. (e.g. "en-US", "de"). */ - locale?: string; + locale?: string | null; /** * The text localized in the associated locale. */ - text?: string; + text?: string | null; } /** * Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window. @@ -774,11 +774,11 @@ export namespace androidenterprise_v1 { /** * Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive). */ - durationMs?: string; + durationMs?: string | null; /** * Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight. */ - startTimeAfterMidnightMs?: string; + startTimeAfterMidnightMs?: string | null; } /** * A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. @@ -791,7 +791,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". */ - kind?: string; + kind?: string | null; /** * The set of managed properties for this configuration. */ @@ -799,7 +799,7 @@ export namespace androidenterprise_v1 { /** * The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". */ - productId?: string; + productId?: string | null; } /** * The managed configuration resources for the device. @@ -808,7 +808,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForDeviceListResponse". */ - kind?: string; + kind?: string | null; /** * A managed configuration for an app on a specific device. */ @@ -821,7 +821,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForUserListResponse". */ - kind?: string; + kind?: string | null; /** * A managed configuration for an app for a specific user. */ @@ -834,23 +834,19 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsSettings". */ - kind?: string; + kind?: string | null; /** * The last updated time of the managed configuration settings in milliseconds since 1970-01-01T00:00:00Z. */ - lastUpdatedTimestampMillis?: string; - /** - * The set of managed properties for this configuration. - */ - managedProperty?: Schema$ManagedProperty[]; + lastUpdatedTimestampMillis?: string | null; /** * The ID of the managed configurations settings. */ - mcmId?: string; + mcmId?: string | null; /** * The name of the managed configurations settings. */ - name?: string; + name?: string | null; } /** * The managed configurations settings for a product. @@ -859,7 +855,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsSettingsListResponse". */ - kind?: string; + kind?: string | null; /** * A managed configurations settings for an app that may be assigned to a group of users in an enterprise. */ @@ -872,11 +868,11 @@ export namespace androidenterprise_v1 { /** * The unique key that identifies the property. */ - key?: string; + key?: string | null; /** * The boolean value - this will only be present if type of the property is bool. */ - valueBool?: boolean; + valueBool?: boolean | null; /** * The bundle of managed properties - this will only be present if type of the property is bundle. */ @@ -888,15 +884,15 @@ export namespace androidenterprise_v1 { /** * The integer value - this will only be present if type of the property is integer. */ - valueInteger?: number; + valueInteger?: number | null; /** * The string value - this will only be present if type of the property is string, choice or hidden. */ - valueString?: string; + valueString?: string | null; /** * The list of string values - this will only be present if type of the property is multiselect. */ - valueStringArray?: string[]; + valueStringArray?: string[] | null; } /** * A bundle of managed properties. @@ -914,19 +910,19 @@ export namespace androidenterprise_v1 { /** * The Android ID of the device. This field will always be present. */ - deviceId?: string; + deviceId?: string | null; /** * Policy app on the device. */ - dpcPackageName?: string; + dpcPackageName?: string | null; /** * Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations. Possible values include: - "managedDevice", a device where the DPC is set as device owner, - "managedProfile", a device where the DPC is set as profile owner. */ - managementType?: string; + managementType?: string | null; /** * The ID of the user. This field will always be present. */ - userId?: string; + userId?: string | null; } /** * An event generated when new permissions are added to an app. @@ -935,15 +931,15 @@ export namespace androidenterprise_v1 { /** * The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions. */ - approvedPermissions?: string[]; + approvedPermissions?: string[] | null; /** * The id of the product (e.g. "app:com.google.android.gm") for which new permissions were added. This field will always be present. */ - productId?: string; + productId?: string | null; /** * The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions. */ - requestedPermissions?: string[]; + requestedPermissions?: string[] | null; } /** * A notification of one event relating to an enterprise. @@ -964,7 +960,7 @@ export namespace androidenterprise_v1 { /** * The ID of the enterprise for which the notification is sent. This will always be present. */ - enterpriseId?: string; + enterpriseId?: string | null; /** * Notifications about an app installation failure. */ @@ -980,7 +976,7 @@ export namespace androidenterprise_v1 { /** * Type of the notification. */ - notificationType?: string; + notificationType?: string | null; /** * Notifications about changes to a product's approval status. */ @@ -992,7 +988,7 @@ export namespace androidenterprise_v1 { /** * The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present. */ - timestampMillis?: string; + timestampMillis?: string | null; } /** * A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request. @@ -1001,7 +997,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#notificationSet". */ - kind?: string; + kind?: string | null; /** * The notifications received, or empty if no notifications are present. */ @@ -1009,12 +1005,12 @@ export namespace androidenterprise_v1 { /** * The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present. */ - notificationSetId?: string; + notificationSetId?: string | null; } export interface Schema$PageInfo { - resultPerPage?: number; - startIndex?: number; - totalResults?: number; + resultPerPage?: number | null; + startIndex?: number | null; + totalResults?: number | null; } /** * A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise. @@ -1023,19 +1019,19 @@ export namespace androidenterprise_v1 { /** * A longer description of the Permissions resource, giving more details of what it affects. */ - description?: string; + description?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission". */ - kind?: string; + kind?: string | null; /** * The name of the permission. */ - name?: string; + name?: string | null; /** * An opaque string uniquely identifying the permission. */ - permissionId?: string; + permissionId?: string | null; } /** * The device policy for a given managed device. @@ -1044,11 +1040,11 @@ export namespace androidenterprise_v1 { /** * The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi. */ - autoUpdatePolicy?: string; + autoUpdatePolicy?: string | null; /** * Whether the device reports app states to the EMM. The default value is "deviceReportDisabled". */ - deviceReportPolicy?: string; + deviceReportPolicy?: string | null; /** * The maintenance window defining when apps running in the foreground should be updated. */ @@ -1056,7 +1052,7 @@ export namespace androidenterprise_v1 { /** * The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default. */ - productAvailabilityPolicy?: string; + productAvailabilityPolicy?: string | null; /** * The list of product policies. */ @@ -1077,51 +1073,51 @@ export namespace androidenterprise_v1 { /** * The name of the author of the product (for example, the app developer). */ - authorName?: string; + authorName?: string | null; /** * The countries which this app is available in. */ - availableCountries?: string[]; + availableCountries?: string[] | null; /** * Deprecated, use appTracks instead. */ - availableTracks?: string[]; + availableTracks?: string[] | null; /** * The app category (e.g. RACING, SOCIAL, etc.) */ - category?: string; + category?: string | null; /** * The content rating for this app. */ - contentRating?: string; + contentRating?: string | null; /** * The localized promotional description, if available. */ - description?: string; + description?: string | null; /** * A link to the (consumer) Google Play details page for the product. */ - detailsUrl?: string; + detailsUrl?: string | null; /** * How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted. */ - distributionChannel?: string; + distributionChannel?: string | null; /** * A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px. */ - iconUrl?: string; + iconUrl?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product". */ - kind?: string; + kind?: string | null; /** * The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch. */ - lastUpdatedTimestampMillis?: string; + lastUpdatedTimestampMillis?: string | null; /** * The minimum Android SDK necessary to run the app. */ - minAndroidSdkVersion?: number; + minAndroidSdkVersion?: number | null; /** * A list of permissions required by the app. */ @@ -1129,23 +1125,23 @@ export namespace androidenterprise_v1 { /** * A string of the form app:<package name>. For example, app:com.google.android.gm represents the Gmail app. */ - productId?: string; + productId?: string | null; /** * Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it). */ - productPricing?: string; + productPricing?: string | null; /** * A description of the recent changes made to the app. */ - recentChanges?: string; + recentChanges?: string | null; /** * Deprecated. */ - requiresContainerApp?: boolean; + requiresContainerApp?: boolean | null; /** * A list of screenshot links representing the app. */ - screenshotUrls?: string[]; + screenshotUrls?: string[] | null; /** * The certificate used to sign this product. */ @@ -1153,15 +1149,15 @@ export namespace androidenterprise_v1 { /** * A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px. */ - smallIconUrl?: string; + smallIconUrl?: string | null; /** * The name of the product. */ - title?: string; + title?: string | null; /** * A link to the managed Google Play details page for the product, for use by an Enterprise admin. */ - workDetailsUrl?: string; + workDetailsUrl?: string | null; } /** * An event generated when a product's approval status is changed. @@ -1170,11 +1166,11 @@ export namespace androidenterprise_v1 { /** * Whether the product was approved or unapproved. This field will always be present. */ - approved?: string; + approved?: string | null; /** * The id of the product (e.g. "app:com.google.android.gm") for which the approval status has changed. This field will always be present. */ - productId?: string; + productId?: string | null; } /** * An event generated whenever a product's availability changes. @@ -1183,11 +1179,11 @@ export namespace androidenterprise_v1 { /** * The new state of the product. This field will always be present. */ - availabilityStatus?: string; + availabilityStatus?: string | null; /** * The id of the product (e.g. "app:com.google.android.gm") for which the product availability changed. This field will always be present. */ - productId?: string; + productId?: string | null; } /** * A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted. @@ -1196,11 +1192,11 @@ export namespace androidenterprise_v1 { /** * An opaque string uniquely identifying the permission. */ - permissionId?: string; + permissionId?: string | null; /** * Whether the permission has been accepted or not. */ - state?: string; + state?: string | null; } /** * Information about the permissions required by a specific app and whether they have been accepted by the enterprise. @@ -1209,7 +1205,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions". */ - kind?: string; + kind?: string | null; /** * The permissions required by the app. */ @@ -1217,7 +1213,7 @@ export namespace androidenterprise_v1 { /** * The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm". */ - productId?: string; + productId?: string | null; } /** * The policy for a product. @@ -1234,15 +1230,15 @@ export namespace androidenterprise_v1 { /** * The ID of the product. For example, "app:com.google.android.gm". */ - productId?: string; + productId?: string | null; /** * Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get. */ - trackIds?: string[]; + trackIds?: string[] | null; /** * Deprecated. Use trackIds instead. */ - tracks?: string[]; + tracks?: string[] | null; } export interface Schema$ProductsApproveRequest { /** @@ -1252,7 +1248,7 @@ export namespace androidenterprise_v1 { /** * Sets how new permission requests for the product are handled. "allPermissions" automatically approves all current and future permissions for the product. "currentPermissionsOnly" approves the current set of permissions for the product, but any future permissions added through updates will require manual reapproval. If not specified, only the current set of permissions will be approved. */ - approvedPermissions?: string; + approvedPermissions?: string | null; } /** * A set of products. @@ -1261,15 +1257,15 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet". */ - kind?: string; + kind?: string | null; /** * The list of product IDs making up the set of products. */ - productId?: string[]; + productId?: string[] | null; /** * The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user. */ - productSetBehavior?: string; + productSetBehavior?: string | null; /** * Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error. */ @@ -1279,17 +1275,17 @@ export namespace androidenterprise_v1 { /** * A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted. */ - url?: string; + url?: string | null; } export interface Schema$ProductSigningCertificate { /** * The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.) */ - certificateHashSha1?: string; + certificateHashSha1?: string | null; /** * The base64 urlsafe encoded SHA2-256 hash of the certificate. */ - certificateHashSha256?: string; + certificateHashSha256?: string | null; } /** * The matching products. @@ -1298,7 +1294,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse". */ - kind?: string; + kind?: string | null; /** * General pagination information. */ @@ -1319,15 +1315,15 @@ export namespace androidenterprise_v1 { /** * The product ID to make visible to the user. Required for each item in the productVisibility list. */ - productId?: string; + productId?: string | null; /** * Grants the user visibility to the specified product track(s), identified by trackIds. */ - trackIds?: string[]; + trackIds?: string[] | null; /** * Deprecated. Use trackIds instead. */ - tracks?: string[]; + tracks?: string[] | null; } /** * A service account identity, including the name and credentials that can be used to authenticate as the service account. @@ -1340,11 +1336,11 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccount". */ - kind?: string; + kind?: string | null; /** * The account name of the service account, in the form of an email address. Assigned by the server. */ - name?: string; + name?: string | null; } /** * Credentials that can be used to authenticate as a service account. @@ -1353,23 +1349,23 @@ export namespace androidenterprise_v1 { /** * The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. */ - data?: string; + data?: string | null; /** * An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey". */ - kind?: string; + 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. */ - publicData?: string; + publicData?: string | null; /** * The file format of the generated key data. */ - type?: string; + type?: string | null; } export interface Schema$ServiceAccountKeysListResponse { /** @@ -1384,15 +1380,15 @@ 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; + completionToken?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#signupInfo". */ - kind?: string; + 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. */ - url?: string; + url?: string | null; } /** * Definition of a managed Google Play store cluster, a list of products displayed as part of a store page. @@ -1401,11 +1397,11 @@ export namespace androidenterprise_v1 { /** * Unique ID of this cluster. Assigned by the server. Immutable once assigned. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". */ - kind?: string; + 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. */ @@ -1413,11 +1409,11 @@ export namespace androidenterprise_v1 { /** * String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. */ - orderInPage?: string; + orderInPage?: string | null; /** * List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. */ - productId?: string[]; + productId?: string[] | null; } /** * General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened. @@ -1426,15 +1422,15 @@ 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; + homepageId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout". */ - kind?: string; + 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. */ - storeLayoutType?: string; + storeLayoutType?: string | null; } /** * The store page resources for the enterprise. @@ -1447,7 +1443,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse". */ - kind?: string; + kind?: string | null; } /** * The store page resources for the enterprise. @@ -1456,7 +1452,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutPagesListResponse". */ - kind?: string; + kind?: string | null; /** * A store page of an enterprise. */ @@ -1469,23 +1465,23 @@ export namespace androidenterprise_v1 { /** * Unique ID of this page. Assigned by the server. Immutable once assigned. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage". */ - kind?: string; + 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. */ - link?: string[]; + link?: 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. */ name?: Schema$LocalizedText[]; } export interface Schema$TokenPagination { - nextPageToken?: string; - previousPageToken?: string; + nextPageToken?: string | null; + previousPageToken?: string | null; } /** * Id to name association of a track. @@ -1494,11 +1490,11 @@ export namespace androidenterprise_v1 { /** * A modifiable name for a track. This is the visible name in the play developer console. */ - trackAlias?: string; + trackAlias?: string | null; /** * Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the track information. */ - trackId?: string; + trackId?: string | null; } /** * A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play. @@ -1507,31 +1503,31 @@ export namespace androidenterprise_v1 { /** * A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. */ - accountIdentifier?: string; + accountIdentifier?: string | null; /** * The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. */ - accountType?: string; + accountType?: string | null; /** * The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. */ - displayName?: string; + displayName?: string | null; /** * The unique ID for the user. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". */ - kind?: string; + 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. */ - managementType?: string; + managementType?: string | null; /** * The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. */ - primaryEmail?: string; + primaryEmail?: string | null; } /** * The matching user resources. @@ -1540,7 +1536,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse". */ - kind?: string; + kind?: string | null; /** * A user of an enterprise. */ @@ -1553,15 +1549,15 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken". */ - kind?: string; + 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. */ - token?: string; + token?: string | null; /** * The unique ID for the user. */ - userId?: string; + userId?: string | null; } /** * 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. @@ -1570,15 +1566,15 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet". */ - kind?: string; + kind?: string | null; /** * The placeholder string; defined by EMM. */ - placeholder?: string; + placeholder?: string | null; /** * The value of the placeholder, specific to the user. */ - userValue?: string; + userValue?: string | null; } /** * A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL. @@ -1587,7 +1583,7 @@ export namespace androidenterprise_v1 { /** * The display mode of the web app. Possible values include: - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - "standalone", the device's status bar and navigation bar are visible when the app is open. - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area. */ - displayMode?: string; + displayMode?: string | null; /** * A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used. */ @@ -1595,23 +1591,23 @@ export namespace androidenterprise_v1 { /** * A flag whether the app has been published to the Play store yet. */ - isPublished?: boolean; + isPublished?: boolean | null; /** * The start URL, i.e. the URL that should load when the user opens the application. */ - startUrl?: string; + startUrl?: string | null; /** * The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon). */ - title?: string; + title?: string | null; /** * The current version of the app. Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date. */ - versionCode?: string; + versionCode?: string | null; /** * The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id. */ - webAppId?: string; + webAppId?: string | null; } /** * Icon for a web app. @@ -1620,7 +1616,7 @@ export namespace androidenterprise_v1 { /** * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512. */ - imageData?: string; + imageData?: string | null; } /** * The web app details for an enterprise. @@ -1629,7 +1625,7 @@ export namespace androidenterprise_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#webAppsListResponse". */ - kind?: string; + kind?: string | null; /** * The manifest describing a web app. */ @@ -6022,7 +6018,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationssettings.list - * @desc Lists all the managed configurations settings for the specified app. Only the ID and the name is set. + * @desc Lists all the managed configurations settings for the specified app. * @alias androidenterprise.managedconfigurationssettings.list * @memberOf! () * diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 1eaac62fc85..566ffe4c14c 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -126,11 +126,11 @@ export namespace androidmanagement_v1 { /** * Disallows networking when the VPN is not connected. */ - lockdownEnabled?: boolean; + lockdownEnabled?: boolean | null; /** * The package name of the VPN app. */ - packageName?: string; + packageName?: string | null; } /** * A compliance rule condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. There can only be one rule with this type of condition per policy. @@ -139,12 +139,16 @@ export namespace androidmanagement_v1 { /** * The minimum desired Android Framework API level. If the device doesn't meet the minimum requirement, this condition is satisfied. Must be greater than zero. */ - minApiLevel?: number; + minApiLevel?: number | null; } /** * Information about an app. */ export interface Schema$Application { + /** + * Application tracks visible to the enterprise. + */ + appTracks?: Schema$AppTrackInfo[]; /** * The set of managed properties available to be pre-configured for the app. */ @@ -152,7 +156,7 @@ export namespace androidmanagement_v1 { /** * The name of the app in the form enterprises/{enterpriseId}/applications/{package_name}. */ - name?: string; + name?: string | null; /** * The permissions required by the app. */ @@ -160,7 +164,7 @@ export namespace androidmanagement_v1 { /** * The title of the app. Localized. */ - title?: string; + title?: string | null; } /** * An app-related event. @@ -169,11 +173,11 @@ export namespace androidmanagement_v1 { /** * The creation time of the event. */ - createTime?: string; + createTime?: string | null; /** * App event type. */ - eventType?: string; + eventType?: string | null; } /** * A permission required by the app. @@ -182,44 +186,48 @@ export namespace androidmanagement_v1 { /** * A longer description of the permission, providing more detail on what it affects. Localized. */ - description?: string; + description?: string | null; /** * The name of the permission. Localized. */ - name?: string; + name?: string | null; /** * An opaque string uniquely identifying the permission. Not localized. */ - permissionId?: string; + permissionId?: string | null; } /** * Policy for an individual app. */ export interface Schema$ApplicationPolicy { + /** + * List of the app’s track IDs that a device belonging to the enterprise can access. If the list contains multiple track IDs, devices receive the latest version among all accessible tracks. If the list contains no track IDs, devices only have access to the app’s production track. More details about each track are available in AppTrackInfo. + */ + accessibleTrackIds?: string[] | null; /** * The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps. */ - defaultPermissionPolicy?: string; + defaultPermissionPolicy?: string | null; /** * The scopes delegated to the app from Android Device Policy. */ - delegatedScopes?: string[]; + delegatedScopes?: string[] | null; /** * Whether the app is disabled. When disabled, the app data is still preserved. */ - disabled?: boolean; + disabled?: boolean | null; /** * The type of installation to perform. */ - installType?: string; + installType?: string | null; /** * Whether the app is allowed to lock itself in full-screen mode. DEPRECATED. Use InstallType KIOSK or kioskCustomLauncherEnabled to to configure a dedicated device. */ - lockTaskAllowed?: boolean; + lockTaskAllowed?: boolean | null; /** * Managed configuration applied to the app. The format for the configuration is dictated by the ManagedProperty values supported by the app. Each field name in the managed configuration must match the key field of the ManagedProperty. The field value must be compatible with the type of the ManagedProperty: <table> <tr><td><i>type</i></td><td><i>JSON value</i></td></tr> <tr><td>BOOL</td><td>true or false</td></tr> <tr><td>STRING</td><td>string</td></tr> <tr><td>INTEGER</td><td>number</td></tr> <tr><td>CHOICE</td><td>string</td></tr> <tr><td>MULTISELECT</td><td>array of strings</td></tr> <tr><td>HIDDEN</td><td>string</td></tr> <tr><td>BUNDLE_ARRAY</td><td>array of objects</td></tr> </table> */ - managedConfiguration?: {[key: string]: any}; + managedConfiguration?: {[key: string]: any} | null; /** * The managed configurations template for the app, saved from the managed configurations iframe. This field is ignored if managed_configuration is set. */ @@ -227,11 +235,11 @@ export namespace androidmanagement_v1 { /** * The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. */ - minimumVersionCode?: number; + minimumVersionCode?: number | null; /** * The package name of the app. For example, com.google.android.youtube for the YouTube app. */ - packageName?: string; + packageName?: string | null; /** * Explicit permission grants or denials for the app. These values override the default_permission_policy and permission_grants which apply to all apps. */ @@ -244,11 +252,11 @@ export namespace androidmanagement_v1 { /** * The source of the package. */ - applicationSource?: string; + applicationSource?: string | null; /** * The display name of the app. */ - displayName?: string; + displayName?: string | null; /** * List of app events. The most recent 20 events are stored in the list. */ @@ -256,7 +264,7 @@ export namespace androidmanagement_v1 { /** * The package name of the app that installed this app. */ - installerPackageName?: string; + installerPackageName?: string | null; /** * List of keyed app states reported by the app. */ @@ -264,27 +272,27 @@ export namespace androidmanagement_v1 { /** * Package name of the app. */ - packageName?: string; + packageName?: string | null; /** * The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number. */ - packageSha256Hash?: string; + packageSha256Hash?: string | null; /** * The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. */ - signingKeyCertFingerprints?: string[]; + signingKeyCertFingerprints?: string[] | null; /** * Application state. */ - state?: string; + state?: string | null; /** * The app version code, which can be used to determine whether one version is more recent than another. */ - versionCode?: number; + versionCode?: number | null; /** * The app version as displayed to the user. */ - versionName?: string; + versionName?: string | null; } /** * Settings controlling the behavior of application reports. @@ -293,7 +301,20 @@ export namespace androidmanagement_v1 { /** * Whether removed apps are included in application reports. */ - includeRemovedApps?: boolean; + includeRemovedApps?: boolean | null; + } + /** + * Id to name association of a app track. + */ + export interface Schema$AppTrackInfo { + /** + * The track name associated with the trackId, set in the Play Console. The name is modifiable from Play Console. + */ + trackAlias?: string | null; + /** + * The unmodifiable unique track identifier, taken from the releaseTrackId in the URL of the Play Console page that displays the app’s track information. + */ + trackId?: string | null; } /** * An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a device or work profile to displays a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified. @@ -302,7 +323,7 @@ export namespace androidmanagement_v1 { /** * Number of days the policy is non-compliant before the device or work profile is blocked. To block access immediately, set to 0. blockAfterDays must be less than wipeAfterDays. */ - blockAfterDays?: number; + blockAfterDays?: number | null; } /** * A rule for automatically choosing a private key and certificate to authenticate the device to a server. @@ -311,15 +332,15 @@ export namespace androidmanagement_v1 { /** * The package names for which outgoing requests are subject to this rule. If no package names are specified, then the rule applies to all packages. For each package name listed, the rule applies to that package and all other packages that shared the same Android UID. The SHA256 hash of the signing key signatures of each package_name will be verified against those provided by Play */ - packageNames?: string[]; + packageNames?: string[] | null; /** * The alias of the private key to be used. */ - privateKeyAlias?: string; + privateKeyAlias?: string | null; /** * The URL pattern to match against the URL of the outgoing request. The pattern may contain asterisk (*) wildcards. Any URL is matched if unspecified. */ - urlPattern?: string; + urlPattern?: string | null; } /** * A command. @@ -328,31 +349,31 @@ export namespace androidmanagement_v1 { /** * The timestamp at which the command was created. The timestamp is automatically generated by the server. */ - createTime?: string; + createTime?: string | null; /** * The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration. */ - duration?: string; + duration?: string | null; /** * If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller. */ - errorCode?: string; + errorCode?: string | null; /** * For commands of type RESET_PASSWORD, optionally specifies the new password. */ - newPassword?: string; + newPassword?: string | null; /** * For commands of type RESET_PASSWORD, optionally specifies flags. */ - resetPasswordFlags?: string[]; + resetPasswordFlags?: string[] | null; /** * The type of the command. */ - type?: string; + type?: string | null; /** * The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to. */ - userName?: string; + userName?: string | null; } /** * A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule. @@ -365,7 +386,7 @@ export namespace androidmanagement_v1 { /** * If set to true, the rule includes a mitigating action to disable apps so that the device is effectively disabled, but app data is preserved. If the device is running an app in locked task mode, the app will be closed and a UI showing the reason for non-compliance will be displayed. */ - disableApps?: boolean; + disableApps?: boolean | null; /** * A condition which is satisfied if there exists any matching NonComplianceDetail for the device. */ @@ -373,7 +394,7 @@ export namespace androidmanagement_v1 { /** * If set, the rule includes a mitigating action to disable apps specified in the list, but app data is preserved. */ - packageNamesToDisable?: string[]; + packageNamesToDisable?: string[] | null; } /** * A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. @@ -382,7 +403,7 @@ export namespace androidmanagement_v1 { /** * The API level of the Android platform version running on the device. */ - apiLevel?: number; + apiLevel?: number | null; /** * Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. */ @@ -390,15 +411,15 @@ export namespace androidmanagement_v1 { /** * The name of the policy currently applied to the device. */ - appliedPolicyName?: string; + appliedPolicyName?: string | null; /** * The version of the policy currently applied to the device. */ - appliedPolicyVersion?: string; + appliedPolicyVersion?: string | null; /** * The state currently applied to the device. */ - appliedState?: string; + appliedState?: string | null; /** * Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. */ @@ -414,15 +435,15 @@ export namespace androidmanagement_v1 { /** * The time of device enrollment. */ - enrollmentTime?: string; + enrollmentTime?: string | null; /** * If the device was enrolled with an enrollment token with additional data provided, this field contains that data. */ - enrollmentTokenData?: string; + enrollmentTokenData?: string | null; /** * If the device was enrolled with an enrollment token, this field contains the name of the token. */ - enrollmentTokenName?: string; + enrollmentTokenName?: string | null; /** * Detailed information about the device hardware. */ @@ -434,19 +455,19 @@ export namespace androidmanagement_v1 { /** * Deprecated. */ - lastPolicyComplianceReportTime?: string; + lastPolicyComplianceReportTime?: string | null; /** * The last time the device fetched its policy. */ - lastPolicySyncTime?: string; + lastPolicySyncTime?: string | null; /** * The last time the device sent a status report. */ - lastStatusReportTime?: string; + lastStatusReportTime?: string | null; /** * The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. */ - managementMode?: string; + managementMode?: string | null; /** * Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy. */ @@ -458,7 +479,7 @@ export namespace androidmanagement_v1 { /** * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. */ - name?: string; + name?: string | null; /** * Device network information. This information is only available if networkInfoEnabled is true in the device's policy. */ @@ -470,11 +491,11 @@ export namespace androidmanagement_v1 { /** * Whether the device is compliant with its policy. */ - policyCompliant?: boolean; + policyCompliant?: boolean | null; /** * The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred. */ - policyName?: string; + policyName?: string | null; /** * Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. */ @@ -482,7 +503,7 @@ export namespace androidmanagement_v1 { /** * If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order. */ - previousDeviceNames?: string[]; + previousDeviceNames?: string[] | null; /** * Device's security posture value that reflects how secure the device is. */ @@ -494,11 +515,11 @@ export namespace androidmanagement_v1 { /** * The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete. */ - state?: string; + state?: string | null; /** - * Map of selected system properties name and value related to the device. + * Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy. */ - systemProperties?: {[key: string]: string}; + systemProperties?: {[key: string]: string} | null; /** * The user who owns the device. */ @@ -506,7 +527,7 @@ export namespace androidmanagement_v1 { /** * The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. */ - userName?: string; + userName?: string | null; } /** * Information about security related device settings on device. @@ -515,31 +536,31 @@ export namespace androidmanagement_v1 { /** * Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. */ - adbEnabled?: boolean; + adbEnabled?: boolean | null; /** * Whether developer mode is enabled on the device. */ - developmentSettingsEnabled?: boolean; + developmentSettingsEnabled?: boolean | null; /** * Encryption status from DevicePolicyManager. */ - encryptionStatus?: string; + encryptionStatus?: string | null; /** * Whether the device is secured with PIN/password. */ - isDeviceSecure?: boolean; + isDeviceSecure?: boolean | null; /** * Whether the storage encryption is enabled. */ - isEncrypted?: boolean; + isEncrypted?: boolean | null; /** * Whether installing apps from unknown sources is enabled. */ - unknownSourcesEnabled?: boolean; + unknownSourcesEnabled?: boolean | null; /** * Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. */ - verifyAppsEnabled?: boolean; + verifyAppsEnabled?: boolean | null; } /** * Device display information. @@ -548,31 +569,31 @@ export namespace androidmanagement_v1 { /** * Display density expressed as dots-per-inch. */ - density?: number; + density?: number | null; /** * Unique display id. */ - displayId?: number; + displayId?: number | null; /** * Display height in pixels. */ - height?: number; + height?: number | null; /** * Name of the display. */ - name?: string; + name?: string | null; /** * Refresh rate of the display in frames per second. */ - refreshRate?: number; + refreshRate?: number | null; /** * State of the display. */ - state?: string; + state?: string | null; /** * Display width in pixels. */ - width?: number; + width?: number | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. @@ -585,31 +606,31 @@ export namespace androidmanagement_v1 { /** * Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail. */ - additionalData?: string; + additionalData?: string | null; /** * The length of time the enrollment token is valid, ranging from 1 minute to 30 days. If not specified, the default duration is 1 hour. */ - duration?: string; + duration?: string | null; /** * The expiration time of the token. This is a read-only field generated by the server. */ - expirationTimestamp?: string; + expirationTimestamp?: string | null; /** * The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. */ - name?: string; + name?: string | null; /** * Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration. */ - oneTimeOnly?: boolean; + oneTimeOnly?: boolean | null; /** * The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred. */ - policyName?: string; + policyName?: string | null; /** * A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. */ - qrCode?: string; + qrCode?: string | null; /** * The user associated with this enrollment token. If it's specified when the enrollment token is created and the user does not exist, the user will be created. This field must not contain personally identifiable information. Only the account_identifier field needs to be set. */ @@ -617,7 +638,7 @@ export namespace androidmanagement_v1 { /** * The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server. */ - value?: string; + value?: string | null; } /** * The configuration applied to an enterprise. @@ -626,15 +647,15 @@ export namespace androidmanagement_v1 { /** * Deprecated and unused. */ - appAutoApprovalEnabled?: boolean; + appAutoApprovalEnabled?: boolean | null; /** * The types of Google Pub/Sub notifications enabled for the enterprise. */ - enabledNotificationTypes?: string[]; + enabledNotificationTypes?: string[] | null; /** * The name of the enterprise displayed to users. */ - enterpriseDisplayName?: string; + enterpriseDisplayName?: string | null; /** * An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. */ @@ -642,15 +663,15 @@ export namespace androidmanagement_v1 { /** * The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. */ - name?: string; + name?: string | null; /** * A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive. */ - primaryColor?: number; + primaryColor?: number | null; /** * The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled. */ - pubsubTopic?: string; + pubsubTopic?: string | null; /** * Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. */ @@ -667,11 +688,11 @@ export namespace androidmanagement_v1 { /** * The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. */ - sha256Hash?: string; + sha256Hash?: string | null; /** * The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL. */ - url?: string; + url?: string | null; } /** * Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. @@ -680,59 +701,59 @@ export namespace androidmanagement_v1 { /** * Battery shutdown temperature thresholds in Celsius for each battery on the device. */ - batteryShutdownTemperatures?: number[]; + batteryShutdownTemperatures?: number[] | null; /** * Battery throttling temperature thresholds in Celsius for each battery on the device. */ - batteryThrottlingTemperatures?: number[]; + batteryThrottlingTemperatures?: number[] | null; /** * Brand of the device. For example, Google. */ - brand?: string; + brand?: string | null; /** * CPU shutdown temperature thresholds in Celsius for each CPU on the device. */ - cpuShutdownTemperatures?: number[]; + cpuShutdownTemperatures?: number[] | null; /** * CPU throttling temperature thresholds in Celsius for each CPU on the device. */ - cpuThrottlingTemperatures?: number[]; + cpuThrottlingTemperatures?: number[] | null; /** * Baseband version. For example, MDM9625_104662.22.05.34p. */ - deviceBasebandVersion?: string; + deviceBasebandVersion?: string | null; /** * GPU shutdown temperature thresholds in Celsius for each GPU on the device. */ - gpuShutdownTemperatures?: number[]; + gpuShutdownTemperatures?: number[] | null; /** * GPU throttling temperature thresholds in Celsius for each GPU on the device. */ - gpuThrottlingTemperatures?: number[]; + gpuThrottlingTemperatures?: number[] | null; /** * Name of the hardware. For example, Angler. */ - hardware?: string; + hardware?: string | null; /** * Manufacturer. For example, Motorola. */ - manufacturer?: string; + manufacturer?: string | null; /** * The model of the device. For example, Asus Nexus 7. */ - model?: string; + model?: string | null; /** * The device serial number. */ - serialNumber?: string; + serialNumber?: string | null; /** * Device skin shutdown temperature thresholds in Celsius. */ - skinShutdownTemperatures?: number[]; + skinShutdownTemperatures?: number[] | null; /** * Device skin throttling temperature thresholds in Celsius. */ - skinThrottlingTemperatures?: number[]; + skinThrottlingTemperatures?: number[] | null; } /** * Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. @@ -741,31 +762,31 @@ export namespace androidmanagement_v1 { /** * Current battery temperatures in Celsius for each battery on the device. */ - batteryTemperatures?: number[]; + batteryTemperatures?: number[] | null; /** * Current CPU temperatures in Celsius for each CPU on the device. */ - cpuTemperatures?: number[]; + cpuTemperatures?: number[] | null; /** * CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system. */ - cpuUsages?: number[]; + cpuUsages?: number[] | null; /** * The time the measurements were taken. */ - createTime?: string; + createTime?: string | null; /** * Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system. */ - fanSpeeds?: number[]; + fanSpeeds?: number[] | null; /** * Current GPU temperatures in Celsius for each GPU on the device. */ - gpuTemperatures?: number[]; + gpuTemperatures?: number[] | null; /** * Current device skin temperatures in Celsius. */ - skinTemperatures?: number[]; + skinTemperatures?: number[] | null; } /** * Keyed app state reported by the app. @@ -774,27 +795,27 @@ export namespace androidmanagement_v1 { /** * The creation time of the app state on the device. */ - createTime?: string; + createTime?: string | null; /** * Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”). */ - data?: string; + data?: string | null; /** * The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key. */ - key?: string; + key?: string | null; /** * The time the app state was most recently updated. */ - lastUpdateTime?: string; + lastUpdateTime?: string | null; /** * Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message. */ - message?: string; + message?: string | null; /** * The severity of the app state. */ - severity?: string; + severity?: string | null; } /** * An action to launch an app. @@ -803,7 +824,7 @@ export namespace androidmanagement_v1 { /** * Package name of app to be launched */ - packageName?: string; + packageName?: string | null; } /** * Response to a request to list devices for a given enterprise. @@ -816,7 +837,7 @@ export namespace androidmanagement_v1 { /** * If there are more results, a token to retrieve next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -825,7 +846,7 @@ export namespace androidmanagement_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -838,7 +859,7 @@ export namespace androidmanagement_v1 { /** * If there are more results, a token to retrieve next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of policies. */ @@ -851,7 +872,7 @@ export namespace androidmanagement_v1 { /** * If there are more results, a token to retrieve next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of web apps. */ @@ -864,11 +885,11 @@ export namespace androidmanagement_v1 { /** * Optional, a map containing <key, value> configuration variables defined for the configuration. */ - configurationVariables?: {[key: string]: string}; + configurationVariables?: {[key: string]: string} | null; /** * The ID of the managed configurations template. */ - templateId?: string; + templateId?: string | null; } /** * Managed property. @@ -877,11 +898,11 @@ export namespace androidmanagement_v1 { /** * The default value of the property. BUNDLE_ARRAY properties don't have a default value. */ - defaultValue?: any; + defaultValue?: any | null; /** * A longer description of the property, providing more detail of what it affects. Localized. */ - description?: string; + description?: string | null; /** * For CHOICE or MULTISELECT properties, the list of possible entries. */ @@ -889,7 +910,7 @@ export namespace androidmanagement_v1 { /** * The unique key that the app uses to identify the property, e.g. "com.google.android.gm.fieldname". */ - key?: string; + key?: string | null; /** * For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY property is at most two levels deep. */ @@ -897,11 +918,11 @@ export namespace androidmanagement_v1 { /** * The name of the property. Localized. */ - title?: string; + title?: string | null; /** * The type of the property. */ - type?: string; + type?: string | null; } /** * An entry of a managed property. @@ -910,11 +931,11 @@ export namespace androidmanagement_v1 { /** * The human-readable name of the value. Localized. */ - name?: string; + name?: string | null; /** * The machine-readable value of the entry, which should be used in the configuration. Not localized. */ - value?: string; + value?: string | null; } /** * An event related to memory and storage measurements. @@ -923,15 +944,15 @@ export namespace androidmanagement_v1 { /** * The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium. */ - byteCount?: string; + byteCount?: string | null; /** * The creation time of the event. */ - createTime?: string; + createTime?: string | null; /** * Event type. */ - eventType?: string; + eventType?: string | null; } /** * Information about device memory and storage. @@ -940,11 +961,11 @@ export namespace androidmanagement_v1 { /** * Total internal storage on device in bytes. */ - totalInternalStorage?: string; + totalInternalStorage?: string | null; /** * Total RAM on device in bytes. */ - totalRam?: string; + totalRam?: string | null; } /** * Device network info. @@ -953,19 +974,19 @@ export namespace androidmanagement_v1 { /** * IMEI number of the GSM device. For example, A1000031212. */ - imei?: string; + imei?: string | null; /** * MEID number of the CDMA device. For example, A00000292788E1. */ - meid?: string; + meid?: string | null; /** * Alphabetic name of current registered operator. For example, Vodafone. */ - networkOperatorName?: string; + networkOperatorName?: string | null; /** * Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. */ - wifiMacAddress?: string; + wifiMacAddress?: string | null; } /** * Provides detail about non-compliance with a policy setting. @@ -974,27 +995,27 @@ export namespace androidmanagement_v1 { /** * If the policy setting could not be applied, the current value of the setting on the device. */ - currentValue?: any; + currentValue?: any | null; /** * For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url */ - fieldPath?: string; + fieldPath?: string | null; /** * If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated. */ - installationFailureReason?: string; + installationFailureReason?: string | null; /** * The reason the device is not in compliance with the setting. */ - nonComplianceReason?: string; + nonComplianceReason?: string | null; /** * The package name indicating which app is out of compliance, if applicable. */ - packageName?: string; + packageName?: string | null; /** * The name of the policy setting. This is the JSON field name of a top-level Policy field. */ - settingName?: string; + settingName?: string | null; } /** * A compliance rule condition which is satisfied if there exists any matching NonComplianceDetail for the device. A NonComplianceDetail matches a NonComplianceDetailCondition if all the fields which are set within the NonComplianceDetailCondition match the corresponding NonComplianceDetail fields. @@ -1003,15 +1024,15 @@ export namespace androidmanagement_v1 { /** * The reason the device is not in compliance with the setting. If not set, then this condition matches any reason. */ - nonComplianceReason?: string; + nonComplianceReason?: string | null; /** * The package name of the app that's out of compliance. If not set, then this condition matches any package name. */ - packageName?: string; + packageName?: string | null; /** * The name of the policy setting. This is the JSON field name of a top-level Policy field. If not set, then this condition matches any setting name. */ - settingName?: string; + settingName?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1020,7 +1041,7 @@ export namespace androidmanagement_v1 { /** * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1028,15 +1049,15 @@ export namespace androidmanagement_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A list of package names. @@ -1045,7 +1066,7 @@ export namespace androidmanagement_v1 { /** * A list of package names. */ - packageNames?: string[]; + packageNames?: string[] | null; } /** * Requirements for the password used to unlock a device. @@ -1054,51 +1075,51 @@ export namespace androidmanagement_v1 { /** * Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. */ - maximumFailedPasswordsForWipe?: number; + maximumFailedPasswordsForWipe?: number | null; /** * Password expiration timeout. */ - passwordExpirationTimeout?: string; + passwordExpirationTimeout?: string | null; /** * The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. */ - passwordHistoryLength?: number; + passwordHistoryLength?: number | null; /** * The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. */ - passwordMinimumLength?: number; + passwordMinimumLength?: number | null; /** * Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. */ - passwordMinimumLetters?: number; + passwordMinimumLetters?: number | null; /** * Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. */ - passwordMinimumLowerCase?: number; + passwordMinimumLowerCase?: number | null; /** * Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. */ - passwordMinimumNonLetter?: number; + passwordMinimumNonLetter?: number | null; /** * Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. */ - passwordMinimumNumeric?: number; + passwordMinimumNumeric?: number | null; /** * Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. */ - passwordMinimumSymbols?: number; + passwordMinimumSymbols?: number | null; /** * Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. */ - passwordMinimumUpperCase?: number; + passwordMinimumUpperCase?: number | null; /** * The required password quality. */ - passwordQuality?: string; + passwordQuality?: string | null; /** * The scope that the password requirement applies to. */ - passwordScope?: string; + passwordScope?: string | null; } /** * Configuration for an Android permission and its grant state. @@ -1107,11 +1128,11 @@ export namespace androidmanagement_v1 { /** * The Android permission or group, e.g. android.permission.READ_CALENDAR or android.permission_group.CALENDAR. */ - permission?: string; + permission?: string | null; /** * The policy for granting the permission. */ - policy?: string; + policy?: string | null; } /** * A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities. @@ -1120,15 +1141,15 @@ export namespace androidmanagement_v1 { /** * The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. */ - actions?: string[]; + actions?: string[] | null; /** * The intent categories to match in the filter. An intent includes the categories that it requires, all of which must be included in the filter in order to match. In other words, adding a category to the filter has no impact on matching unless that category is specified in the intent. */ - categories?: string[]; + categories?: string[] | null; /** * The activity that should be the default intent handler. This should be an Android component name, e.g. com.android.enterprise.app/.MainActivity. Alternatively, the value may be the package name of an app, which causes Android Device Policy to choose an appropriate activity from the app to handle the intent. */ - receiverActivity?: string; + receiverActivity?: string | null; } /** * A policy resources represents a group settings that govern the behavior of a managed device and the apps installed on it. @@ -1137,15 +1158,15 @@ export namespace androidmanagement_v1 { /** * Account types that can't be managed by the user. */ - accountTypesWithManagementDisabled?: string[]; + accountTypesWithManagementDisabled?: string[] | null; /** * Whether adding new users and profiles is disabled. */ - addUserDisabled?: boolean; + addUserDisabled?: boolean | null; /** * Whether adjusting the master volume is disabled. */ - adjustVolumeDisabled?: boolean; + adjustVolumeDisabled?: boolean | null; /** * Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. */ @@ -1153,11 +1174,11 @@ export namespace androidmanagement_v1 { /** * The app tracks for Android Device Policy the device can access. The device receives the latest version among all accessible tracks. If no tracks are specified, then the device only uses the production track. */ - androidDevicePolicyTracks?: string[]; + androidDevicePolicyTracks?: string[] | null; /** * The app auto update policy, which controls when automatic app updates can be applied. */ - appAutoUpdatePolicy?: string; + appAutoUpdatePolicy?: string | null; /** * Policy applied to apps. */ @@ -1165,31 +1186,31 @@ export namespace androidmanagement_v1 { /** * Whether auto time is required, which prevents the user from manually setting the date and time. */ - autoTimeRequired?: boolean; + autoTimeRequired?: boolean | null; /** * Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled. */ - blockApplicationsEnabled?: boolean; + blockApplicationsEnabled?: boolean | null; /** * Whether configuring bluetooth is disabled. */ - bluetoothConfigDisabled?: boolean; + bluetoothConfigDisabled?: boolean | null; /** * Whether bluetooth contact sharing is disabled. */ - bluetoothContactSharingDisabled?: boolean; + bluetoothContactSharingDisabled?: boolean | null; /** * Whether bluetooth is disabled. Prefer this setting over bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by the user. */ - bluetoothDisabled?: boolean; + bluetoothDisabled?: boolean | null; /** * Whether all cameras on the device are disabled. */ - cameraDisabled?: boolean; + cameraDisabled?: boolean | null; /** * Whether configuring cell broadcast is disabled. */ - cellBroadcastsConfigDisabled?: boolean; + cellBroadcastsConfigDisabled?: boolean | null; /** * Rules for automatically choosing a private key and certificate to authenticate the device to a server. The rules are ordered by increasing precedence, so if an outgoing request matches more than one rule, the last rule defines which private key to use. */ @@ -1201,23 +1222,23 @@ export namespace androidmanagement_v1 { /** * Whether creating windows besides app windows is disabled. */ - createWindowsDisabled?: boolean; + createWindowsDisabled?: boolean | null; /** * Whether configuring user credentials is disabled. */ - credentialsConfigDisabled?: boolean; + credentialsConfigDisabled?: boolean | null; /** * Whether roaming data services are disabled. */ - dataRoamingDisabled?: boolean; + dataRoamingDisabled?: boolean | null; /** * Whether the user is allowed to enable debugging features. */ - debuggingFeaturesAllowed?: boolean; + debuggingFeaturesAllowed?: boolean | null; /** * The default permission policy for runtime permission requests. */ - defaultPermissionPolicy?: string; + defaultPermissionPolicy?: string | null; /** * The device owner information to be shown on the lock screen. */ @@ -1225,47 +1246,47 @@ export namespace androidmanagement_v1 { /** * Whether encryption is enabled */ - encryptionPolicy?: string; + encryptionPolicy?: string | null; /** * Whether app verification is force-enabled. */ - ensureVerifyAppsEnabled?: boolean; + ensureVerifyAppsEnabled?: boolean | null; /** * Whether factory resetting from settings is disabled. */ - factoryResetDisabled?: boolean; + factoryResetDisabled?: boolean | null; /** * Email addresses of device administrators for factory reset protection. When the device is factory reset, it will require one of these admins to log in with the Google account email and password to unlock the device. If no admins are specified, the device won't provide factory reset protection. */ - frpAdminEmails?: string[]; + frpAdminEmails?: string[] | null; /** * Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled. */ - funDisabled?: boolean; + funDisabled?: boolean | null; /** * Whether user installation of apps is disabled. */ - installAppsDisabled?: boolean; + installAppsDisabled?: boolean | null; /** * Whether the user is allowed to enable the "Unknown Sources" setting, which allows installation of apps from unknown sources. */ - installUnknownSourcesAllowed?: boolean; + installUnknownSourcesAllowed?: boolean | null; /** * Whether the keyguard is disabled. */ - keyguardDisabled?: boolean; + keyguardDisabled?: boolean | null; /** * Disabled keyguard customizations, such as widgets. */ - keyguardDisabledFeatures?: string[]; + keyguardDisabledFeatures?: string[] | null; /** * 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. */ - kioskCustomLauncherEnabled?: boolean; + kioskCustomLauncherEnabled?: boolean | null; /** * The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings. */ - locationMode?: string; + locationMode?: string | null; /** * A message displayed to the user in the device administators settings screen. */ @@ -1273,47 +1294,47 @@ export namespace androidmanagement_v1 { /** * Maximum time in milliseconds for user activity until the device locks. A value of 0 means there is no restriction. */ - maximumTimeToLock?: string; + maximumTimeToLock?: string | null; /** * The minimum allowed Android API level. */ - minimumApiLevel?: number; + minimumApiLevel?: number | null; /** * Whether configuring mobile networks is disabled. */ - mobileNetworksConfigDisabled?: boolean; + mobileNetworksConfigDisabled?: boolean | null; /** * Whether adding or removing accounts is disabled. */ - modifyAccountsDisabled?: boolean; + modifyAccountsDisabled?: boolean | null; /** * Whether the user mounting physical external media is disabled. */ - mountPhysicalMediaDisabled?: boolean; + mountPhysicalMediaDisabled?: boolean | null; /** * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. */ - name?: string; + name?: string | null; /** * Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings. */ - networkEscapeHatchEnabled?: boolean; + networkEscapeHatchEnabled?: boolean | null; /** * Whether resetting network settings is disabled. */ - networkResetDisabled?: boolean; + networkResetDisabled?: boolean | null; /** * Network configuration for the device. See configure networks for more information. */ - openNetworkConfiguration?: {[key: string]: any}; + openNetworkConfiguration?: {[key: string]: any} | null; /** * Whether using NFC to beam data from apps is disabled. */ - outgoingBeamDisabled?: boolean; + outgoingBeamDisabled?: boolean | null; /** * Whether outgoing calls are disabled. */ - outgoingCallsDisabled?: boolean; + outgoingCallsDisabled?: boolean | null; /** * Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. */ @@ -1326,6 +1347,10 @@ export namespace androidmanagement_v1 { * Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. */ permissionGrants?: Schema$PermissionGrant[]; + /** + * Specifies permitted accessibility services. If the field is not set, any accessibility service can be used. If the field is set, only the accessibility services in this list and the system's built-in accessibility services can be used. In particular, if the field is set to empty, only the system's built-in accessibility services can be used. + */ + permittedAccessibilityServices?: Schema$PackageNameList; /** * If present, only the input methods provided by packages in this list are permitted. If this field is present, but the list is empty, then only system input methods are permitted. */ @@ -1337,7 +1362,7 @@ export namespace androidmanagement_v1 { /** * This mode controls which apps are available to the user in the Play Store and the behavior on the device when apps are removed from the policy. */ - playStoreMode?: string; + playStoreMode?: string | null; /** * Rules that define the behavior when a particular policy can not be applied on device */ @@ -1345,7 +1370,7 @@ export namespace androidmanagement_v1 { /** * Allows showing UI on a device for a user to choose a private key alias if there are no matching rules in ChoosePrivateKeyRules. For devices below Android P, setting this may leave enterprise keys vulnerable. */ - privateKeySelectionEnabled?: boolean; + privateKeySelectionEnabled?: boolean | null; /** * The network-independent global HTTP proxy. Typically proxies should be configured per-network in open_network_configuration. However for unusual configurations like general internal filtering a global HTTP proxy may be useful. If the proxy is not accessible, network access may break. The global proxy is only a recommendation and some apps may ignore it. */ @@ -1353,15 +1378,15 @@ export namespace androidmanagement_v1 { /** * Whether removing other users is disabled. */ - removeUserDisabled?: boolean; + removeUserDisabled?: boolean | null; /** * Whether rebooting the device into safe boot is disabled. */ - safeBootDisabled?: boolean; + safeBootDisabled?: boolean | null; /** * Whether screen capture is disabled. */ - screenCaptureDisabled?: boolean; + screenCaptureDisabled?: boolean | null; /** * Actions to take during the setup process. */ @@ -1369,15 +1394,15 @@ export namespace androidmanagement_v1 { /** * Whether changing the user icon is disabled. */ - setUserIconDisabled?: boolean; + setUserIconDisabled?: boolean | null; /** * Whether changing the wallpaper is disabled. */ - setWallpaperDisabled?: boolean; + setWallpaperDisabled?: boolean | null; /** * Whether location sharing is disabled. */ - shareLocationDisabled?: boolean; + shareLocationDisabled?: boolean | null; /** * A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. */ @@ -1385,15 +1410,15 @@ export namespace androidmanagement_v1 { /** * Flag to skip hints on the first use. Enterprise admin can enable the system recommendation for apps to skip their user tutorial and other introductory hints on first start-up. */ - skipFirstUseHintsEnabled?: boolean; + skipFirstUseHintsEnabled?: boolean | null; /** * Whether sending and receiving SMS messages is disabled. */ - smsDisabled?: boolean; + smsDisabled?: boolean | null; /** * Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode. DEPRECATED. To disable the status bar on a kiosk device, use InstallType KIOSK or kioskCustomLauncherEnabled. */ - statusBarDisabled?: boolean; + statusBarDisabled?: boolean | null; /** * Status reporting settings */ @@ -1401,7 +1426,7 @@ export namespace androidmanagement_v1 { /** * The battery plugged in modes for which the device stays on. When using this setting, it is recommended to clear maximum_time_to_lock so that the device doesn't lock itself while it stays on. */ - stayOnPluggedModes?: string[]; + stayOnPluggedModes?: string[] | null; /** * The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well. */ @@ -1409,39 +1434,39 @@ export namespace androidmanagement_v1 { /** * Whether configuring tethering and portable hotspots is disabled. */ - tetheringConfigDisabled?: boolean; + tetheringConfigDisabled?: boolean | null; /** * Whether user uninstallation of applications is disabled. */ - uninstallAppsDisabled?: boolean; + uninstallAppsDisabled?: boolean | null; /** * Whether the microphone is muted and adjusting microphone volume is disabled. */ - unmuteMicrophoneDisabled?: boolean; + unmuteMicrophoneDisabled?: boolean | null; /** * Whether transferring files over USB is disabled. */ - usbFileTransferDisabled?: boolean; + usbFileTransferDisabled?: boolean | null; /** * Whether USB storage is enabled. Deprecated. */ - usbMassStorageEnabled?: boolean; + usbMassStorageEnabled?: boolean | null; /** * The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. */ - version?: string; + version?: string | null; /** * Whether configuring VPN is disabled. */ - vpnConfigDisabled?: boolean; + vpnConfigDisabled?: boolean | null; /** * Whether configuring Wi-Fi access points is disabled. */ - wifiConfigDisabled?: boolean; + wifiConfigDisabled?: boolean | null; /** * DEPRECATED - Use wifi_config_disabled. */ - wifiConfigsLockdownEnabled?: boolean; + wifiConfigsLockdownEnabled?: boolean | null; } /** * A rule that defines the actions to take if a device or work profile is not compliant with the policy specified in settingName. @@ -1454,24 +1479,24 @@ export namespace androidmanagement_v1 { /** * The top-level policy to enforce. For example, applications or passwordPolicies. */ - settingName?: string; + settingName?: string | null; /** * An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified. */ wipeAction?: Schema$WipeAction; } /** - * Detail that provides further information if the device is not in the most secure state. + * Additional details regarding the security posture of the device. */ export interface Schema$PostureDetail { /** - * Corresponding pieces of advice to mitigate the security risk. + * Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. */ advice?: Schema$UserFacingMessage[]; /** - * The risk that makes the device not in the most secure state. + * A specific security risk that negatively affects the security posture of the device. */ - securityRisk?: string; + securityRisk?: string | null; } /** * A power management event. @@ -1480,15 +1505,15 @@ export namespace androidmanagement_v1 { /** * For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. */ - batteryLevel?: number; + batteryLevel?: number | null; /** * The creation time of the event. */ - createTime?: string; + createTime?: string | null; /** * Event type. */ - eventType?: string; + eventType?: string | null; } /** * Configuration info for an HTTP proxy. For a direct proxy, set the host, port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri field. @@ -1497,30 +1522,30 @@ export namespace androidmanagement_v1 { /** * For a direct proxy, the hosts for which the proxy is bypassed. The host names may contain wildcards such as *.example.com. */ - excludedHosts?: string[]; + excludedHosts?: string[] | null; /** * The host of the direct proxy. */ - host?: string; + host?: string | null; /** * The URI of the PAC script used to configure the proxy. */ - pacUri?: string; + pacUri?: string | null; /** * The port of the direct proxy. */ - port?: number; + port?: number | null; } /** - * . Device's security posture value that reflects how secure the device is. + * The security posture of the device, as determined by the current device state and the policies applied. */ export interface Schema$SecurityPosture { /** * Device's security posture value. */ - devicePosture?: string; + devicePosture?: string | null; /** - * Details that provide further information if the device is not in the most secure state. + * Additional details regarding the security posture of the device. */ postureDetails?: Schema$PostureDetail[]; } @@ -1548,15 +1573,15 @@ export namespace androidmanagement_v1 { /** * A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server. */ - qrCode?: string; + qrCode?: string | null; /** * An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. */ - signinEnrollmentToken?: string; + signinEnrollmentToken?: string | null; /** * Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. */ - signinUrl?: string; + signinUrl?: string | null; } /** * An enterprise signup URL. @@ -1565,11 +1590,11 @@ export namespace androidmanagement_v1 { /** * The name of the resource. Use this value in the signupUrl field when calling enterprises.create to complete the enterprise signup flow. */ - name?: string; + name?: string | null; /** * A URL where an enterprise admin can register their enterprise. The page can't be rendered in an iframe. */ - url?: string; + url?: string | null; } /** * Information about device software. @@ -1578,43 +1603,43 @@ export namespace androidmanagement_v1 { /** * Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. */ - androidBuildNumber?: string; + androidBuildNumber?: string | null; /** * Build time. */ - androidBuildTime?: string; + androidBuildTime?: string | null; /** * The Android Device Policy app version code. */ - androidDevicePolicyVersionCode?: number; + androidDevicePolicyVersionCode?: number | null; /** * The Android Device Policy app version as displayed to the user. */ - androidDevicePolicyVersionName?: string; + androidDevicePolicyVersionName?: string | null; /** * The user-visible Android version string. For example, 6.0.1. */ - androidVersion?: string; + androidVersion?: string | null; /** * The system bootloader version number, e.g. 0.6.7. */ - bootloaderVersion?: string; + bootloaderVersion?: string | null; /** * SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified. */ - deviceBuildSignature?: string; + deviceBuildSignature?: string | null; /** * Kernel version, for example, 2.6.32.9-g103d848. */ - deviceKernelVersion?: string; + deviceKernelVersion?: string | null; /** * An IETF BCP 47 language code for the primary locale on the device. */ - primaryLanguageCode?: string; + primaryLanguageCode?: string | null; /** * Security patch level, e.g. 2016-05-01. */ - securityPatchLevel?: string; + securityPatchLevel?: 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). @@ -1623,15 +1648,15 @@ export namespace androidmanagement_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Settings controlling the behavior of status reports. @@ -1644,39 +1669,39 @@ export namespace androidmanagement_v1 { /** * Whether app reports are enabled. */ - applicationReportsEnabled?: boolean; + applicationReportsEnabled?: boolean | null; /** * Whether device settings reporting is enabled. */ - deviceSettingsEnabled?: boolean; + deviceSettingsEnabled?: boolean | null; /** * Whether displays reporting is enabled. */ - displayInfoEnabled?: boolean; + displayInfoEnabled?: boolean | null; /** * Whether hardware status reporting is enabled. */ - hardwareStatusEnabled?: boolean; + hardwareStatusEnabled?: boolean | null; /** * Whether memory reporting is enabled. */ - memoryInfoEnabled?: boolean; + memoryInfoEnabled?: boolean | null; /** * Whether network info reporting is enabled. */ - networkInfoEnabled?: boolean; + networkInfoEnabled?: boolean | null; /** * Whether power management event reporting is enabled. */ - powerManagementEventsEnabled?: boolean; + powerManagementEventsEnabled?: boolean | null; /** * Whether software info reporting is enabled. */ - softwareInfoEnabled?: boolean; + softwareInfoEnabled?: boolean | null; /** * Whether system properties reporting is enabled. */ - systemPropertiesEnabled?: boolean; + systemPropertiesEnabled?: boolean | null; } /** * Configuration for managing system updates @@ -1685,15 +1710,15 @@ 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; + endMinutes?: number | null; /** * 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. */ - startMinutes?: number; + startMinutes?: number | null; /** * The type of system update to configure. */ - type?: string; + type?: string | null; } /** * A terms and conditions page to be accepted during provisioning. @@ -1715,7 +1740,7 @@ export namespace androidmanagement_v1 { /** * A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail. */ - accountIdentifier?: string; + accountIdentifier?: string | null; } /** * Provides a user-facing message with locale info. The maximum message length is 4096 characters. @@ -1724,11 +1749,11 @@ export namespace androidmanagement_v1 { /** * The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. */ - defaultMessage?: string; + defaultMessage?: string | null; /** * A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr. */ - localizedMessages?: {[key: string]: string}; + localizedMessages?: {[key: string]: string} | null; } /** * A web app. @@ -1737,7 +1762,7 @@ export namespace androidmanagement_v1 { /** * The display mode of the web app. */ - displayMode?: string; + displayMode?: string | null; /** * A list of icons for the web app. Must have at least one element. */ @@ -1745,19 +1770,19 @@ export namespace androidmanagement_v1 { /** * The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. */ - name?: string; + name?: string | null; /** * The start URL, i.e. the URL that should load when the user opens the application. */ - startUrl?: string; + startUrl?: string | null; /** * The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon). */ - title?: string; + title?: string | null; /** * The current version of the app.Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date. */ - versionCode?: string; + versionCode?: string | null; } /** * An icon for a web app. Supported formats are: png, jpg and webp. @@ -1766,7 +1791,7 @@ export namespace androidmanagement_v1 { /** * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul> */ - imageData?: string; + imageData?: string | null; } /** * A web token used to access the managed Google Play iframe. @@ -1775,19 +1800,19 @@ export namespace androidmanagement_v1 { /** * The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}. */ - name?: string; + name?: string | null; /** * The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe may not be hosted at other URLs. The URL must use the https scheme. */ - parentFrameUrl?: string; + parentFrameUrl?: string | null; /** * Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. This field is deprecated. */ - permissions?: string[]; + permissions?: string[] | null; /** * The token value which is used in the hosting page to generate the iframe with the embedded UI. This is a read-only field generated by the server. */ - value?: string; + value?: string | null; } /** * An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified. @@ -1796,11 +1821,11 @@ export namespace androidmanagement_v1 { /** * Whether the factory-reset protection data is preserved on the device. This setting doesn’t apply to work profiles. */ - preserveFrp?: boolean; + preserveFrp?: boolean | null; /** * Number of days the policy is non-compliant before the device or work profile is wiped. wipeAfterDays must be greater than blockAfterDays. */ - wipeAfterDays?: number; + wipeAfterDays?: number | null; } export class Resource$Enterprises { diff --git a/src/apis/androidpublisher/v1.1.ts b/src/apis/androidpublisher/v1.1.ts index 14a3d18c3a6..ee5323f45f4 100644 --- a/src/apis/androidpublisher/v1.1.ts +++ b/src/apis/androidpublisher/v1.1.ts @@ -110,31 +110,31 @@ export namespace androidpublisher_v1_1 { /** * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed */ - consumptionState?: number; + consumptionState?: number | null; /** * A developer-specified string that contains supplemental information about an order. */ - developerPayload?: string; + developerPayload?: string | null; /** * This kind represents an inappPurchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * The order id associated with the purchase of the inapp product. */ - orderId?: string; + orderId?: string | null; /** * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending */ - purchaseState?: number; + purchaseState?: number | null; /** * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). */ - purchaseTime?: string; + purchaseTime?: string | null; /** * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) */ - purchaseType?: number; + purchaseType?: number | null; } /** * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. @@ -143,19 +143,19 @@ export namespace androidpublisher_v1_1 { /** * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ - autoRenewing?: boolean; + autoRenewing?: boolean | null; /** * Time at which the subscription was granted, in milliseconds since the Epoch. */ - initiationTimestampMsec?: string; + initiationTimestampMsec?: string | null; /** * This kind represents a subscriptionPurchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * Time at which the subscription will expire, in milliseconds since the Epoch. */ - validUntilTimestampMsec?: string; + validUntilTimestampMsec?: string | null; } export class Resource$Inapppurchases { diff --git a/src/apis/androidpublisher/v1.ts b/src/apis/androidpublisher/v1.ts index e2c22195760..7fdac88743a 100644 --- a/src/apis/androidpublisher/v1.ts +++ b/src/apis/androidpublisher/v1.ts @@ -108,19 +108,19 @@ export namespace androidpublisher_v1 { /** * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ - autoRenewing?: boolean; + autoRenewing?: boolean | null; /** * Time at which the subscription was granted, in milliseconds since the Epoch. */ - initiationTimestampMsec?: string; + initiationTimestampMsec?: string | null; /** * This kind represents a subscriptionPurchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * Time at which the subscription will expire, in milliseconds since the Epoch. */ - validUntilTimestampMsec?: string; + validUntilTimestampMsec?: string | null; } export class Resource$Purchases { diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index c5fd5c7ff2a..c1e4107a471 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -117,7 +117,7 @@ export namespace androidpublisher_v2 { /** * The version code of the APK, as specified in the APK's manifest file. */ - versionCode?: number; + versionCode?: number | null; } /** * Represents the binary payload of an APK. @@ -126,27 +126,27 @@ export namespace androidpublisher_v2 { /** * A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command. */ - sha1?: string; + sha1?: string | null; /** * A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command. */ - sha256?: string; + sha256?: string | null; } export interface Schema$ApkListing { /** * The language code, in BCP 47 format (eg "en-US"). */ - language?: string; + language?: string | null; /** * Describe what's new in your APK. */ - recentChanges?: string; + recentChanges?: string | null; } export interface Schema$ApkListingsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apkListingsListResponse". */ - kind?: string; + kind?: string | null; listings?: Schema$ApkListing[]; } export interface Schema$ApksAddExternallyHostedRequest { @@ -166,25 +166,25 @@ export namespace androidpublisher_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AppDetails { /** * The user-visible support email for this app. */ - contactEmail?: string; + contactEmail?: string | null; /** * The user-visible support telephone number for this app. */ - contactPhone?: string; + contactPhone?: string | null; /** * The user-visible website for this app. */ - contactWebsite?: string; + contactWebsite?: string | null; /** * Default language code, in BCP 47 format (eg "en-US"). */ - defaultLanguage?: string; + defaultLanguage?: string | null; } /** * Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation. @@ -193,32 +193,32 @@ export namespace androidpublisher_v2 { /** * The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch). */ - expiryTimeSeconds?: string; + expiryTimeSeconds?: string | null; /** * The ID of the edit that can be used in subsequent API calls. */ - id?: string; + id?: string | null; } export interface Schema$Bundle { /** * A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command. */ - sha1?: string; + sha1?: string | null; /** * A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command. */ - sha256?: string; + sha256?: string | null; /** * The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file. */ - versionCode?: number; + versionCode?: number | null; } export interface Schema$BundlesListResponse { bundles?: Schema$Bundle[]; /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#bundlesListResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$Comment { /** @@ -237,7 +237,7 @@ export namespace androidpublisher_v2 { /** * The type of the deobfuscation file. */ - symbolType?: string; + symbolType?: string | null; } export interface Schema$DeobfuscationFilesUploadResponse { deobfuscationFile?: Schema$DeobfuscationFile; @@ -250,63 +250,63 @@ export namespace androidpublisher_v2 { /** * The content of the comment, i.e. reply body. */ - text?: string; + text?: string | null; } export interface Schema$DeviceMetadata { /** * Device CPU make e.g. "Qualcomm" */ - cpuMake?: string; + cpuMake?: string | null; /** * Device CPU model e.g. "MSM8974" */ - cpuModel?: string; + cpuModel?: string | null; /** * Device class (e.g. tablet) */ - deviceClass?: string; + deviceClass?: string | null; /** * OpenGL version */ - glEsVersion?: number; + glEsVersion?: number | null; /** * Device manufacturer (e.g. Motorola) */ - manufacturer?: string; + manufacturer?: string | null; /** * Comma separated list of native platforms (e.g. "arm", "arm7") */ - nativePlatform?: string; + nativePlatform?: string | null; /** * Device model name (e.g. Droid) */ - productName?: string; + productName?: string | null; /** * Device RAM in Megabytes e.g. "2048" */ - ramMb?: number; + ramMb?: number | null; /** * Screen density in DPI */ - screenDensityDpi?: number; + screenDensityDpi?: number | null; /** * Screen height in pixels */ - screenHeightPx?: number; + screenHeightPx?: number | null; /** * Screen width in pixels */ - screenWidthPx?: number; + screenWidthPx?: number | 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. */ - fileSize?: string; + fileSize?: string | null; /** * If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set. */ - referencesVersion?: number; + referencesVersion?: number | null; } export interface Schema$ExpansionFilesUploadResponse { expansionFile?: Schema$ExpansionFile; @@ -318,51 +318,51 @@ export namespace androidpublisher_v2 { /** * The application label. */ - applicationLabel?: string; + applicationLabel?: string | null; /** * A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array. */ - certificateBase64s?: string[]; + certificateBase64s?: string[] | null; /** * The URL at which the APK is hosted. This must be an https URL. */ - externallyHostedUrl?: string; + externallyHostedUrl?: string | null; /** * The SHA1 checksum of this APK, represented as a base64 encoded byte array. */ - fileSha1Base64?: string; + fileSha1Base64?: string | null; /** * The SHA256 checksum of this APK, represented as a base64 encoded byte array. */ - fileSha256Base64?: string; + fileSha256Base64?: string | null; /** * The file size in bytes of this APK. */ - fileSize?: string; + fileSize?: string | null; /** * The icon image from the APK, as a base64 encoded byte array. */ - iconBase64?: string; + iconBase64?: string | null; /** * The maximum SDK supported by this APK (optional). */ - maximumSdk?: number; + maximumSdk?: number | null; /** * The minimum SDK targeted by this APK. */ - minimumSdk?: number; + minimumSdk?: number | null; /** * The native code environments supported by this APK (optional). */ - nativeCodes?: string[]; + nativeCodes?: string[] | null; /** * The package name. */ - packageName?: string; + packageName?: string | null; /** * The features required by this APK (optional). */ - usesFeatures?: string[]; + usesFeatures?: string[] | null; /** * The permissions requested by this APK. */ @@ -370,11 +370,11 @@ export namespace androidpublisher_v2 { /** * The version code of this APK. */ - versionCode?: number; + versionCode?: number | null; /** * The version name of this APK. */ - versionName?: string; + versionName?: string | null; } /** * A permission used by this APK. @@ -383,29 +383,29 @@ export namespace androidpublisher_v2 { /** * Optionally, the maximum SDK version for which the permission is required. */ - maxSdkVersion?: number; + maxSdkVersion?: number | null; /** * The name of the permission requested. */ - name?: string; + name?: string | null; } export interface Schema$Image { /** * A unique id representing this image. */ - id?: string; + id?: string | null; /** * A sha1 hash of the image that was uploaded. */ - sha1?: string; + sha1?: string | null; /** * A sha256 hash of the image that was uploaded. */ - sha256?: string; + sha256?: string | null; /** * A URL that will serve a preview of the image. */ - url?: string; + url?: string | null; } export interface Schema$ImagesDeleteAllResponse { deleted?: Schema$Image[]; @@ -420,7 +420,7 @@ export namespace androidpublisher_v2 { /** * The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". */ - defaultLanguage?: string; + defaultLanguage?: string | null; /** * Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. */ @@ -428,23 +428,23 @@ export namespace androidpublisher_v2 { /** * Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days) */ - gracePeriod?: string; + gracePeriod?: string | null; /** * List of localized title and description data. */ - listings?: {[key: string]: Schema$InAppProductListing}; + listings?: {[key: string]: Schema$InAppProductListing} | null; /** * The package name of the parent app. */ - packageName?: string; + packageName?: string | null; /** * Prices per buyer region. None of these prices should be zero. In-app products can never be free. */ - prices?: {[key: string]: Schema$Price}; + prices?: {[key: string]: Schema$Price} | null; /** * Purchase type enum value. Unmodifiable after creation. */ - purchaseType?: string; + purchaseType?: string | null; /** * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. */ @@ -452,27 +452,27 @@ export namespace androidpublisher_v2 { /** * The stock-keeping-unit (SKU) of the product, unique within an app. */ - sku?: string; - status?: string; + sku?: string | null; + status?: string | null; /** * Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). */ - subscriptionPeriod?: string; + subscriptionPeriod?: string | null; /** * Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. */ - trialPeriod?: string; + trialPeriod?: string | null; } export interface Schema$InAppProductListing { - description?: string; - title?: string; + description?: string | null; + title?: string | null; } export interface Schema$InappproductsListResponse { inappproduct?: Schema$InAppProduct[]; /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse". */ - kind?: string; + kind?: string | null; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; } @@ -480,55 +480,55 @@ export namespace androidpublisher_v2 { /** * Full description of the app; this may be up to 4000 characters in length. */ - fullDescription?: string; + fullDescription?: string | null; /** * Language localization code (for example, "de-AT" for Austrian German). */ - language?: string; + language?: string | null; /** * Short description of the app (previously known as promo text); this may be up to 80 characters in length. */ - shortDescription?: string; + shortDescription?: string | null; /** * App's localized title. */ - title?: string; + title?: string | null; /** * URL of a promotional YouTube video for the app. */ - video?: string; + video?: string | null; } export interface Schema$ListingsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse". */ - kind?: string; + kind?: string | null; listings?: Schema$Listing[]; } export interface Schema$MonthDay { /** * Day of a month, value in [1, 31] range. Valid range depends on the specified month. */ - day?: number; + day?: number | null; /** * Month of a year. e.g. 1 = JAN, 2 = FEB etc. */ - month?: number; + month?: number | null; } export interface Schema$PageInfo { - resultPerPage?: number; - startIndex?: number; - totalResults?: number; + resultPerPage?: number | null; + startIndex?: number | null; + totalResults?: number | null; } export interface Schema$Price { /** * 3 letter Currency code, as defined by ISO 4217. */ - currency?: string; + currency?: string | null; /** * The price in millionths of the currency base unit represented as a string. */ - priceMicros?: string; + priceMicros?: string | null; } /** * A ProductPurchase resource indicates the status of a user's inapp product purchase. @@ -537,31 +537,31 @@ export namespace androidpublisher_v2 { /** * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed */ - consumptionState?: number; + consumptionState?: number | null; /** * A developer-specified string that contains supplemental information about an order. */ - developerPayload?: string; + developerPayload?: string | null; /** * This kind represents an inappPurchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * The order id associated with the purchase of the inapp product. */ - orderId?: string; + orderId?: string | null; /** * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending */ - purchaseState?: number; + purchaseState?: number | null; /** * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). */ - purchaseTimeMillis?: string; + purchaseTimeMillis?: string | null; /** * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) */ - purchaseType?: number; + purchaseType?: number | null; } export interface Schema$Prorate { /** @@ -577,7 +577,7 @@ export namespace androidpublisher_v2 { /** * The name of the user who wrote the review. */ - authorName?: string; + authorName?: string | null; /** * A repeated field containing comments for the review. */ @@ -585,7 +585,7 @@ export namespace androidpublisher_v2 { /** * Unique identifier for this review. */ - reviewId?: string; + reviewId?: string | null; } export interface Schema$ReviewReplyResult { /** @@ -595,7 +595,7 @@ export namespace androidpublisher_v2 { /** * The reply text that was applied. */ - replyText?: string; + replyText?: string | null; } export interface Schema$ReviewsListResponse { pageInfo?: Schema$PageInfo; @@ -606,7 +606,7 @@ export namespace androidpublisher_v2 { /** * The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped. */ - replyText?: string; + replyText?: string | null; } export interface Schema$ReviewsReplyResponse { result?: Schema$ReviewReplyResult; @@ -632,11 +632,11 @@ export namespace androidpublisher_v2 { /** * The cancellation reason the user chose in the survey. Possible values are: - Other - I don't use this service enough - Technical issues - Cost-related reasons - I found a better app */ - cancelSurveyReason?: number; + cancelSurveyReason?: number | null; /** * The customized input cancel reason from the user. Only present when cancelReason is 0. */ - userInputCancelReason?: string; + userInputCancelReason?: string | null; } /** * A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time. @@ -645,11 +645,11 @@ export namespace androidpublisher_v2 { /** * The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription. */ - desiredExpiryTimeMillis?: string; + desiredExpiryTimeMillis?: string | null; /** * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur. */ - expectedExpiryTimeMillis?: string; + expectedExpiryTimeMillis?: string | null; } /** * Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion. @@ -662,7 +662,7 @@ export namespace androidpublisher_v2 { /** * The current state of the price change. Possible values are: - Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. - Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next. */ - state?: number; + state?: number | null; } /** * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. @@ -671,11 +671,11 @@ export namespace androidpublisher_v2 { /** * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ - autoRenewing?: boolean; + autoRenewing?: boolean | null; /** * The reason why a subscription was canceled or is not auto-renewing. Possible values are: - User canceled the subscription - Subscription was canceled by the system, for example because of a billing problem - Subscription was replaced with a new subscription - Subscription was canceled by the developer */ - cancelReason?: number; + cancelReason?: number | null; /** * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ @@ -683,47 +683,47 @@ export namespace androidpublisher_v2 { /** * ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted. */ - countryCode?: string; + countryCode?: string | null; /** * A developer-specified string that contains supplemental information about an order. */ - developerPayload?: string; + developerPayload?: string | null; /** * The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - emailAddress?: string; + emailAddress?: string | null; /** * Time at which the subscription will expire, in milliseconds since the Epoch. */ - expiryTimeMillis?: string; + expiryTimeMillis?: string | null; /** * The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - familyName?: string; + familyName?: string | null; /** * The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - givenName?: string; + givenName?: string | null; /** * This kind represents a subscriptionPurchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * The purchase token of the originating purchase if this subscription is one of the following: - Re-signup of a canceled but non-lapsed subscription - Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set. */ - linkedPurchaseToken?: string; + linkedPurchaseToken?: string | null; /** * The order id of the latest recurring order associated with the purchase of the subscription. */ - orderId?: string; + orderId?: string | null; /** * The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade */ - paymentState?: number; + paymentState?: number | null; /** * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. */ - priceAmountMicros?: string; + priceAmountMicros?: string | null; /** * The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned. */ @@ -731,27 +731,27 @@ export namespace androidpublisher_v2 { /** * ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP". */ - priceCurrencyCode?: string; + priceCurrencyCode?: string | null; /** * The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - profileId?: string; + profileId?: string | null; /** * The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - profileName?: string; + profileName?: string | null; /** * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) */ - purchaseType?: number; + purchaseType?: number | null; /** * Time at which the subscription was granted, in milliseconds since the Epoch. */ - startTimeMillis?: string; + startTimeMillis?: string | null; /** * The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0. */ - userCancellationTimeMillis?: string; + userCancellationTimeMillis?: string | null; } export interface Schema$SubscriptionPurchasesDeferRequest { /** @@ -763,61 +763,57 @@ export namespace androidpublisher_v2 { /** * The new expiry time for the subscription in milliseconds since the Epoch. */ - newExpiryTimeMillis?: string; + newExpiryTimeMillis?: string | null; } export interface Schema$Testers { /** * A list of all Google Groups, as email addresses, that define testers for this track. */ - googleGroups?: string[]; - /** - * A list of all Google+ Communities, as URLs, that define testers for this track. - */ - googlePlusCommunities?: string[]; + googleGroups?: string[] | null; } export interface Schema$Timestamp { - nanos?: number; - seconds?: string; + nanos?: number | null; + seconds?: string | null; } export interface Schema$TokenPagination { - nextPageToken?: string; - previousPageToken?: string; + nextPageToken?: string | null; + previousPageToken?: string | null; } export interface Schema$Track { /** * Identifier for this track. */ - track?: string; - userFraction?: number; + track?: string | null; + userFraction?: number | null; /** * Version codes to make active on this track. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. */ - versionCodes?: number[]; + versionCodes?: number[] | null; } export interface Schema$TracksListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse". */ - kind?: string; + kind?: string | null; tracks?: Schema$Track[]; } export interface Schema$UserComment { /** * Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent. */ - androidOsVersion?: number; + androidOsVersion?: number | null; /** * Integer version code of the app as installed at the time the review was written. May be absent. */ - appVersionCode?: number; + appVersionCode?: number | null; /** * String version name of the app as installed at the time the review was written. May be absent. */ - appVersionName?: string; + appVersionName?: string | null; /** * Codename for the reviewer's device, e.g. klte, flounder. May be absent. */ - device?: string; + device?: string | null; /** * Some information about the characteristics of the user's device */ @@ -829,27 +825,27 @@ export namespace androidpublisher_v2 { /** * Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank. */ - originalText?: string; + originalText?: string | null; /** * Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent. */ - reviewerLanguage?: string; + reviewerLanguage?: string | null; /** * The star rating associated with the review, from 1 to 5. */ - starRating?: number; + starRating?: number | null; /** * The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character. */ - text?: string; + text?: string | null; /** * Number of users who have given this review a thumbs down */ - thumbsDownCount?: number; + thumbsDownCount?: number | null; /** * Number of users who have given this review a thumbs up */ - thumbsUpCount?: number; + thumbsUpCount?: number | null; } /** * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back. @@ -858,19 +854,19 @@ export namespace androidpublisher_v2 { /** * This kind represents a voided purchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970). */ - purchaseTimeMillis?: string; + purchaseTimeMillis?: string | null; /** * The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API). */ - purchaseToken?: string; + purchaseToken?: string | null; /** * The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970). */ - voidedTimeMillis?: string; + voidedTimeMillis?: string | null; } export interface Schema$VoidedPurchasesListResponse { pageInfo?: Schema$PageInfo; diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index b730322bd9a..40b97fe938e 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -121,7 +121,7 @@ export namespace androidpublisher_v3 { /** * The version code of the APK, as specified in the APK's manifest file. */ - versionCode?: number; + versionCode?: number | null; } /** * Represents the binary payload of an APK. @@ -130,11 +130,11 @@ export namespace androidpublisher_v3 { /** * A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command. */ - sha1?: string; + sha1?: string | null; /** * A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command. */ - sha256?: string; + sha256?: string | null; } export interface Schema$ApksAddExternallyHostedRequest { /** @@ -153,25 +153,25 @@ export namespace androidpublisher_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AppDetails { /** * The user-visible support email for this app. */ - contactEmail?: string; + contactEmail?: string | null; /** * The user-visible support telephone number for this app. */ - contactPhone?: string; + contactPhone?: string | null; /** * The user-visible website for this app. */ - contactWebsite?: string; + contactWebsite?: string | null; /** * Default language code, in BCP 47 format (eg "en-US"). */ - defaultLanguage?: string; + defaultLanguage?: string | null; } /** * Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation. @@ -180,32 +180,32 @@ export namespace androidpublisher_v3 { /** * The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch). */ - expiryTimeSeconds?: string; + expiryTimeSeconds?: string | null; /** * The ID of the edit that can be used in subsequent API calls. */ - id?: string; + id?: string | null; } export interface Schema$Bundle { /** * A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command. */ - sha1?: string; + sha1?: string | null; /** * A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command. */ - sha256?: string; + sha256?: string | null; /** * The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file. */ - versionCode?: number; + versionCode?: number | null; } export interface Schema$BundlesListResponse { bundles?: Schema$Bundle[]; /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#bundlesListResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$Comment { /** @@ -218,8 +218,8 @@ export namespace androidpublisher_v3 { userComment?: Schema$UserComment; } export interface Schema$CountryTargeting { - countries?: string[]; - includeRestOfWorld?: boolean; + countries?: string[] | null; + includeRestOfWorld?: boolean | null; } /** * Represents a deobfuscation file. @@ -228,7 +228,7 @@ export namespace androidpublisher_v3 { /** * The type of the deobfuscation file. */ - symbolType?: string; + symbolType?: string | null; } export interface Schema$DeobfuscationFilesUploadResponse { deobfuscationFile?: Schema$DeobfuscationFile; @@ -241,63 +241,63 @@ export namespace androidpublisher_v3 { /** * The content of the comment, i.e. reply body. */ - text?: string; + text?: string | null; } export interface Schema$DeviceMetadata { /** * Device CPU make e.g. "Qualcomm" */ - cpuMake?: string; + cpuMake?: string | null; /** * Device CPU model e.g. "MSM8974" */ - cpuModel?: string; + cpuModel?: string | null; /** * Device class (e.g. tablet) */ - deviceClass?: string; + deviceClass?: string | null; /** * OpenGL version */ - glEsVersion?: number; + glEsVersion?: number | null; /** * Device manufacturer (e.g. Motorola) */ - manufacturer?: string; + manufacturer?: string | null; /** * Comma separated list of native platforms (e.g. "arm", "arm7") */ - nativePlatform?: string; + nativePlatform?: string | null; /** * Device model name (e.g. Droid) */ - productName?: string; + productName?: string | null; /** * Device RAM in Megabytes e.g. "2048" */ - ramMb?: number; + ramMb?: number | null; /** * Screen density in DPI */ - screenDensityDpi?: number; + screenDensityDpi?: number | null; /** * Screen height in pixels */ - screenHeightPx?: number; + screenHeightPx?: number | null; /** * Screen width in pixels */ - screenWidthPx?: number; + screenWidthPx?: number | 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. */ - fileSize?: string; + fileSize?: string | null; /** * If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set. */ - referencesVersion?: number; + referencesVersion?: number | null; } export interface Schema$ExpansionFilesUploadResponse { expansionFile?: Schema$ExpansionFile; @@ -309,51 +309,51 @@ export namespace androidpublisher_v3 { /** * The application label. */ - applicationLabel?: string; + applicationLabel?: string | null; /** * A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array. */ - certificateBase64s?: string[]; + certificateBase64s?: string[] | null; /** * The URL at which the APK is hosted. This must be an https URL. */ - externallyHostedUrl?: string; + externallyHostedUrl?: string | null; /** * The SHA1 checksum of this APK, represented as a base64 encoded byte array. */ - fileSha1Base64?: string; + fileSha1Base64?: string | null; /** * The SHA256 checksum of this APK, represented as a base64 encoded byte array. */ - fileSha256Base64?: string; + fileSha256Base64?: string | null; /** * The file size in bytes of this APK. */ - fileSize?: string; + fileSize?: string | null; /** * The icon image from the APK, as a base64 encoded byte array. */ - iconBase64?: string; + iconBase64?: string | null; /** * The maximum SDK supported by this APK (optional). */ - maximumSdk?: number; + maximumSdk?: number | null; /** * The minimum SDK targeted by this APK. */ - minimumSdk?: number; + minimumSdk?: number | null; /** * The native code environments supported by this APK (optional). */ - nativeCodes?: string[]; + nativeCodes?: string[] | null; /** * The package name. */ - packageName?: string; + packageName?: string | null; /** * The features required by this APK (optional). */ - usesFeatures?: string[]; + usesFeatures?: string[] | null; /** * The permissions requested by this APK. */ @@ -361,11 +361,11 @@ export namespace androidpublisher_v3 { /** * The version code of this APK. */ - versionCode?: number; + versionCode?: number | null; /** * The version name of this APK. */ - versionName?: string; + versionName?: string | null; } /** * A permission used by this APK. @@ -374,29 +374,29 @@ export namespace androidpublisher_v3 { /** * Optionally, the maximum SDK version for which the permission is required. */ - maxSdkVersion?: number; + maxSdkVersion?: number | null; /** * The name of the permission requested. */ - name?: string; + name?: string | null; } export interface Schema$Image { /** * A unique id representing this image. */ - id?: string; + id?: string | null; /** * A sha1 hash of the image that was uploaded. */ - sha1?: string; + sha1?: string | null; /** * A sha256 hash of the image that was uploaded. */ - sha256?: string; + sha256?: string | null; /** * A URL that will serve a preview of the image. */ - url?: string; + url?: string | null; } export interface Schema$ImagesDeleteAllResponse { deleted?: Schema$Image[]; @@ -411,7 +411,7 @@ export namespace androidpublisher_v3 { /** * The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". */ - defaultLanguage?: string; + defaultLanguage?: string | null; /** * Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. */ @@ -419,23 +419,23 @@ export namespace androidpublisher_v3 { /** * Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days) */ - gracePeriod?: string; + gracePeriod?: string | null; /** * List of localized title and description data. */ - listings?: {[key: string]: Schema$InAppProductListing}; + listings?: {[key: string]: Schema$InAppProductListing} | null; /** * The package name of the parent app. */ - packageName?: string; + packageName?: string | null; /** * Prices per buyer region. None of these prices should be zero. In-app products can never be free. */ - prices?: {[key: string]: Schema$Price}; + prices?: {[key: string]: Schema$Price} | null; /** * Purchase type enum value. Unmodifiable after creation. */ - purchaseType?: string; + purchaseType?: string | null; /** * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. */ @@ -443,27 +443,27 @@ export namespace androidpublisher_v3 { /** * The stock-keeping-unit (SKU) of the product, unique within an app. */ - sku?: string; - status?: string; + sku?: string | null; + status?: string | null; /** * Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). */ - subscriptionPeriod?: string; + subscriptionPeriod?: string | null; /** * Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. */ - trialPeriod?: string; + trialPeriod?: string | null; } export interface Schema$InAppProductListing { - description?: string; - title?: string; + description?: string | null; + title?: string | null; } export interface Schema$InappproductsListResponse { inappproduct?: Schema$InAppProduct[]; /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse". */ - kind?: string; + kind?: string | null; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; } @@ -474,15 +474,15 @@ export namespace androidpublisher_v3 { /** * The SHA256 fingerprint of the certificate used to signed the generated artifact. */ - certificateFingerprint?: string; + certificateFingerprint?: string | null; /** * The download URL generated for the uploaded artifact. Users that are authorized to download can follow the link to the Play Store app to install it. */ - downloadUrl?: string; + downloadUrl?: string | null; /** * The SHA-256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command. */ - sha256?: string; + sha256?: string | null; } /** * Contains the introductory price information for a subscription. @@ -491,83 +491,83 @@ export namespace androidpublisher_v3 { /** * Introductory price of the subscription, not including tax. The currency is the same as price_currency_code. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. */ - introductoryPriceAmountMicros?: string; + introductoryPriceAmountMicros?: string | null; /** * ISO 4217 currency code for the introductory subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP". */ - introductoryPriceCurrencyCode?: string; + introductoryPriceCurrencyCode?: string | null; /** * The number of billing period to offer introductory pricing. */ - introductoryPriceCycles?: number; + introductoryPriceCycles?: number | null; /** * Introductory price period, specified in ISO 8601 format. Common values are (but not limited to) "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). */ - introductoryPricePeriod?: string; + introductoryPricePeriod?: string | null; } export interface Schema$Listing { /** * Full description of the app; this may be up to 4000 characters in length. */ - fullDescription?: string; + fullDescription?: string | null; /** * Language localization code (for example, "de-AT" for Austrian German). */ - language?: string; + language?: string | null; /** * Short description of the app (previously known as promo text); this may be up to 80 characters in length. */ - shortDescription?: string; + shortDescription?: string | null; /** * App's localized title. */ - title?: string; + title?: string | null; /** * URL of a promotional YouTube video for the app. */ - video?: string; + video?: string | null; } export interface Schema$ListingsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse". */ - kind?: string; + kind?: string | null; listings?: Schema$Listing[]; } export interface Schema$LocalizedText { /** * The language code, in BCP 47 format (eg "en-US"). */ - language?: string; + language?: string | null; /** * The text in the given `language`. */ - text?: string; + text?: string | null; } export interface Schema$MonthDay { /** * Day of a month, value in [1, 31] range. Valid range depends on the specified month. */ - day?: number; + day?: number | null; /** * Month of a year. e.g. 1 = JAN, 2 = FEB etc. */ - month?: number; + month?: number | null; } export interface Schema$PageInfo { - resultPerPage?: number; - startIndex?: number; - totalResults?: number; + resultPerPage?: number | null; + startIndex?: number | null; + totalResults?: number | null; } export interface Schema$Price { /** * 3 letter Currency code, as defined by ISO 4217. */ - currency?: string; + currency?: string | null; /** * The price in millionths of the currency base unit represented as a string. */ - priceMicros?: string; + priceMicros?: string | null; } /** * A ProductPurchase resource indicates the status of a user's inapp product purchase. @@ -576,41 +576,41 @@ export namespace androidpublisher_v3 { /** * The acknowledgement state of the inapp product. Possible values are: - Yet to be acknowledged - Acknowledged */ - acknowledgementState?: number; + acknowledgementState?: number | null; /** * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed */ - consumptionState?: number; + consumptionState?: number | null; /** * A developer-specified string that contains supplemental information about an order. */ - developerPayload?: string; + developerPayload?: string | null; /** * This kind represents an inappPurchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * The order id associated with the purchase of the inapp product. */ - orderId?: string; + orderId?: string | null; /** * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending */ - purchaseState?: number; + purchaseState?: number | null; /** * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). */ - purchaseTimeMillis?: string; + purchaseTimeMillis?: string | null; /** * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) */ - purchaseType?: number; + purchaseType?: number | null; } export interface Schema$ProductPurchasesAcknowledgeRequest { /** * Payload to attach to the purchase. */ - developerPayload?: string; + developerPayload?: string | null; } export interface Schema$Prorate { /** @@ -626,7 +626,7 @@ export namespace androidpublisher_v3 { /** * The name of the user who wrote the review. */ - authorName?: string; + authorName?: string | null; /** * A repeated field containing comments for the review. */ @@ -634,7 +634,7 @@ export namespace androidpublisher_v3 { /** * Unique identifier for this review. */ - reviewId?: string; + reviewId?: string | null; } export interface Schema$ReviewReplyResult { /** @@ -644,7 +644,7 @@ export namespace androidpublisher_v3 { /** * The reply text that was applied. */ - replyText?: string; + replyText?: string | null; } export interface Schema$ReviewsListResponse { pageInfo?: Schema$PageInfo; @@ -655,7 +655,7 @@ export namespace androidpublisher_v3 { /** * The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped. */ - replyText?: string; + replyText?: string | null; } export interface Schema$ReviewsReplyResponse { result?: Schema$ReviewReplyResult; @@ -681,11 +681,11 @@ export namespace androidpublisher_v3 { /** * The cancellation reason the user chose in the survey. Possible values are: - Other - I don't use this service enough - Technical issues - Cost-related reasons - I found a better app */ - cancelSurveyReason?: number; + cancelSurveyReason?: number | null; /** * The customized input cancel reason from the user. Only present when cancelReason is 0. */ - userInputCancelReason?: string; + userInputCancelReason?: string | null; } /** * A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time. @@ -694,11 +694,11 @@ export namespace androidpublisher_v3 { /** * The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription. */ - desiredExpiryTimeMillis?: string; + desiredExpiryTimeMillis?: string | null; /** * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur. */ - expectedExpiryTimeMillis?: string; + expectedExpiryTimeMillis?: string | null; } /** * Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion. @@ -711,7 +711,7 @@ export namespace androidpublisher_v3 { /** * The current state of the price change. Possible values are: - Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. - Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next. */ - state?: number; + state?: number | null; } /** * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. @@ -720,19 +720,19 @@ export namespace androidpublisher_v3 { /** * The acknowledgement state of the subscription product. Possible values are: - Yet to be acknowledged - Acknowledged */ - acknowledgementState?: number; + acknowledgementState?: number | null; /** * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ - autoRenewing?: boolean; + autoRenewing?: boolean | null; /** * Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription. */ - autoResumeTimeMillis?: string; + autoResumeTimeMillis?: string | null; /** * The reason why a subscription was canceled or is not auto-renewing. Possible values are: - User canceled the subscription - Subscription was canceled by the system, for example because of a billing problem - Subscription was replaced with a new subscription - Subscription was canceled by the developer */ - cancelReason?: number; + cancelReason?: number | null; /** * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ @@ -740,27 +740,27 @@ export namespace androidpublisher_v3 { /** * ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted. */ - countryCode?: string; + countryCode?: string | null; /** * A developer-specified string that contains supplemental information about an order. */ - developerPayload?: string; + developerPayload?: string | null; /** * The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - emailAddress?: string; + emailAddress?: string | null; /** * Time at which the subscription will expire, in milliseconds since the Epoch. */ - expiryTimeMillis?: string; + expiryTimeMillis?: string | null; /** * The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - familyName?: string; + familyName?: string | null; /** * The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - givenName?: string; + givenName?: string | null; /** * Introductory price information of the subscription. This is only present when the subscription was purchased with an introductory price. This field does not indicate the subscription is currently in introductory price period. */ @@ -768,23 +768,23 @@ export namespace androidpublisher_v3 { /** * This kind represents a subscriptionPurchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * The purchase token of the originating purchase if this subscription is one of the following: - Re-signup of a canceled but non-lapsed subscription - Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set. */ - linkedPurchaseToken?: string; + linkedPurchaseToken?: string | null; /** * The order id of the latest recurring order associated with the purchase of the subscription. */ - orderId?: string; + orderId?: string | null; /** * The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade */ - paymentState?: number; + paymentState?: number | null; /** * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. */ - priceAmountMicros?: string; + priceAmountMicros?: string | null; /** * The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned. */ @@ -792,33 +792,33 @@ export namespace androidpublisher_v3 { /** * ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP". */ - priceCurrencyCode?: string; + priceCurrencyCode?: string | null; /** * The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - profileId?: string; + profileId?: string | null; /** * The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ - profileName?: string; + profileName?: string | null; /** * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) */ - purchaseType?: number; + purchaseType?: number | null; /** * Time at which the subscription was granted, in milliseconds since the Epoch. */ - startTimeMillis?: string; + startTimeMillis?: string | null; /** * The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0. */ - userCancellationTimeMillis?: string; + userCancellationTimeMillis?: string | null; } export interface Schema$SubscriptionPurchasesAcknowledgeRequest { /** * Payload to attach to the purchase. */ - developerPayload?: string; + developerPayload?: string | null; } export interface Schema$SubscriptionPurchasesDeferRequest { /** @@ -830,25 +830,21 @@ export namespace androidpublisher_v3 { /** * The new expiry time for the subscription in milliseconds since the Epoch. */ - newExpiryTimeMillis?: string; + newExpiryTimeMillis?: string | null; } export interface Schema$Testers { /** * A list of all Google Groups, as email addresses, that define testers for this track. */ - googleGroups?: string[]; - /** - * A list of all Google+ Communities, as URLs, that define testers for this track. - */ - googlePlusCommunities?: string[]; + googleGroups?: string[] | null; } export interface Schema$Timestamp { - nanos?: number; - seconds?: string; + nanos?: number | null; + seconds?: string | null; } export interface Schema$TokenPagination { - nextPageToken?: string; - previousPageToken?: string; + nextPageToken?: string | null; + previousPageToken?: string | null; } export interface Schema$Track { /** @@ -858,14 +854,14 @@ export namespace androidpublisher_v3 { /** * Identifier for this track. */ - track?: string; + track?: string | null; } export interface Schema$TrackRelease { countryTargeting?: Schema$CountryTargeting; /** * The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. */ - name?: string; + name?: string | null; /** * The description of what is new in the app in this release. */ @@ -873,40 +869,40 @@ export namespace androidpublisher_v3 { /** * The desired status of this release. */ - status?: string; + status?: string | null; /** * Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". */ - userFraction?: number; + userFraction?: number | null; /** * A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. */ - versionCodes?: string[]; + versionCodes?: string[] | null; } export interface Schema$TracksListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse". */ - kind?: string; + kind?: string | null; tracks?: Schema$Track[]; } export interface Schema$UserComment { /** * Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent. */ - androidOsVersion?: number; + androidOsVersion?: number | null; /** * Integer version code of the app as installed at the time the review was written. May be absent. */ - appVersionCode?: number; + appVersionCode?: number | null; /** * String version name of the app as installed at the time the review was written. May be absent. */ - appVersionName?: string; + appVersionName?: string | null; /** * Codename for the reviewer's device, e.g. klte, flounder. May be absent. */ - device?: string; + device?: string | null; /** * Some information about the characteristics of the user's device */ @@ -918,27 +914,27 @@ export namespace androidpublisher_v3 { /** * Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank. */ - originalText?: string; + originalText?: string | null; /** * Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent. */ - reviewerLanguage?: string; + reviewerLanguage?: string | null; /** * The star rating associated with the review, from 1 to 5. */ - starRating?: number; + starRating?: number | null; /** * The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character. */ - text?: string; + text?: string | null; /** * Number of users who have given this review a thumbs down */ - thumbsDownCount?: number; + thumbsDownCount?: number | null; /** * Number of users who have given this review a thumbs up */ - thumbsUpCount?: number; + thumbsUpCount?: number | null; } /** * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back. @@ -947,31 +943,31 @@ export namespace androidpublisher_v3 { /** * This kind represents a voided purchase object in the androidpublisher service. */ - kind?: string; + kind?: string | null; /** * The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal. */ - orderId?: string; + orderId?: string | null; /** * The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970). */ - purchaseTimeMillis?: string; + purchaseTimeMillis?: string | null; /** * The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API). */ - purchaseToken?: string; + purchaseToken?: string | null; /** * The reason why the purchase was voided, possible values are: - Other - Remorse - Not_received - Defective - Accidental_purchase - Fraud - Friendly_fraud - Chargeback */ - voidedReason?: number; + voidedReason?: number | null; /** * The initiator of voided purchase, possible values are: - User - Developer - Google */ - voidedSource?: number; + voidedSource?: number | null; /** * The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970). */ - voidedTimeMillis?: string; + voidedTimeMillis?: string | null; } export interface Schema$VoidedPurchasesListResponse { pageInfo?: Schema$PageInfo; diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 57a0354c198..8bac4c2ddcf 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -124,23 +124,23 @@ export namespace appengine_v1 { /** * Action to take when users access resources that require authentication. Defaults to redirect. */ - authFailAction?: string; + authFailAction?: string | null; /** * Level of login required to access this resource. Defaults to optional. */ - login?: string; + login?: string | null; /** * Path to the script from the application root directory. */ - script?: string; + script?: string | null; /** * Security (HTTPS) enforcement for this URL. */ - securityLevel?: string; + securityLevel?: string | null; /** * URL to serve the endpoint at. */ - url?: string; + url?: string | null; } /** * Uses Google Cloud Endpoints to handle requests. @@ -149,7 +149,7 @@ export namespace appengine_v1 { /** * Path to the script from the application root directory. */ - scriptPath?: string; + scriptPath?: string | null; } /** * An Application resource contains the top-level configuration of an App Engine application. @@ -158,23 +158,23 @@ export namespace appengine_v1 { /** * Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. */ - authDomain?: string; + authDomain?: string | null; /** * Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly */ - codeBucket?: string; + codeBucket?: string | null; /** * Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly */ - defaultBucket?: string; + defaultBucket?: string | null; /** * Cookie expiration policy for this application. */ - defaultCookieExpiration?: string; + defaultCookieExpiration?: string | null; /** * Hostname used to reach this application, as resolved by App Engine.@OutputOnly */ - defaultHostname?: string; + defaultHostname?: string | null; /** * HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. */ @@ -186,24 +186,24 @@ export namespace appengine_v1 { /** * The Google Container Registry domain used for storing managed build docker images for this application. */ - gcrDomain?: string; + gcrDomain?: string | null; iap?: Schema$IdentityAwareProxy; /** * Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp. */ - id?: string; + id?: string | null; /** * Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). */ - locationId?: string; + locationId?: string | null; /** * Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly */ - name?: string; + name?: string | null; /** * Serving status of this application. */ - servingStatus?: string; + servingStatus?: string | null; } /** * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. @@ -216,23 +216,23 @@ export namespace appengine_v1 { /** * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. */ - displayName?: string; + displayName?: string | null; /** * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ - domainMappingsCount?: number; + domainMappingsCount?: number | null; /** * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly */ - domainNames?: string[]; + domainNames?: string[] | null; /** * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly */ - expireTime?: string; + expireTime?: string | null; /** * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly */ - id?: string; + id?: string | null; /** * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly */ @@ -240,11 +240,11 @@ export namespace appengine_v1 { /** * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly */ - name?: string; + name?: string | null; /** * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ - visibleDomainMappings?: string[]; + visibleDomainMappings?: string[] | null; } /** * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home). @@ -253,11 +253,11 @@ export namespace appengine_v1 { /** * Fully qualified domain name of the domain authorized for use. Example: example.com. */ - id?: string; + id?: string | null; /** * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly */ - name?: string; + name?: string | null; } /** * Automatic scaling is based on request rate, response latencies, and other application metrics. @@ -266,7 +266,7 @@ export namespace appengine_v1 { /** * The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. */ - coolDownPeriod?: string; + coolDownPeriod?: string | null; /** * Target scaling by CPU usage. */ @@ -278,31 +278,31 @@ export namespace appengine_v1 { /** * Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value. */ - maxConcurrentRequests?: number; + maxConcurrentRequests?: number | null; /** * Maximum number of idle instances that should be maintained for this version. */ - maxIdleInstances?: number; + maxIdleInstances?: number | null; /** * Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. */ - maxPendingLatency?: string; + maxPendingLatency?: string | null; /** * Maximum number of instances that should be started to handle requests for this version. */ - maxTotalInstances?: number; + maxTotalInstances?: number | null; /** * Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. */ - minIdleInstances?: number; + minIdleInstances?: number | null; /** * Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. */ - minPendingLatency?: string; + minPendingLatency?: string | null; /** * Minimum number of running instances that should be maintained for this version. */ - minTotalInstances?: number; + minTotalInstances?: number | null; /** * Target scaling by network usage. */ @@ -323,11 +323,11 @@ export namespace appengine_v1 { /** * Duration of time after the last request that an instance must wait before the instance is shut down. */ - idleTimeout?: string; + idleTimeout?: string | null; /** * Maximum number of instances to create for this version. */ - maxInstances?: number; + maxInstances?: number | null; } /** * Request message for Firewall.BatchUpdateIngressRules. @@ -354,11 +354,11 @@ export namespace appengine_v1 { /** * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly */ - privateKey?: string; + privateKey?: string | null; /** * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre> */ - publicCertificate?: string; + publicCertificate?: string | null; } /** * Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. @@ -367,11 +367,11 @@ export namespace appengine_v1 { /** * Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. */ - appYamlPath?: string; + appYamlPath?: string | null; /** * The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. */ - cloudBuildTimeout?: string; + cloudBuildTimeout?: string | null; } /** * Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. @@ -380,7 +380,7 @@ export namespace appengine_v1 { /** * URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" */ - image?: string; + image?: string | null; } /** * Target scaling by CPU usage. @@ -389,11 +389,11 @@ export namespace appengine_v1 { /** * Period of time over which CPU utilization is calculated. */ - aggregationWindowLength?: string; + aggregationWindowLength?: string | null; /** * Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. */ - targetUtilization?: number; + targetUtilization?: number | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest. @@ -402,7 +402,7 @@ export namespace appengine_v1 { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest. @@ -411,7 +411,7 @@ export namespace appengine_v1 { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest. @@ -420,7 +420,7 @@ export namespace appengine_v1 { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Request message for Instances.DebugInstance. @@ -429,7 +429,7 @@ export namespace appengine_v1 { /** * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). */ - sshKey?: string; + sshKey?: string | null; } /** * Code and application artifacts used to deploy a version to App Engine. @@ -446,7 +446,7 @@ export namespace appengine_v1 { /** * Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call. */ - files?: {[key: string]: Schema$FileInfo}; + files?: {[key: string]: Schema$FileInfo} | null; /** * The zip file for this deployment, if this is a zip deployment. */ @@ -459,19 +459,19 @@ export namespace appengine_v1 { /** * Target bytes read per second. */ - targetReadBytesPerSecond?: number; + targetReadBytesPerSecond?: number | null; /** * Target ops read per seconds. */ - targetReadOpsPerSecond?: number; + targetReadOpsPerSecond?: number | null; /** * Target bytes written per second. */ - targetWriteBytesPerSecond?: number; + targetWriteBytesPerSecond?: number | null; /** * Target ops written per second. */ - targetWriteOpsPerSecond?: number; + targetWriteOpsPerSecond?: number | null; } /** * A domain serving an App Engine application. @@ -480,11 +480,11 @@ export namespace appengine_v1 { /** * Relative name of the domain serving the application. Example: example.com. */ - id?: string; + id?: string | null; /** * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly */ - name?: string; + name?: string | null; /** * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly */ @@ -505,19 +505,19 @@ export namespace appengine_v1 { /** * Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. */ - configId?: string; + configId?: string | null; /** * Enable or disable trace sampling. By default, this is set to false for enabled. */ - disableTraceSampling?: boolean; + disableTraceSampling?: boolean | null; /** * Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" */ - name?: string; + name?: string | null; /** * Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. */ - rolloutStrategy?: string; + rolloutStrategy?: string | null; } /** * The entrypoint for the application. @@ -526,7 +526,7 @@ export namespace appengine_v1 { /** * The format should be a shell command that can be fed to bash -c. */ - shell?: string; + shell?: string | null; } /** * Custom static error page to be served when an error occurs. @@ -535,15 +535,15 @@ export namespace appengine_v1 { /** * Error condition this handler applies to. */ - errorCode?: string; + errorCode?: string | null; /** * MIME type of file. Defaults to text/html. */ - mimeType?: string; + mimeType?: string | null; /** * Static file content to be served for this error. */ - staticFile?: string; + staticFile?: string | null; } /** * The feature specific settings to be used in the application. These define behaviors that are user configurable. @@ -552,11 +552,11 @@ export namespace appengine_v1 { /** * Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed. */ - splitHealthChecks?: boolean; + splitHealthChecks?: boolean | null; /** * If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image. */ - useContainerOptimizedOs?: boolean; + useContainerOptimizedOs?: boolean | null; } /** * Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. @@ -565,15 +565,15 @@ export namespace appengine_v1 { /** * The MIME type of the file.Defaults to the value from Google Cloud Storage. */ - mimeType?: string; + mimeType?: string | null; /** * The SHA1 hash of the file, in hex. */ - sha1Sum?: string; + sha1Sum?: string | null; /** * URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ - sourceUrl?: string; + sourceUrl?: string | null; } /** * A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. @@ -582,19 +582,19 @@ export namespace appengine_v1 { /** * The action to take on matched requests. */ - action?: string; + action?: string | null; /** * An optional string description of this rule. This field has a maximum length of 100 characters. */ - description?: string; + description?: string | null; /** * A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. */ - priority?: number; + priority?: number | null; /** * IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. */ - sourceRange?: string; + sourceRange?: string | null; } /** * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. @@ -603,31 +603,31 @@ export namespace appengine_v1 { /** * Interval between health checks. */ - checkInterval?: string; + checkInterval?: string | null; /** * Whether to explicitly disable health checks for this instance. */ - disableHealthCheck?: boolean; + disableHealthCheck?: boolean | null; /** * Number of consecutive successful health checks required before receiving traffic. */ - healthyThreshold?: number; + healthyThreshold?: number | null; /** * Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" */ - host?: string; + host?: string | null; /** * Number of consecutive failed health checks required before an instance is restarted. */ - restartThreshold?: number; + restartThreshold?: number | null; /** * Time before the health check is considered failed. */ - timeout?: string; + timeout?: string | null; /** * Number of consecutive failed health checks required before removing traffic. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } /** * Identity-Aware Proxy @@ -636,19 +636,19 @@ export namespace appengine_v1 { /** * Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty. */ - enabled?: boolean; + enabled?: boolean | null; /** * OAuth2 client ID to use for the authentication flow. */ - oauth2ClientId?: string; + oauth2ClientId?: string | null; /** * OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly */ - oauth2ClientSecret?: string; + oauth2ClientSecret?: string | null; /** * Hex-encoded SHA-256 hash of the client secret.@OutputOnly */ - oauth2ClientSecretSha256?: string; + oauth2ClientSecretSha256?: string | null; } /** * An Instance resource is the computing unit that App Engine uses to automatically scale an application. @@ -657,67 +657,67 @@ export namespace appengine_v1 { /** * App Engine release this instance is running on.@OutputOnly */ - appEngineRelease?: string; + appEngineRelease?: string | null; /** * Availability of the instance.@OutputOnly */ - availability?: string; + availability?: string | null; /** * Average latency (ms) over the last minute.@OutputOnly */ - averageLatency?: number; + averageLatency?: number | null; /** * Number of errors since this instance was started.@OutputOnly */ - errors?: number; + errors?: number | null; /** * Relative name of the instance within the version. Example: instance-1.@OutputOnly */ - id?: string; + id?: string | null; /** * Total memory in use (bytes).@OutputOnly */ - memoryUsage?: string; + memoryUsage?: string | null; /** * Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly */ - name?: string; + name?: string | null; /** * Average queries per second (QPS) over the last minute.@OutputOnly */ - qps?: number; + qps?: number | null; /** * Number of requests since this instance was started.@OutputOnly */ - requests?: number; + requests?: number | null; /** * Time that this instance was started.@OutputOnly */ - startTime?: string; + startTime?: string | null; /** * Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmDebugEnabled?: boolean; + vmDebugEnabled?: boolean | null; /** * Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmId?: string; + vmId?: string | null; /** * The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmIp?: string; + vmIp?: string | null; /** * Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmName?: string; + vmName?: string | null; /** * Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmStatus?: string; + vmStatus?: string | null; /** * Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmZoneName?: string; + vmZoneName?: string | null; } /** * Third-party Python runtime library that is required by the application. @@ -726,11 +726,11 @@ export namespace appengine_v1 { /** * Name of the library. Example: "django". */ - name?: string; + name?: string | null; /** * Version of the library to select, or "latest". */ - version?: string; + version?: string | null; } /** * Response message for AuthorizedCertificates.ListAuthorizedCertificates. @@ -743,7 +743,7 @@ export namespace appengine_v1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for AuthorizedDomains.ListAuthorizedDomains. @@ -756,7 +756,7 @@ export namespace appengine_v1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for DomainMappings.ListDomainMappings. @@ -769,7 +769,7 @@ export namespace appengine_v1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for Firewall.ListIngressRules. @@ -782,7 +782,7 @@ export namespace appengine_v1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for Instances.ListInstances. @@ -795,7 +795,7 @@ export namespace appengine_v1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -808,7 +808,7 @@ export namespace appengine_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -817,7 +817,7 @@ export namespace appengine_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -830,7 +830,7 @@ export namespace appengine_v1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The services belonging to the requested application. */ @@ -843,7 +843,7 @@ export namespace appengine_v1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The versions belonging to the requested service. */ @@ -856,31 +856,31 @@ export namespace appengine_v1 { /** * Interval between health checks. */ - checkInterval?: string; + checkInterval?: string | null; /** * Number of consecutive failed checks required before considering the VM unhealthy. */ - failureThreshold?: number; + failureThreshold?: number | null; /** * Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" */ - host?: string; + host?: string | null; /** * The initial delay before starting to execute the checks. */ - initialDelay?: string; + initialDelay?: string | null; /** * The request path. */ - path?: string; + path?: string | null; /** * Number of consecutive successful checks required before considering the VM healthy. */ - successThreshold?: number; + successThreshold?: number | null; /** * Time before the check is considered failed. */ - timeout?: string; + timeout?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -889,23 +889,23 @@ export namespace appengine_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: "us-east1". */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Metadata for the given google.cloud.location.Location. @@ -914,11 +914,11 @@ export namespace appengine_v1 { /** * App Engine flexible environment is available in the given location.@OutputOnly */ - flexibleEnvironmentAvailable?: boolean; + flexibleEnvironmentAvailable?: boolean | null; /** * App Engine standard environment is available in the given location.@OutputOnly */ - standardEnvironmentAvailable?: boolean; + standardEnvironmentAvailable?: boolean | null; } /** * A certificate managed by App Engine. @@ -927,11 +927,11 @@ export namespace appengine_v1 { /** * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly */ - lastRenewalTime?: string; + lastRenewalTime?: string | null; /** * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly */ - status?: string; + status?: string | null; } /** * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. @@ -940,7 +940,7 @@ export namespace appengine_v1 { /** * Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. */ - instances?: number; + instances?: number | null; } /** * Extra network settings. Only applicable in the App Engine flexible environment. @@ -949,23 +949,23 @@ export namespace appengine_v1 { /** * List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. */ - forwardedPorts?: string[]; + forwardedPorts?: string[] | null; /** * Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. */ - instanceTag?: string; + instanceTag?: string | null; /** * Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. */ - name?: string; + name?: string | null; /** * Enable session affinity. Only applicable in the App Engine flexible environment. */ - sessionAffinity?: boolean; + sessionAffinity?: boolean | null; /** * Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. */ - subnetworkName?: string; + subnetworkName?: string | null; } /** * Target scaling by network usage. Only applicable in the App Engine flexible environment. @@ -974,19 +974,19 @@ export namespace appengine_v1 { /** * Target bytes received per second. */ - targetReceivedBytesPerSecond?: number; + targetReceivedBytesPerSecond?: number | null; /** * Target packets received per second. */ - targetReceivedPacketsPerSecond?: number; + targetReceivedPacketsPerSecond?: number | null; /** * Target bytes sent per second. */ - targetSentBytesPerSecond?: number; + targetSentBytesPerSecond?: number | null; /** * Target packets sent per second. */ - targetSentPacketsPerSecond?: number; + targetSentPacketsPerSecond?: number | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -995,7 +995,7 @@ export namespace appengine_v1 { /** * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1003,15 +1003,15 @@ export namespace appengine_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Metadata for the given google.longrunning.Operation. @@ -1021,31 +1021,31 @@ export namespace appengine_v1 { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Metadata for the given google.longrunning.Operation. @@ -1055,31 +1055,31 @@ export namespace appengine_v1 { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Metadata for the given google.longrunning.Operation. @@ -1089,31 +1089,31 @@ export namespace appengine_v1 { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. @@ -1122,31 +1122,31 @@ export namespace appengine_v1 { /** * A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. */ - appStartTimeout?: string; + appStartTimeout?: string | null; /** * Interval between health checks. */ - checkInterval?: string; + checkInterval?: string | null; /** * Number of consecutive failed checks required before removing traffic. */ - failureThreshold?: number; + failureThreshold?: number | null; /** * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" */ - host?: string; + host?: string | null; /** * The request path. */ - path?: string; + path?: string | null; /** * Number of consecutive successful checks required before receiving traffic. */ - successThreshold?: number; + successThreshold?: number | null; /** * Time before the check is considered failed. */ - timeout?: string; + timeout?: string | null; } /** * Request message for 'Applications.RepairApplication'. @@ -1159,11 +1159,11 @@ export namespace appengine_v1 { /** * Target number of concurrent requests. */ - targetConcurrentRequests?: number; + targetConcurrentRequests?: number | null; /** * Target requests per second. */ - targetRequestCountPerSecond?: number; + targetRequestCountPerSecond?: number | null; } /** * A DNS resource record. @@ -1172,15 +1172,15 @@ export namespace appengine_v1 { /** * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. */ - name?: string; + name?: string | null; /** * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ - rrdata?: string; + rrdata?: string | null; /** * Resource record type. Example: AAAA. */ - type?: string; + type?: string | null; } /** * Machine resources for a version. @@ -1189,15 +1189,15 @@ export namespace appengine_v1 { /** * Number of CPU cores needed. */ - cpu?: number; + cpu?: number | null; /** * Disk size (GB) needed. */ - diskGb?: number; + diskGb?: number | null; /** * Memory (GB) needed. */ - memoryGb?: number; + memoryGb?: number | null; /** * User specified volumes. */ @@ -1210,7 +1210,7 @@ export namespace appengine_v1 { /** * Path to the script from the application root directory. */ - scriptPath?: string; + scriptPath?: string | null; } /** * A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service. @@ -1219,11 +1219,11 @@ export namespace appengine_v1 { /** * Relative name of the service within the application. Example: default.@OutputOnly */ - id?: string; + id?: string | null; /** * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly */ - name?: string; + name?: string | null; /** * Mapping that defines fractional HTTP traffic diversion to different versions within the service. */ @@ -1236,15 +1236,15 @@ export namespace appengine_v1 { /** * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345. */ - certificateId?: string; + certificateId?: string | null; /** * ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly */ - pendingManagedCertificateId?: string; + pendingManagedCertificateId?: string | null; /** * SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. */ - sslManagementType?: string; + sslManagementType?: string | null; } /** * Scheduler settings for standard environment. @@ -1253,19 +1253,19 @@ export namespace appengine_v1 { /** * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. */ - maxInstances?: number; + maxInstances?: number | null; /** * Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. */ - minInstances?: number; + minInstances?: number | null; /** * Target CPU utilization ratio to maintain when scaling. */ - targetCpuUtilization?: number; + targetCpuUtilization?: number | null; /** * Target throughput utilization ratio to maintain when scaling */ - targetThroughputUtilization?: number; + targetThroughputUtilization?: number | null; } /** * Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. @@ -1274,31 +1274,31 @@ export namespace appengine_v1 { /** * Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas. */ - applicationReadable?: boolean; + applicationReadable?: boolean | null; /** * Time a static file served by this handler should be cached by web proxies and browsers. */ - expiration?: string; + expiration?: string | null; /** * HTTP headers to use for all responses from these URLs. */ - httpHeaders?: {[key: string]: string}; + httpHeaders?: {[key: string]: string} | null; /** * MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension. */ - mimeType?: string; + mimeType?: string | null; /** * Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern. */ - path?: string; + path?: string | null; /** * Whether this handler should match the request if the file referenced by the handler does not exist. */ - requireMatchingFile?: boolean; + requireMatchingFile?: boolean | null; /** * Regular expression that matches the file paths for all files that should be referenced by this handler. */ - uploadPathRegex?: string; + uploadPathRegex?: 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). @@ -1307,15 +1307,15 @@ export namespace appengine_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. @@ -1324,11 +1324,11 @@ export namespace appengine_v1 { /** * Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits. */ - allocations?: {[key: string]: number}; + allocations?: {[key: string]: number} | null; /** * Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed. */ - shardBy?: string; + shardBy?: string | null; } /** * Rules to match an HTTP request and dispatch that request to a service. @@ -1337,15 +1337,15 @@ export namespace appengine_v1 { /** * Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*". */ - domain?: string; + domain?: string | null; /** * Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters. */ - path?: string; + path?: string | null; /** * Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default. */ - service?: string; + service?: string | null; } /** * URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript. @@ -1358,15 +1358,15 @@ export namespace appengine_v1 { /** * Action to take when users access resources that require authentication. Defaults to redirect. */ - authFailAction?: string; + authFailAction?: string | null; /** * Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. */ - login?: string; + login?: string | null; /** * 30x code to use when performing redirects for the secure field. Defaults to 302. */ - redirectHttpResponseCode?: string; + redirectHttpResponseCode?: string | null; /** * Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". */ @@ -1374,7 +1374,7 @@ export namespace appengine_v1 { /** * Security (HTTPS) enforcement for this URL. */ - securityLevel?: string; + securityLevel?: string | null; /** * Returns the contents of a file, such as an image, as the response. */ @@ -1382,7 +1382,7 @@ export namespace appengine_v1 { /** * URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. */ - urlRegex?: string; + urlRegex?: string | null; } /** * A Version resource is a specific set of source code and configuration files that are deployed into a service. @@ -1403,19 +1403,19 @@ export namespace appengine_v1 { /** * Metadata settings that are supplied to this version to enable beta runtime features. */ - betaSettings?: {[key: string]: string}; + betaSettings?: {[key: string]: string} | null; /** * Email address of the user who created this version.@OutputOnly */ - createdBy?: string; + createdBy?: string | null; /** * Time that this version was created.@OutputOnly */ - createTime?: string; + createTime?: string | null; /** * Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. */ - defaultExpiration?: string; + defaultExpiration?: string | null; /** * Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. */ @@ -1423,7 +1423,7 @@ export namespace appengine_v1 { /** * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly */ - diskUsageBytes?: string; + diskUsageBytes?: string | null; /** * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. */ @@ -1435,11 +1435,11 @@ export namespace appengine_v1 { /** * App Engine execution environment for this version.Defaults to standard. */ - env?: string; + env?: string | null; /** * Environment variables available to the application.Only returned in GET requests if view=FULL is set. */ - envVariables?: {[key: string]: string}; + envVariables?: {[key: string]: string} | null; /** * Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. */ @@ -1455,15 +1455,15 @@ export namespace appengine_v1 { /** * Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". */ - id?: string; + id?: string | null; /** * Before an application can receive email or XMPP messages, the application must be configured to enable the service. */ - inboundServices?: string[]; + inboundServices?: string[] | null; /** * Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. */ - instanceClass?: string; + instanceClass?: string | null; /** * Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. */ @@ -1479,7 +1479,7 @@ export namespace appengine_v1 { /** * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly */ - name?: string; + name?: string | null; /** * Extra network settings. Only applicable in the App Engine flexible environment. */ @@ -1487,7 +1487,7 @@ export namespace appengine_v1 { /** * Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. */ - nobuildFilesRegex?: string; + nobuildFilesRegex?: string | null; /** * Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. */ @@ -1499,35 +1499,35 @@ export namespace appengine_v1 { /** * Desired runtime. Example: python27. */ - runtime?: string; + runtime?: string | null; /** * The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref */ - runtimeApiVersion?: string; + runtimeApiVersion?: string | null; /** * The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. */ - runtimeChannel?: string; + runtimeChannel?: string | null; /** * The path or name of the app's main executable. */ - runtimeMainExecutablePath?: string; + runtimeMainExecutablePath?: string | null; /** * Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. */ - servingStatus?: string; + servingStatus?: string | null; /** * Whether multiple requests can be dispatched to this version at once. */ - threadsafe?: boolean; + threadsafe?: boolean | null; /** * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly */ - versionUrl?: string; + versionUrl?: string | null; /** * Whether to deploy this version in a container on a virtual machine. */ - vm?: boolean; + vm?: boolean | null; /** * Enables VPC connectivity for standard apps. */ @@ -1535,7 +1535,7 @@ export namespace appengine_v1 { /** * The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. */ - zones?: string[]; + zones?: string[] | null; } /** * Volumes mounted within the app container. Only applicable in the App Engine flexible environment. @@ -1544,15 +1544,15 @@ export namespace appengine_v1 { /** * Unique name for the volume. */ - name?: string; + name?: string | null; /** * Volume size in gigabytes. */ - sizeGb?: number; + sizeGb?: number | null; /** * Underlying volume type, e.g. 'tmpfs'. */ - volumeType?: string; + volumeType?: string | null; } /** * VPC access connector specification. @@ -1561,7 +1561,7 @@ export namespace appengine_v1 { /** * Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. */ - name?: string; + name?: string | null; } /** * The zip file information for a zip deployment. @@ -1570,11 +1570,11 @@ export namespace appengine_v1 { /** * An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. */ - filesCount?: number; + filesCount?: number | null; /** * URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ - sourceUrl?: string; + sourceUrl?: string | null; } export class Resource$Apps { diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 2ace0a57892..bb6a197382a 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -128,23 +128,23 @@ export namespace appengine_v1alpha { /** * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. */ - displayName?: string; + displayName?: string | null; /** * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ - domainMappingsCount?: number; + domainMappingsCount?: number | null; /** * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly */ - domainNames?: string[]; + domainNames?: string[] | null; /** * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly */ - expireTime?: string; + expireTime?: string | null; /** * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly */ - id?: string; + id?: string | null; /** * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly */ @@ -152,11 +152,11 @@ export namespace appengine_v1alpha { /** * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly */ - name?: string; + name?: string | null; /** * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ - visibleDomainMappings?: string[]; + visibleDomainMappings?: string[] | null; } /** * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home). @@ -165,11 +165,11 @@ export namespace appengine_v1alpha { /** * Fully qualified domain name of the domain authorized for use. Example: example.com. */ - id?: string; + id?: string | null; /** * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly */ - name?: string; + name?: string | null; } /** * An SSL certificate obtained from a certificate authority. @@ -178,11 +178,11 @@ export namespace appengine_v1alpha { /** * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly */ - privateKey?: string; + privateKey?: string | null; /** * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre> */ - publicCertificate?: string; + publicCertificate?: string | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest. @@ -191,7 +191,7 @@ export namespace appengine_v1alpha { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest. @@ -200,7 +200,7 @@ export namespace appengine_v1alpha { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest. @@ -209,7 +209,7 @@ export namespace appengine_v1alpha { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * A domain serving an App Engine application. @@ -218,11 +218,11 @@ export namespace appengine_v1alpha { /** * Relative name of the domain serving the application. Example: example.com. */ - id?: string; + id?: string | null; /** * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly */ - name?: string; + name?: string | null; /** * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly */ @@ -247,7 +247,7 @@ export namespace appengine_v1alpha { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for AuthorizedDomains.ListAuthorizedDomains. @@ -260,7 +260,7 @@ export namespace appengine_v1alpha { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for DomainMappings.ListDomainMappings. @@ -273,7 +273,7 @@ export namespace appengine_v1alpha { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -286,7 +286,7 @@ export namespace appengine_v1alpha { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -295,7 +295,7 @@ export namespace appengine_v1alpha { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -308,23 +308,23 @@ export namespace appengine_v1alpha { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: "us-east1". */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Metadata for the given google.cloud.location.Location. @@ -333,11 +333,11 @@ export namespace appengine_v1alpha { /** * App Engine flexible environment is available in the given location.@OutputOnly */ - flexibleEnvironmentAvailable?: boolean; + flexibleEnvironmentAvailable?: boolean | null; /** * App Engine standard environment is available in the given location.@OutputOnly */ - standardEnvironmentAvailable?: boolean; + standardEnvironmentAvailable?: boolean | null; } /** * A certificate managed by App Engine. @@ -346,11 +346,11 @@ export namespace appengine_v1alpha { /** * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly */ - lastRenewalTime?: string; + lastRenewalTime?: string | null; /** * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly */ - status?: string; + status?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -359,7 +359,7 @@ export namespace appengine_v1alpha { /** * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -367,15 +367,15 @@ export namespace appengine_v1alpha { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Metadata for the given google.longrunning.Operation. @@ -385,31 +385,31 @@ export namespace appengine_v1alpha { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Metadata for the given google.longrunning.Operation. @@ -419,31 +419,31 @@ export namespace appengine_v1alpha { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Metadata for the given google.longrunning.Operation. @@ -453,31 +453,31 @@ export namespace appengine_v1alpha { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * A DNS resource record. @@ -486,15 +486,15 @@ export namespace appengine_v1alpha { /** * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. */ - name?: string; + name?: string | null; /** * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ - rrdata?: string; + rrdata?: string | null; /** * Resource record type. Example: AAAA. */ - type?: string; + type?: string | null; } /** * SSL configuration for a DomainMapping resource. @@ -503,11 +503,11 @@ export namespace appengine_v1alpha { /** * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345. */ - certificateId?: string; + certificateId?: string | null; /** * Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly */ - isManagedCertificate?: boolean; + isManagedCertificate?: boolean | 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). @@ -516,15 +516,15 @@ export namespace appengine_v1alpha { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Apps { diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 19f476c899a..136f18f6b42 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -124,23 +124,23 @@ export namespace appengine_v1beta { /** * Action to take when users access resources that require authentication. Defaults to redirect. */ - authFailAction?: string; + authFailAction?: string | null; /** * Level of login required to access this resource. Defaults to optional. */ - login?: string; + login?: string | null; /** * Path to the script from the application root directory. */ - script?: string; + script?: string | null; /** * Security (HTTPS) enforcement for this URL. */ - securityLevel?: string; + securityLevel?: string | null; /** * URL to serve the endpoint at. */ - url?: string; + url?: string | null; } /** * Uses Google Cloud Endpoints to handle requests. @@ -149,7 +149,7 @@ export namespace appengine_v1beta { /** * Path to the script from the application root directory. */ - scriptPath?: string; + scriptPath?: string | null; } /** * An Application resource contains the top-level configuration of an App Engine application. @@ -158,23 +158,23 @@ export namespace appengine_v1beta { /** * Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. */ - authDomain?: string; + authDomain?: string | null; /** * Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly */ - codeBucket?: string; + codeBucket?: string | null; /** * Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly */ - defaultBucket?: string; + defaultBucket?: string | null; /** * Cookie expiration policy for this application. */ - defaultCookieExpiration?: string; + defaultCookieExpiration?: string | null; /** * Hostname used to reach this application, as resolved by App Engine.@OutputOnly */ - defaultHostname?: string; + defaultHostname?: string | null; /** * HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. */ @@ -186,24 +186,24 @@ export namespace appengine_v1beta { /** * The Google Container Registry domain used for storing managed build docker images for this application. */ - gcrDomain?: string; + gcrDomain?: string | null; iap?: Schema$IdentityAwareProxy; /** * Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp. */ - id?: string; + id?: string | null; /** * Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). */ - locationId?: string; + locationId?: string | null; /** * Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly */ - name?: string; + name?: string | null; /** * Serving status of this application. */ - servingStatus?: string; + servingStatus?: string | null; } /** * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. @@ -216,23 +216,23 @@ export namespace appengine_v1beta { /** * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. */ - displayName?: string; + displayName?: string | null; /** * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ - domainMappingsCount?: number; + domainMappingsCount?: number | null; /** * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly */ - domainNames?: string[]; + domainNames?: string[] | null; /** * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly */ - expireTime?: string; + expireTime?: string | null; /** * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly */ - id?: string; + id?: string | null; /** * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly */ @@ -240,11 +240,11 @@ export namespace appengine_v1beta { /** * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly */ - name?: string; + name?: string | null; /** * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ - visibleDomainMappings?: string[]; + visibleDomainMappings?: string[] | null; } /** * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home). @@ -253,11 +253,11 @@ export namespace appengine_v1beta { /** * Fully qualified domain name of the domain authorized for use. Example: example.com. */ - id?: string; + id?: string | null; /** * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly */ - name?: string; + name?: string | null; } /** * Automatic scaling is based on request rate, response latencies, and other application metrics. @@ -266,7 +266,7 @@ export namespace appengine_v1beta { /** * The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. */ - coolDownPeriod?: string; + coolDownPeriod?: string | null; /** * Target scaling by CPU usage. */ @@ -282,31 +282,31 @@ export namespace appengine_v1beta { /** * Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value. */ - maxConcurrentRequests?: number; + maxConcurrentRequests?: number | null; /** * Maximum number of idle instances that should be maintained for this version. */ - maxIdleInstances?: number; + maxIdleInstances?: number | null; /** * Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. */ - maxPendingLatency?: string; + maxPendingLatency?: string | null; /** * Maximum number of instances that should be started to handle requests for this version. */ - maxTotalInstances?: number; + maxTotalInstances?: number | null; /** * Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. */ - minIdleInstances?: number; + minIdleInstances?: number | null; /** * Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. */ - minPendingLatency?: string; + minPendingLatency?: string | null; /** * Minimum number of running instances that should be maintained for this version. */ - minTotalInstances?: number; + minTotalInstances?: number | null; /** * Target scaling by network usage. */ @@ -327,11 +327,11 @@ export namespace appengine_v1beta { /** * Duration of time after the last request that an instance must wait before the instance is shut down. */ - idleTimeout?: string; + idleTimeout?: string | null; /** * Maximum number of instances to create for this version. */ - maxInstances?: number; + maxInstances?: number | null; } /** * Request message for Firewall.BatchUpdateIngressRules. @@ -358,7 +358,7 @@ export namespace appengine_v1beta { /** * The Google Cloud Build id. Example: "f966068f-08b2-42c8-bdfe-74137dff2bf9" */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * An SSL certificate obtained from a certificate authority. @@ -367,11 +367,11 @@ export namespace appengine_v1beta { /** * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly */ - privateKey?: string; + privateKey?: string | null; /** * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre> */ - publicCertificate?: string; + publicCertificate?: string | null; } /** * Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. @@ -380,11 +380,11 @@ export namespace appengine_v1beta { /** * Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. */ - appYamlPath?: string; + appYamlPath?: string | null; /** * The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. */ - cloudBuildTimeout?: string; + cloudBuildTimeout?: string | null; } /** * Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. @@ -393,7 +393,7 @@ export namespace appengine_v1beta { /** * URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" */ - image?: string; + image?: string | null; } /** * Target scaling by CPU usage. @@ -402,11 +402,11 @@ export namespace appengine_v1beta { /** * Period of time over which CPU utilization is calculated. */ - aggregationWindowLength?: string; + aggregationWindowLength?: string | null; /** * Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. */ - targetUtilization?: number; + targetUtilization?: number | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest. @@ -415,7 +415,7 @@ export namespace appengine_v1beta { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest. @@ -424,7 +424,7 @@ export namespace appengine_v1beta { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest. @@ -433,7 +433,7 @@ export namespace appengine_v1beta { /** * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ - cloudBuildId?: string; + cloudBuildId?: string | null; } /** * Allows autoscaling based on Stackdriver metrics. @@ -442,23 +442,23 @@ export namespace appengine_v1beta { /** * Allows filtering on the metric's fields. */ - filter?: string; + filter?: string | null; /** * The name of the metric. */ - metricName?: string; + metricName?: string | null; /** * May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment. */ - singleInstanceAssignment?: number; + singleInstanceAssignment?: number | null; /** * The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc. */ - targetType?: string; + targetType?: string | null; /** * The target value for the metric. */ - targetUtilization?: number; + targetUtilization?: number | null; } /** * Request message for Instances.DebugInstance. @@ -467,7 +467,7 @@ export namespace appengine_v1beta { /** * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). */ - sshKey?: string; + sshKey?: string | null; } /** * Code and application artifacts used to deploy a version to App Engine. @@ -488,7 +488,7 @@ export namespace appengine_v1beta { /** * Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call. */ - files?: {[key: string]: Schema$FileInfo}; + files?: {[key: string]: Schema$FileInfo} | null; /** * The zip file for this deployment, if this is a zip deployment. */ @@ -501,19 +501,19 @@ export namespace appengine_v1beta { /** * Target bytes read per second. */ - targetReadBytesPerSecond?: number; + targetReadBytesPerSecond?: number | null; /** * Target ops read per seconds. */ - targetReadOpsPerSecond?: number; + targetReadOpsPerSecond?: number | null; /** * Target bytes written per second. */ - targetWriteBytesPerSecond?: number; + targetWriteBytesPerSecond?: number | null; /** * Target ops written per second. */ - targetWriteOpsPerSecond?: number; + targetWriteOpsPerSecond?: number | null; } /** * A domain serving an App Engine application. @@ -522,11 +522,11 @@ export namespace appengine_v1beta { /** * Relative name of the domain serving the application. Example: example.com. */ - id?: string; + id?: string | null; /** * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly */ - name?: string; + name?: string | null; /** * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly */ @@ -547,19 +547,19 @@ export namespace appengine_v1beta { /** * Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. */ - configId?: string; + configId?: string | null; /** * Enable or disable trace sampling. By default, this is set to false for enabled. */ - disableTraceSampling?: boolean; + disableTraceSampling?: boolean | null; /** * Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" */ - name?: string; + name?: string | null; /** * Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. */ - rolloutStrategy?: string; + rolloutStrategy?: string | null; } /** * The entrypoint for the application. @@ -568,7 +568,7 @@ export namespace appengine_v1beta { /** * The format should be a shell command that can be fed to bash -c. */ - shell?: string; + shell?: string | null; } /** * Custom static error page to be served when an error occurs. @@ -577,15 +577,15 @@ export namespace appengine_v1beta { /** * Error condition this handler applies to. */ - errorCode?: string; + errorCode?: string | null; /** * MIME type of file. Defaults to text/html. */ - mimeType?: string; + mimeType?: string | null; /** * Static file content to be served for this error. */ - staticFile?: string; + staticFile?: string | null; } /** * The feature specific settings to be used in the application. These define behaviors that are user configurable. @@ -594,11 +594,11 @@ export namespace appengine_v1beta { /** * Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed. */ - splitHealthChecks?: boolean; + splitHealthChecks?: boolean | null; /** * If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image. */ - useContainerOptimizedOs?: boolean; + useContainerOptimizedOs?: boolean | null; } /** * Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. @@ -607,15 +607,15 @@ export namespace appengine_v1beta { /** * The MIME type of the file.Defaults to the value from Google Cloud Storage. */ - mimeType?: string; + mimeType?: string | null; /** * The SHA1 hash of the file, in hex. */ - sha1Sum?: string; + sha1Sum?: string | null; /** * URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ - sourceUrl?: string; + sourceUrl?: string | null; } /** * A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. @@ -624,19 +624,19 @@ export namespace appengine_v1beta { /** * The action to take on matched requests. */ - action?: string; + action?: string | null; /** * An optional string description of this rule. This field has a maximum length of 100 characters. */ - description?: string; + description?: string | null; /** * A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. */ - priority?: number; + priority?: number | null; /** * IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. */ - sourceRange?: string; + sourceRange?: string | null; } /** * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. @@ -645,31 +645,31 @@ export namespace appengine_v1beta { /** * Interval between health checks. */ - checkInterval?: string; + checkInterval?: string | null; /** * Whether to explicitly disable health checks for this instance. */ - disableHealthCheck?: boolean; + disableHealthCheck?: boolean | null; /** * Number of consecutive successful health checks required before receiving traffic. */ - healthyThreshold?: number; + healthyThreshold?: number | null; /** * Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" */ - host?: string; + host?: string | null; /** * Number of consecutive failed health checks required before an instance is restarted. */ - restartThreshold?: number; + restartThreshold?: number | null; /** * Time before the health check is considered failed. */ - timeout?: string; + timeout?: string | null; /** * Number of consecutive failed health checks required before removing traffic. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } /** * Identity-Aware Proxy @@ -678,11 +678,11 @@ export namespace appengine_v1beta { /** * Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty. */ - enabled?: boolean; + enabled?: boolean | null; /** * OAuth2 client ID to use for the authentication flow. */ - oauth2ClientId?: string; + oauth2ClientId?: string | null; /** * InputOnly OAuth client info required to generate client id to be used for IAP. */ @@ -690,11 +690,11 @@ export namespace appengine_v1beta { /** * OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly */ - oauth2ClientSecret?: string; + oauth2ClientSecret?: string | null; /** * Hex-encoded SHA-256 hash of the client secret.@OutputOnly */ - oauth2ClientSecretSha256?: string; + oauth2ClientSecretSha256?: string | null; } /** * An Instance resource is the computing unit that App Engine uses to automatically scale an application. @@ -703,67 +703,67 @@ export namespace appengine_v1beta { /** * App Engine release this instance is running on.@OutputOnly */ - appEngineRelease?: string; + appEngineRelease?: string | null; /** * Availability of the instance.@OutputOnly */ - availability?: string; + availability?: string | null; /** * Average latency (ms) over the last minute.@OutputOnly */ - averageLatency?: number; + averageLatency?: number | null; /** * Number of errors since this instance was started.@OutputOnly */ - errors?: number; + errors?: number | null; /** * Relative name of the instance within the version. Example: instance-1.@OutputOnly */ - id?: string; + id?: string | null; /** * Total memory in use (bytes).@OutputOnly */ - memoryUsage?: string; + memoryUsage?: string | null; /** * Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly */ - name?: string; + name?: string | null; /** * Average queries per second (QPS) over the last minute.@OutputOnly */ - qps?: number; + qps?: number | null; /** * Number of requests since this instance was started.@OutputOnly */ - requests?: number; + requests?: number | null; /** * Time that this instance was started.@OutputOnly */ - startTime?: string; + startTime?: string | null; /** * Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmDebugEnabled?: boolean; + vmDebugEnabled?: boolean | null; /** * Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmId?: string; + vmId?: string | null; /** * The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmIp?: string; + vmIp?: string | null; /** * Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmName?: string; + vmName?: string | null; /** * Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmStatus?: string; + vmStatus?: string | null; /** * Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly */ - vmZoneName?: string; + vmZoneName?: string | null; } /** * Third-party Python runtime library that is required by the application. @@ -772,11 +772,11 @@ export namespace appengine_v1beta { /** * Name of the library. Example: "django". */ - name?: string; + name?: string | null; /** * Version of the library to select, or "latest". */ - version?: string; + version?: string | null; } /** * Response message for AuthorizedCertificates.ListAuthorizedCertificates. @@ -789,7 +789,7 @@ export namespace appengine_v1beta { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for AuthorizedDomains.ListAuthorizedDomains. @@ -802,7 +802,7 @@ export namespace appengine_v1beta { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for DomainMappings.ListDomainMappings. @@ -815,7 +815,7 @@ export namespace appengine_v1beta { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for Firewall.ListIngressRules. @@ -828,7 +828,7 @@ export namespace appengine_v1beta { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for Instances.ListInstances. @@ -841,7 +841,7 @@ export namespace appengine_v1beta { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -854,7 +854,7 @@ export namespace appengine_v1beta { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -863,7 +863,7 @@ export namespace appengine_v1beta { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -876,7 +876,7 @@ export namespace appengine_v1beta { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The services belonging to the requested application. */ @@ -889,7 +889,7 @@ export namespace appengine_v1beta { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The versions belonging to the requested service. */ @@ -902,31 +902,31 @@ export namespace appengine_v1beta { /** * Interval between health checks. */ - checkInterval?: string; + checkInterval?: string | null; /** * Number of consecutive failed checks required before considering the VM unhealthy. */ - failureThreshold?: number; + failureThreshold?: number | null; /** * Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" */ - host?: string; + host?: string | null; /** * The initial delay before starting to execute the checks. */ - initialDelay?: string; + initialDelay?: string | null; /** * The request path. */ - path?: string; + path?: string | null; /** * Number of consecutive successful checks required before considering the VM healthy. */ - successThreshold?: number; + successThreshold?: number | null; /** * Time before the check is considered failed. */ - timeout?: string; + timeout?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -935,23 +935,23 @@ export namespace appengine_v1beta { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: "us-east1". */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Metadata for the given google.cloud.location.Location. @@ -960,11 +960,11 @@ export namespace appengine_v1beta { /** * App Engine flexible environment is available in the given location.@OutputOnly */ - flexibleEnvironmentAvailable?: boolean; + flexibleEnvironmentAvailable?: boolean | null; /** * App Engine standard environment is available in the given location.@OutputOnly */ - standardEnvironmentAvailable?: boolean; + standardEnvironmentAvailable?: boolean | null; } /** * A certificate managed by App Engine. @@ -973,11 +973,11 @@ export namespace appengine_v1beta { /** * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly */ - lastRenewalTime?: string; + lastRenewalTime?: string | null; /** * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly */ - status?: string; + status?: string | null; } /** * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. @@ -986,7 +986,7 @@ export namespace appengine_v1beta { /** * Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. */ - instances?: number; + instances?: number | null; } /** * Extra network settings. Only applicable in the App Engine flexible environment. @@ -995,23 +995,23 @@ export namespace appengine_v1beta { /** * List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. */ - forwardedPorts?: string[]; + forwardedPorts?: string[] | null; /** * Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. */ - instanceTag?: string; + instanceTag?: string | null; /** * Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. */ - name?: string; + name?: string | null; /** * Enable session affinity. Only applicable in the App Engine flexible environment. */ - sessionAffinity?: boolean; + sessionAffinity?: boolean | null; /** * Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. */ - subnetworkName?: string; + subnetworkName?: string | null; } /** * Target scaling by network usage. Only applicable in the App Engine flexible environment. @@ -1020,33 +1020,33 @@ export namespace appengine_v1beta { /** * Target bytes received per second. */ - targetReceivedBytesPerSecond?: number; + targetReceivedBytesPerSecond?: number | null; /** * Target packets received per second. */ - targetReceivedPacketsPerSecond?: number; + targetReceivedPacketsPerSecond?: number | null; /** * Target bytes sent per second. */ - targetSentBytesPerSecond?: number; + targetSentBytesPerSecond?: number | null; /** * Target packets sent per second. */ - targetSentPacketsPerSecond?: number; + targetSentPacketsPerSecond?: number | null; } export interface Schema$OAuth2ClientInfo { /** * Application name to be used in OAuth consent screen. */ - applicationName?: string; + applicationName?: string | null; /** * Nameof the client to be generated. Optional - If not provided, the name will be autogenerated by the backend. */ - clientName?: string; + clientName?: string | null; /** * Developer's information to be used in OAuth consent screen. */ - developerEmailAddress?: string; + developerEmailAddress?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1055,7 +1055,7 @@ export namespace appengine_v1beta { /** * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1063,15 +1063,15 @@ export namespace appengine_v1beta { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Metadata for the given google.longrunning.Operation. @@ -1081,31 +1081,31 @@ export namespace appengine_v1beta { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Metadata for the given google.longrunning.Operation. @@ -1115,31 +1115,31 @@ export namespace appengine_v1beta { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Metadata for the given google.longrunning.Operation. @@ -1149,31 +1149,31 @@ export namespace appengine_v1beta { /** * Time that this operation completed.@OutputOnly */ - endTime?: string; + endTime?: string | null; /** * Ephemeral message that may change every time the operation is polled. @OutputOnly */ - ephemeralMessage?: string; + ephemeralMessage?: string | null; /** * Time that this operation was created.@OutputOnly */ - insertTime?: string; + insertTime?: string | null; /** * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly */ - method?: string; + method?: string | null; /** * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ - target?: string; + target?: string | null; /** * User who requested this operation.@OutputOnly */ - user?: string; + user?: string | null; /** * Durable messages that persist on every operation poll. @OutputOnly */ - warning?: string[]; + warning?: string[] | null; } /** * Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. @@ -1182,31 +1182,31 @@ export namespace appengine_v1beta { /** * A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. */ - appStartTimeout?: string; + appStartTimeout?: string | null; /** * Interval between health checks. */ - checkInterval?: string; + checkInterval?: string | null; /** * Number of consecutive failed checks required before removing traffic. */ - failureThreshold?: number; + failureThreshold?: number | null; /** * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" */ - host?: string; + host?: string | null; /** * The request path. */ - path?: string; + path?: string | null; /** * Number of consecutive successful checks required before receiving traffic. */ - successThreshold?: number; + successThreshold?: number | null; /** * Time before the check is considered failed. */ - timeout?: string; + timeout?: string | null; } /** * Request message for 'Applications.RepairApplication'. @@ -1219,11 +1219,11 @@ export namespace appengine_v1beta { /** * Target number of concurrent requests. */ - targetConcurrentRequests?: number; + targetConcurrentRequests?: number | null; /** * Target requests per second. */ - targetRequestCountPerSecond?: number; + targetRequestCountPerSecond?: number | null; } /** * A DNS resource record. @@ -1232,15 +1232,15 @@ export namespace appengine_v1beta { /** * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. */ - name?: string; + name?: string | null; /** * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ - rrdata?: string; + rrdata?: string | null; /** * Resource record type. Example: AAAA. */ - type?: string; + type?: string | null; } /** * Machine resources for a version. @@ -1249,15 +1249,15 @@ export namespace appengine_v1beta { /** * Number of CPU cores needed. */ - cpu?: number; + cpu?: number | null; /** * Disk size (GB) needed. */ - diskGb?: number; + diskGb?: number | null; /** * Memory (GB) needed. */ - memoryGb?: number; + memoryGb?: number | null; /** * User specified volumes. */ @@ -1270,7 +1270,7 @@ export namespace appengine_v1beta { /** * Path to the script from the application root directory. */ - scriptPath?: string; + scriptPath?: string | null; } /** * A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service. @@ -1279,11 +1279,11 @@ export namespace appengine_v1beta { /** * Relative name of the service within the application. Example: default.@OutputOnly */ - id?: string; + id?: string | null; /** * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly */ - name?: string; + name?: string | null; /** * Mapping that defines fractional HTTP traffic diversion to different versions within the service. */ @@ -1296,15 +1296,15 @@ export namespace appengine_v1beta { /** * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345. */ - certificateId?: string; + certificateId?: string | null; /** * ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly */ - pendingManagedCertificateId?: string; + pendingManagedCertificateId?: string | null; /** * SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. */ - sslManagementType?: string; + sslManagementType?: string | null; } /** * Scheduler settings for standard environment. @@ -1313,19 +1313,19 @@ export namespace appengine_v1beta { /** * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. */ - maxInstances?: number; + maxInstances?: number | null; /** * Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. */ - minInstances?: number; + minInstances?: number | null; /** * Target CPU utilization ratio to maintain when scaling. */ - targetCpuUtilization?: number; + targetCpuUtilization?: number | null; /** * Target throughput utilization ratio to maintain when scaling */ - targetThroughputUtilization?: number; + targetThroughputUtilization?: number | null; } /** * Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. @@ -1334,31 +1334,31 @@ export namespace appengine_v1beta { /** * Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas. */ - applicationReadable?: boolean; + applicationReadable?: boolean | null; /** * Time a static file served by this handler should be cached by web proxies and browsers. */ - expiration?: string; + expiration?: string | null; /** * HTTP headers to use for all responses from these URLs. */ - httpHeaders?: {[key: string]: string}; + httpHeaders?: {[key: string]: string} | null; /** * MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension. */ - mimeType?: string; + mimeType?: string | null; /** * Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern. */ - path?: string; + path?: string | null; /** * Whether this handler should match the request if the file referenced by the handler does not exist. */ - requireMatchingFile?: boolean; + requireMatchingFile?: boolean | null; /** * Regular expression that matches the file paths for all files that should be referenced by this handler. */ - uploadPathRegex?: string; + uploadPathRegex?: 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). @@ -1367,15 +1367,15 @@ export namespace appengine_v1beta { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. @@ -1384,11 +1384,11 @@ export namespace appengine_v1beta { /** * Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits. */ - allocations?: {[key: string]: number}; + allocations?: {[key: string]: number} | null; /** * Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed. */ - shardBy?: string; + shardBy?: string | null; } /** * Rules to match an HTTP request and dispatch that request to a service. @@ -1397,15 +1397,15 @@ export namespace appengine_v1beta { /** * Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*". */ - domain?: string; + domain?: string | null; /** * Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters. */ - path?: string; + path?: string | null; /** * Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default. */ - service?: string; + service?: string | null; } /** * URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript. @@ -1418,15 +1418,15 @@ export namespace appengine_v1beta { /** * Action to take when users access resources that require authentication. Defaults to redirect. */ - authFailAction?: string; + authFailAction?: string | null; /** * Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. */ - login?: string; + login?: string | null; /** * 30x code to use when performing redirects for the secure field. Defaults to 302. */ - redirectHttpResponseCode?: string; + redirectHttpResponseCode?: string | null; /** * Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". */ @@ -1434,7 +1434,7 @@ export namespace appengine_v1beta { /** * Security (HTTPS) enforcement for this URL. */ - securityLevel?: string; + securityLevel?: string | null; /** * Returns the contents of a file, such as an image, as the response. */ @@ -1442,7 +1442,7 @@ export namespace appengine_v1beta { /** * URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. */ - urlRegex?: string; + urlRegex?: string | null; } /** * A Version resource is a specific set of source code and configuration files that are deployed into a service. @@ -1463,19 +1463,19 @@ export namespace appengine_v1beta { /** * Metadata settings that are supplied to this version to enable beta runtime features. */ - betaSettings?: {[key: string]: string}; + betaSettings?: {[key: string]: string} | null; /** * Email address of the user who created this version.@OutputOnly */ - createdBy?: string; + createdBy?: string | null; /** * Time that this version was created.@OutputOnly */ - createTime?: string; + createTime?: string | null; /** * Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. */ - defaultExpiration?: string; + defaultExpiration?: string | null; /** * Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. */ @@ -1483,7 +1483,7 @@ export namespace appengine_v1beta { /** * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly */ - diskUsageBytes?: string; + diskUsageBytes?: string | null; /** * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. */ @@ -1495,11 +1495,11 @@ export namespace appengine_v1beta { /** * App Engine execution environment for this version.Defaults to standard. */ - env?: string; + env?: string | null; /** * Environment variables available to the application.Only returned in GET requests if view=FULL is set. */ - envVariables?: {[key: string]: string}; + envVariables?: {[key: string]: string} | null; /** * Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. */ @@ -1515,15 +1515,15 @@ export namespace appengine_v1beta { /** * Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". */ - id?: string; + id?: string | null; /** * Before an application can receive email or XMPP messages, the application must be configured to enable the service. */ - inboundServices?: string[]; + inboundServices?: string[] | null; /** * Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. */ - instanceClass?: string; + instanceClass?: string | null; /** * Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. */ @@ -1539,7 +1539,7 @@ export namespace appengine_v1beta { /** * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly */ - name?: string; + name?: string | null; /** * Extra network settings. Only applicable in the App Engine flexible environment. */ @@ -1547,7 +1547,7 @@ export namespace appengine_v1beta { /** * Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. */ - nobuildFilesRegex?: string; + nobuildFilesRegex?: string | null; /** * Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. */ @@ -1559,35 +1559,35 @@ export namespace appengine_v1beta { /** * Desired runtime. Example: python27. */ - runtime?: string; + runtime?: string | null; /** * The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref */ - runtimeApiVersion?: string; + runtimeApiVersion?: string | null; /** * The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. */ - runtimeChannel?: string; + runtimeChannel?: string | null; /** * The path or name of the app's main executable. */ - runtimeMainExecutablePath?: string; + runtimeMainExecutablePath?: string | null; /** * Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. */ - servingStatus?: string; + servingStatus?: string | null; /** * Whether multiple requests can be dispatched to this version at once. */ - threadsafe?: boolean; + threadsafe?: boolean | null; /** * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly */ - versionUrl?: string; + versionUrl?: string | null; /** * Whether to deploy this version in a container on a virtual machine. */ - vm?: boolean; + vm?: boolean | null; /** * Enables VPC connectivity for standard apps. */ @@ -1595,7 +1595,7 @@ export namespace appengine_v1beta { /** * The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. */ - zones?: string[]; + zones?: string[] | null; } /** * Volumes mounted within the app container. Only applicable in the App Engine flexible environment. @@ -1604,15 +1604,15 @@ export namespace appengine_v1beta { /** * Unique name for the volume. */ - name?: string; + name?: string | null; /** * Volume size in gigabytes. */ - sizeGb?: number; + sizeGb?: number | null; /** * Underlying volume type, e.g. 'tmpfs'. */ - volumeType?: string; + volumeType?: string | null; } /** * VPC access connector specification. @@ -1621,7 +1621,7 @@ export namespace appengine_v1beta { /** * Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. */ - name?: string; + name?: string | null; } /** * The zip file information for a zip deployment. @@ -1630,11 +1630,11 @@ export namespace appengine_v1beta { /** * An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. */ - filesCount?: number; + filesCount?: number | null; /** * URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ - sourceUrl?: string; + sourceUrl?: string | null; } export class Resource$Apps { diff --git a/src/apis/appsactivity/v1.ts b/src/apis/appsactivity/v1.ts index 89c633aedfd..ab8fd0b3da6 100644 --- a/src/apis/appsactivity/v1.ts +++ b/src/apis/appsactivity/v1.ts @@ -121,15 +121,15 @@ export namespace appsactivity_v1 { /** * Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event. */ - additionalEventTypes?: string[]; + additionalEventTypes?: string[] | null; /** * The time at which the event occurred formatted as Unix time in milliseconds. */ - eventTimeMillis?: string; + eventTimeMillis?: string | null; /** * Whether this event is caused by a user being deleted. */ - fromUserDeletion?: boolean; + fromUserDeletion?: boolean | null; /** * Extra information for move type events, such as changes in an object's parents. */ @@ -141,7 +141,7 @@ export namespace appsactivity_v1 { /** * The main type of event that occurred. */ - primaryEventType?: string; + primaryEventType?: string | null; /** * Extra information for rename type events, such as the old and new names. */ @@ -166,7 +166,7 @@ export namespace appsactivity_v1 { /** * Token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains information about changes in an object's parents as a result of a move type event. @@ -188,15 +188,15 @@ export namespace appsactivity_v1 { /** * The parent's ID. */ - id?: string; + id?: string | null; /** * Whether this is the root folder. */ - isRoot?: boolean; + isRoot?: boolean | null; /** * The parent's title. */ - title?: string; + title?: string | null; } /** * Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object. @@ -205,19 +205,19 @@ export namespace appsactivity_v1 { /** * The name of the user or group the permission applies to. */ - name?: string; + name?: string | null; /** * The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource. */ - permissionId?: string; + permissionId?: string | null; /** * Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file. */ - role?: string; + role?: string | null; /** * Indicates how widely permissions are granted. */ - type?: string; + type?: string | null; /** * The user's information if the type is USER. */ @@ -225,7 +225,7 @@ export namespace appsactivity_v1 { /** * Whether the permission requires a link to the file. */ - withLink?: boolean; + withLink?: boolean | null; } /** * Contains information about a Drive object's permissions that changed as a result of a permissionChange type event. @@ -247,7 +247,7 @@ export namespace appsactivity_v1 { /** * The URL of the photo. */ - url?: string; + url?: string | null; } /** * Contains information about a renametype event. @@ -256,11 +256,11 @@ export namespace appsactivity_v1 { /** * The new title. */ - newTitle?: string; + newTitle?: string | null; /** * The old title. */ - oldTitle?: string; + oldTitle?: string | null; } /** * Information about the object modified by the event. @@ -269,15 +269,15 @@ export namespace appsactivity_v1 { /** * The ID of the target. For example, in Google Drive, this is the file or folder ID. */ - id?: string; + id?: string | null; /** * The MIME type of the target. */ - mimeType?: string; + mimeType?: string | null; /** * The name of the target. For example, in Google Drive, this is the title of the file. */ - name?: string; + name?: string | null; } /** * A representation of a user. @@ -286,19 +286,19 @@ export namespace appsactivity_v1 { /** * A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted. */ - isDeleted?: boolean; + isDeleted?: boolean | null; /** * Whether the user is the authenticated user. */ - isMe?: boolean; + isMe?: boolean | null; /** * The displayable name of the user. */ - name?: string; + name?: string | null; /** * The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource. */ - permissionId?: string; + permissionId?: string | null; /** * The profile photo of the user. Not present if the user has no profile photo. */ diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index f2fe7486fac..3a1563b4f94 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -120,31 +120,31 @@ export namespace bigquery_v2 { /** * Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric. */ - accuracy?: number; + accuracy?: number | null; /** * The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric. */ - f1Score?: number; + f1Score?: number | null; /** * Logarithmic Loss. For multiclass this is a macro-averaged metric. */ - logLoss?: number; + logLoss?: number | null; /** * Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. */ - precision?: number; + precision?: number | null; /** * Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. */ - recall?: number; + recall?: number | null; /** * Area Under a ROC Curve. For multiclass this is a macro-averaged metric. */ - rocAuc?: number; + rocAuc?: number | null; /** * Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. */ - threshold?: number; + threshold?: number | null; } /** * Input/output argument of a function or a stored procedure. @@ -153,7 +153,7 @@ export namespace bigquery_v2 { /** * Optional. Defaults to FIXED_TYPE. */ - argumentKind?: string; + argumentKind?: string | null; /** * Required unless argument_kind = ANY_TYPE. */ @@ -161,44 +161,44 @@ export namespace bigquery_v2 { /** * Optional. Specifies whether the argument is input or output. Can be set for procedures only. */ - mode?: string; + mode?: string | null; /** * Optional. The name of this argument. Can be absent for function return argument. */ - name?: string; + name?: string | null; } export interface Schema$BigQueryModelTraining { /** * [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. */ - currentIteration?: number; + currentIteration?: number | null; /** * [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. */ - expectedTotalIterations?: string; + expectedTotalIterations?: string | null; } export interface Schema$BigtableColumn { /** * [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. */ - encoding?: string; + encoding?: string | null; /** * [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. */ - fieldName?: string; + fieldName?: string | null; /** * [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. */ - onlyReadLatest?: boolean; + onlyReadLatest?: boolean | null; /** * [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. */ - qualifierEncoded?: string; - qualifierString?: string; + qualifierEncoded?: string | null; + qualifierString?: string | null; /** * [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. */ - type?: string; + type?: string | null; } export interface Schema$BigtableColumnFamily { /** @@ -208,19 +208,19 @@ export namespace bigquery_v2 { /** * [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */ - encoding?: string; + encoding?: string | null; /** * Identifier of the column family. */ - familyId?: string; + familyId?: string | null; /** * [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. */ - onlyReadLatest?: boolean; + onlyReadLatest?: boolean | null; /** * [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. */ - type?: string; + type?: string | null; } export interface Schema$BigtableOptions { /** @@ -230,11 +230,11 @@ export namespace bigquery_v2 { /** * [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false. */ - ignoreUnspecifiedColumnFamilies?: boolean; + ignoreUnspecifiedColumnFamilies?: boolean | null; /** * [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false. */ - readRowkeyAsString?: boolean; + readRowkeyAsString?: boolean | null; } /** * Evaluation metrics for binary classification/classifier models. @@ -251,11 +251,11 @@ export namespace bigquery_v2 { /** * Label representing the negative class. */ - negativeLabel?: string; + negativeLabel?: string | null; /** * Label representing the positive class. */ - positiveLabel?: string; + positiveLabel?: string | null; } /** * Confusion matrix for binary classification models. @@ -264,61 +264,61 @@ export namespace bigquery_v2 { /** * The fraction of predictions given the correct label. */ - accuracy?: number; + accuracy?: number | null; /** * The equally weighted average of recall and precision. */ - f1Score?: number; + f1Score?: number | null; /** * Number of false samples predicted as false. */ - falseNegatives?: string; + falseNegatives?: string | null; /** * Number of false samples predicted as true. */ - falsePositives?: string; + falsePositives?: string | null; /** * Threshold value used when computing each of the following metric. */ - positiveClassThreshold?: number; + positiveClassThreshold?: number | null; /** * The fraction of actual positive predictions that had positive actual labels. */ - precision?: number; + precision?: number | null; /** * The fraction of actual positive labels that were given a positive prediction. */ - recall?: number; + recall?: number | null; /** * Number of true samples predicted as false. */ - trueNegatives?: string; + trueNegatives?: string | null; /** * Number of true samples predicted as true. */ - truePositives?: string; + truePositives?: string | null; } export interface Schema$BqmlIterationResult { /** * [Output-only, Beta] Time taken to run the training iteration in milliseconds. */ - durationMs?: string; + durationMs?: string | null; /** * [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows. */ - evalLoss?: number; + evalLoss?: number | null; /** * [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run. */ - index?: number; + index?: number | null; /** * [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant. */ - learnRate?: number; + learnRate?: number | null; /** * [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type. */ - trainingLoss?: number; + trainingLoss?: number | null; } export interface Schema$BqmlTrainingRun { /** @@ -328,11 +328,11 @@ export namespace bigquery_v2 { /** * [Output-only, Beta] Training run start time in milliseconds since the epoch. */ - startTime?: string; + startTime?: string | null; /** * [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user. */ - state?: string; + state?: string | null; /** * [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. */ @@ -342,11 +342,11 @@ export namespace bigquery_v2 { learnRate?: number; minRelProgress?: number; l2Reg?: number; - warmStart?: boolean; learnRateStrategy?: string; + warmStart?: boolean; lineSearchInitLearnRate?: number; earlyStop?: boolean; - }; + } | null; } /** * Representative value of a categorical feature. @@ -364,11 +364,11 @@ export namespace bigquery_v2 { /** * The name of category. */ - category?: string; + category?: string | null; /** * The count of training samples matching the category within the cluster. */ - count?: string; + count?: string | null; } /** * Message containing the information about one cluster. @@ -377,11 +377,11 @@ export namespace bigquery_v2 { /** * Centroid id. */ - centroidId?: string; + centroidId?: string | null; /** * Count of training data rows that were assigned to this cluster. */ - count?: string; + count?: string | null; /** * Values of highly variant features for this cluster. */ @@ -394,21 +394,21 @@ export namespace bigquery_v2 { /** * Centroid id. */ - centroidId?: string; + centroidId?: string | null; /** * Cluster radius, the average distance from centroid to each point assigned to the cluster. */ - clusterRadius?: number; + clusterRadius?: number | null; /** * Cluster size, the total number of points assigned to the cluster. */ - clusterSize?: string; + clusterSize?: string | null; } export interface Schema$Clustering { /** * [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. */ - fields?: string[]; + fields?: string[] | null; } /** * Evaluation metrics for clustering models. @@ -421,11 +421,11 @@ export namespace bigquery_v2 { /** * Davies-Bouldin index. */ - daviesBouldinIndex?: number; + daviesBouldinIndex?: number | null; /** * Mean of squared distances between each sample to its cluster centroid. */ - meanSquaredDistance?: number; + meanSquaredDistance?: number | null; } /** * Confusion matrix for multi-class classification models. @@ -434,7 +434,7 @@ export namespace bigquery_v2 { /** * Confidence threshold used when computing the entries of the confusion matrix. */ - confidenceThreshold?: number; + confidenceThreshold?: number | null; /** * One row per actual label. */ @@ -444,45 +444,45 @@ export namespace bigquery_v2 { /** * [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. */ - allowJaggedRows?: boolean; + allowJaggedRows?: boolean | null; /** * [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. */ - allowQuotedNewlines?: boolean; + allowQuotedNewlines?: boolean | null; /** * [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. */ - encoding?: string; + encoding?: string | null; /** * [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). */ - fieldDelimiter?: string; + fieldDelimiter?: string | null; /** * [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. */ - quote?: string; + quote?: string | null; /** * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. */ - skipLeadingRows?: string; + skipLeadingRows?: string | null; } export interface Schema$Dataset { /** * [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<{ - userByEmail?: string; - domain?: string; - iamMember?: string; - specialGroup?: string; role?: string; view?: Schema$TableReference; groupByEmail?: string; - }>; + domain?: string; + userByEmail?: string; + iamMember?: string; + specialGroup?: string; + }> | null; /** * [Output-only] The time when this dataset was created, in milliseconds since the epoch. */ - creationTime?: string; + creationTime?: string | null; /** * [Required] A reference that identifies the dataset. */ @@ -491,102 +491,102 @@ export namespace bigquery_v2 { /** * [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property. */ - defaultPartitionExpirationMs?: string; + defaultPartitionExpirationMs?: string | null; /** * [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property. */ - defaultTableExpirationMs?: string; + defaultTableExpirationMs?: string | null; /** * [Optional] A user-friendly description of the dataset. */ - description?: string; + description?: string | null; /** * [Output-only] A hash of the resource. */ - etag?: string; + etag?: string | null; /** * [Optional] A descriptive name for the dataset. */ - friendlyName?: string; + friendlyName?: string | null; /** * [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. */ - id?: string; + id?: string | null; /** * [Output-only] The resource type. */ - kind?: string; + kind?: string | null; /** * The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations. */ - location?: string; + location?: string | null; /** * [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$DatasetList { /** * An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. */ datasets?: Array<{ - labels?: {[key: string]: string}; datasetReference?: Schema$DatasetReference; id?: string; location?: string; friendlyName?: string; kind?: string; - }>; + labels?: {[key: string]: string}; + }> | null; /** * A hash value of the results page. You can use this property to determine if the page has changed since the last request. */ - etag?: string; + etag?: string | null; /** * The list type. This property always returns the value "bigquery#datasetList". */ - kind?: string; + kind?: string | null; /** * A token that can be used to request the next results page. This property is omitted on the final results page. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$DatasetReference { /** * [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. */ - datasetId?: string; + datasetId?: string | null; /** * [Optional] The ID of the project containing this dataset. */ - projectId?: string; + projectId?: string | null; } export interface Schema$DestinationTableProperties { /** * [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. */ - description?: string; + description?: string | null; /** * [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail. */ - friendlyName?: string; + friendlyName?: string | null; /** * [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } export interface Schema$EncryptionConfiguration { /** * [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. */ - kmsKeyName?: string; + kmsKeyName?: string | null; } /** * A single entry in the confusion matrix. @@ -595,29 +595,29 @@ export namespace bigquery_v2 { /** * Number of items being predicted as this label. */ - itemCount?: string; + itemCount?: string | null; /** * The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold. */ - predictedLabel?: string; + predictedLabel?: string | null; } export interface Schema$ErrorProto { /** * Debugging information. This property is internal to Google and should not be used. */ - debugInfo?: string; + debugInfo?: string | null; /** * Specifies where the error occurred, if present. */ - location?: string; + location?: string | null; /** * A human-readable description of the error. */ - message?: string; + message?: string | null; /** * A short error code that summarizes the error. */ - reason?: string; + reason?: string | null; } /** * Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. @@ -644,83 +644,83 @@ export namespace bigquery_v2 { /** * Number of parallel input segments completed. */ - completedParallelInputs?: string; + completedParallelInputs?: string | null; /** * Milliseconds the average shard spent on CPU-bound tasks. */ - computeMsAvg?: string; + computeMsAvg?: string | null; /** * Milliseconds the slowest shard spent on CPU-bound tasks. */ - computeMsMax?: string; + computeMsMax?: string | null; /** * Relative amount of time the average shard spent on CPU-bound tasks. */ - computeRatioAvg?: number; + computeRatioAvg?: number | null; /** * Relative amount of time the slowest shard spent on CPU-bound tasks. */ - computeRatioMax?: number; + computeRatioMax?: number | null; /** * Stage end time represented as milliseconds since epoch. */ - endMs?: string; + endMs?: string | null; /** * Unique ID for stage within plan. */ - id?: string; + id?: string | null; /** * IDs for stages that are inputs to this stage. */ - inputStages?: string[]; + inputStages?: string[] | null; /** * Human-readable name for stage. */ - name?: string; + name?: string | null; /** * Number of parallel input segments to be processed. */ - parallelInputs?: string; + parallelInputs?: string | null; /** * Milliseconds the average shard spent reading input. */ - readMsAvg?: string; + readMsAvg?: string | null; /** * Milliseconds the slowest shard spent reading input. */ - readMsMax?: string; + readMsMax?: string | null; /** * Relative amount of time the average shard spent reading input. */ - readRatioAvg?: number; + readRatioAvg?: number | null; /** * Relative amount of time the slowest shard spent reading input. */ - readRatioMax?: number; + readRatioMax?: number | null; /** * Number of records read into the stage. */ - recordsRead?: string; + recordsRead?: string | null; /** * Number of records written by the stage. */ - recordsWritten?: string; + recordsWritten?: string | null; /** * Total number of bytes written to shuffle. */ - shuffleOutputBytes?: string; + shuffleOutputBytes?: string | null; /** * Total number of bytes written to shuffle and spilled to disk. */ - shuffleOutputBytesSpilled?: string; + shuffleOutputBytesSpilled?: string | null; /** * Stage start time represented as milliseconds since epoch. */ - startMs?: string; + startMs?: string | null; /** * Current status for the stage. */ - status?: string; + status?: string | null; /** * List of operations within the stage in dependency order (approximately chronological). */ @@ -728,51 +728,51 @@ export namespace bigquery_v2 { /** * Milliseconds the average shard spent waiting to be scheduled. */ - waitMsAvg?: string; + waitMsAvg?: string | null; /** * Milliseconds the slowest shard spent waiting to be scheduled. */ - waitMsMax?: string; + waitMsMax?: string | null; /** * Relative amount of time the average shard spent waiting to be scheduled. */ - waitRatioAvg?: number; + waitRatioAvg?: number | null; /** * Relative amount of time the slowest shard spent waiting to be scheduled. */ - waitRatioMax?: number; + waitRatioMax?: number | null; /** * Milliseconds the average shard spent on writing output. */ - writeMsAvg?: string; + writeMsAvg?: string | null; /** * Milliseconds the slowest shard spent on writing output. */ - writeMsMax?: string; + writeMsMax?: string | null; /** * Relative amount of time the average shard spent on writing output. */ - writeRatioAvg?: number; + writeRatioAvg?: number | null; /** * Relative amount of time the slowest shard spent on writing output. */ - writeRatioMax?: number; + writeRatioMax?: number | null; } export interface Schema$ExplainQueryStep { /** * Machine-readable operation type. */ - kind?: string; + kind?: string | null; /** * Human-readable stage descriptions. */ - substeps?: string[]; + substeps?: string[] | null; } export interface Schema$ExternalDataConfiguration { /** * Try to detect schema and format options automatically. Any option specified explicitly will be honored. */ - autodetect?: boolean; + autodetect?: boolean | null; /** * [Optional] Additional options if sourceFormat is set to BIGTABLE. */ @@ -780,7 +780,7 @@ export namespace bigquery_v2 { /** * [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. */ - compression?: string; + compression?: string | null; /** * Additional properties to set if sourceFormat is set to CSV. */ @@ -792,7 +792,7 @@ export namespace bigquery_v2 { /** * [Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. Note: this setting is in the process of being deprecated in favor of hivePartitioningOptions. */ - hivePartitioningMode?: string; + hivePartitioningMode?: string | null; /** * [Optional, Trusted Tester] Options to configure hive partitioning support. */ @@ -800,11 +800,11 @@ export namespace bigquery_v2 { /** * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. */ - ignoreUnknownValues?: boolean; + ignoreUnknownValues?: boolean | null; /** * [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. */ - maxBadRecords?: number; + maxBadRecords?: number | null; /** * [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. */ @@ -812,11 +812,11 @@ export namespace bigquery_v2 { /** * [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". */ - sourceFormat?: string; + sourceFormat?: string | null; /** * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */ - sourceUris?: string[]; + sourceUris?: string[] | null; } /** * Representative value of a single feature within the cluster. @@ -829,17 +829,17 @@ export namespace bigquery_v2 { /** * The feature column name. */ - featureColumn?: string; + featureColumn?: string | null; /** * The numerical feature value. This is the centroid value for this feature. */ - numericalValue?: number; + numericalValue?: number | null; } export interface Schema$GetQueryResultsResponse { /** * Whether the query result was fetched from the query cache. */ - cacheHit?: boolean; + cacheHit?: boolean | null; /** * [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. */ @@ -847,11 +847,11 @@ export namespace bigquery_v2 { /** * A hash of this response. */ - etag?: string; + etag?: string | null; /** * Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. */ - jobComplete?: boolean; + jobComplete?: boolean | null; /** * Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). */ @@ -859,15 +859,15 @@ export namespace bigquery_v2 { /** * The resource type of the response. */ - kind?: string; + kind?: string | null; /** * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */ - numDmlAffectedRows?: string; + numDmlAffectedRows?: string | null; /** * A token used for paging results. */ - pageToken?: string; + pageToken?: string | null; /** * An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. */ @@ -879,41 +879,41 @@ export namespace bigquery_v2 { /** * The total number of bytes processed for this query. */ - totalBytesProcessed?: string; + totalBytesProcessed?: string | null; /** * The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully. */ - totalRows?: string; + totalRows?: string | null; } export interface Schema$GetServiceAccountResponse { /** * The service account email address. */ - email?: string; + email?: string | null; /** * The resource type of the response. */ - kind?: string; + kind?: string | null; } export interface Schema$GoogleSheetsOptions { /** * [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20 */ - range?: string; + range?: string | null; /** * [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. */ - skipLeadingRows?: string; + skipLeadingRows?: string | null; } export interface Schema$HivePartitioningOptions { /** * [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. */ - mode?: string; + mode?: string | null; /** * [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). */ - sourceUriPrefix?: string; + sourceUriPrefix?: string | null; } /** * Information about a single iteration of the training run. @@ -926,23 +926,23 @@ export namespace bigquery_v2 { /** * Time taken to run the iteration in milliseconds. */ - durationMs?: string; + durationMs?: string | null; /** * Loss computed on the eval data at the end of iteration. */ - evalLoss?: number; + evalLoss?: number | null; /** * Index of the iteration, 0 based. */ - index?: number; + index?: number | null; /** * Learn rate used for this iteration. */ - learnRate?: number; + learnRate?: number | null; /** * Loss computed on the training data at the end of iteration. */ - trainingLoss?: number; + trainingLoss?: number | null; } export interface Schema$Job { /** @@ -952,11 +952,11 @@ export namespace bigquery_v2 { /** * [Output-only] A hash of this resource. */ - etag?: string; + etag?: string | null; /** * [Output-only] Opaque ID field of the job */ - id?: string; + id?: string | null; /** * [Optional] Reference describing the unique-per-user name of the job. */ @@ -964,11 +964,11 @@ export namespace bigquery_v2 { /** * [Output-only] The type of the resource. */ - kind?: string; + kind?: string | null; /** * [Output-only] A URL that can be used to access this resource again. */ - selfLink?: string; + selfLink?: string | null; /** * [Output-only] Information about the job, including starting time and ending time of the job. */ @@ -980,7 +980,7 @@ export namespace bigquery_v2 { /** * [Output-only] Email address of the user who ran the job. */ - user_email?: string; + user_email?: string | null; } export interface Schema$JobCancelResponse { /** @@ -990,7 +990,7 @@ export namespace bigquery_v2 { /** * The resource type of the response. */ - kind?: string; + kind?: string | null; } export interface Schema$JobConfiguration { /** @@ -1000,7 +1000,7 @@ export namespace bigquery_v2 { /** * [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. */ - dryRun?: boolean; + dryRun?: boolean | null; /** * [Pick one] Configures an extract job. */ @@ -1008,15 +1008,15 @@ export namespace bigquery_v2 { /** * [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. */ - jobTimeoutMs?: string; + jobTimeoutMs?: string | null; /** * [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. */ - jobType?: string; + jobType?: string | null; /** * The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Pick one] Configures a load job. */ @@ -1030,27 +1030,27 @@ export namespace bigquery_v2 { /** * [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. */ - compression?: string; + compression?: string | null; /** * [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. */ - destinationFormat?: string; + destinationFormat?: string | null; /** * [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. */ - destinationUri?: string; + destinationUri?: string | null; /** * [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. */ - destinationUris?: string[]; + destinationUris?: string[] | null; /** * [Optional] Delimiter to use between fields in the exported data. Default is ',' */ - fieldDelimiter?: string; + fieldDelimiter?: string | null; /** * [Optional] Whether to print out a header row in the results. Default is true. */ - printHeader?: boolean; + printHeader?: boolean | null; /** * A reference to the model being exported. */ @@ -1062,21 +1062,21 @@ export namespace bigquery_v2 { /** * [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). */ - useAvroLogicalTypes?: boolean; + useAvroLogicalTypes?: boolean | null; } export interface Schema$JobConfigurationLoad { /** * [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. */ - allowJaggedRows?: boolean; + allowJaggedRows?: boolean | null; /** * Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. */ - allowQuotedNewlines?: boolean; + allowQuotedNewlines?: boolean | null; /** * [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. */ - autodetect?: boolean; + autodetect?: boolean | null; /** * [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. */ @@ -1084,7 +1084,7 @@ export namespace bigquery_v2 { /** * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */ - createDisposition?: string; + createDisposition?: string | null; /** * Custom encryption configuration (e.g., Cloud KMS keys). */ @@ -1100,15 +1100,15 @@ export namespace bigquery_v2 { /** * [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. */ - encoding?: string; + encoding?: string | null; /** * [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). */ - fieldDelimiter?: string; + fieldDelimiter?: string | null; /** * [Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. */ - hivePartitioningMode?: string; + hivePartitioningMode?: string | null; /** * [Optional, Trusted Tester] Options to configure hive partitioning support. */ @@ -1116,23 +1116,23 @@ export namespace bigquery_v2 { /** * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names */ - ignoreUnknownValues?: boolean; + ignoreUnknownValues?: boolean | null; /** * [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. */ - maxBadRecords?: number; + maxBadRecords?: number | null; /** * [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "x/", BigQuery interprets "x/" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. */ - nullMarker?: string; + nullMarker?: string | null; /** * If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. */ - projectionFields?: string[]; + projectionFields?: string[] | null; /** * [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. */ - quote?: string; + quote?: string | null; /** * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */ @@ -1144,27 +1144,27 @@ export namespace bigquery_v2 { /** * [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". */ - schemaInline?: string; + schemaInline?: string | null; /** * [Deprecated] The format of the schemaInline property. */ - schemaInlineFormat?: string; + schemaInlineFormat?: string | null; /** * Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */ - schemaUpdateOptions?: string[]; + schemaUpdateOptions?: string[] | null; /** * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. */ - skipLeadingRows?: number; + skipLeadingRows?: number | null; /** * [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. */ - sourceFormat?: string; + sourceFormat?: string | null; /** * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */ - sourceUris?: string[]; + sourceUris?: string[] | null; /** * Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */ @@ -1172,17 +1172,17 @@ export namespace bigquery_v2 { /** * [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER). */ - useAvroLogicalTypes?: boolean; + useAvroLogicalTypes?: boolean | null; /** * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ - writeDisposition?: string; + writeDisposition?: string | null; } export interface Schema$JobConfigurationQuery { /** * [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. */ - allowLargeResults?: boolean; + allowLargeResults?: boolean | null; /** * [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. */ @@ -1190,7 +1190,7 @@ export namespace bigquery_v2 { /** * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */ - createDisposition?: string; + createDisposition?: string | null; /** * [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. */ @@ -1206,31 +1206,31 @@ export namespace bigquery_v2 { /** * [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. */ - flattenResults?: boolean; + flattenResults?: boolean | null; /** * [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. */ - maximumBillingTier?: number; + maximumBillingTier?: number | null; /** * [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. */ - maximumBytesBilled?: string; + maximumBytesBilled?: string | null; /** * Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */ - parameterMode?: string; + parameterMode?: string | null; /** * [Deprecated] This property is deprecated. */ - preserveNulls?: boolean; + preserveNulls?: boolean | null; /** * [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. */ - priority?: string; + priority?: string | null; /** * [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. */ - query?: string; + query?: string | null; /** * Query parameters for standard SQL queries. */ @@ -1242,11 +1242,11 @@ export namespace bigquery_v2 { /** * Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */ - schemaUpdateOptions?: string[]; + schemaUpdateOptions?: string[] | null; /** * [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. */ - tableDefinitions?: {[key: string]: Schema$ExternalDataConfiguration}; + tableDefinitions?: {[key: string]: Schema$ExternalDataConfiguration} | null; /** * Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */ @@ -1254,11 +1254,11 @@ export namespace bigquery_v2 { /** * Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */ - useLegacySql?: boolean; + useLegacySql?: boolean | null; /** * [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. */ - useQueryCache?: boolean; + useQueryCache?: boolean | null; /** * Describes user-defined function resources used in the query. */ @@ -1266,13 +1266,13 @@ export namespace bigquery_v2 { /** * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ - writeDisposition?: string; + writeDisposition?: string | null; } export interface Schema$JobConfigurationTableCopy { /** * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */ - createDisposition?: string; + createDisposition?: string | null; /** * Custom encryption configuration (e.g., Cloud KMS keys). */ @@ -1292,13 +1292,13 @@ export namespace bigquery_v2 { /** * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ - writeDisposition?: string; + writeDisposition?: string | null; } export interface Schema$JobList { /** * A hash of this page of results. */ - etag?: string; + etag?: string | null; /** * List of jobs that were requested. */ @@ -1310,45 +1310,45 @@ export namespace bigquery_v2 { id?: string; configuration?: Schema$JobConfiguration; user_email?: string; - errorResult?: Schema$ErrorProto; kind?: string; - }>; + errorResult?: Schema$ErrorProto; + }> | null; /** * The resource type of the response. */ - kind?: string; + kind?: string | null; /** * A token to request the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$JobReference { /** * [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. */ - jobId?: string; + jobId?: string | null; /** * The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ - location?: string; + location?: string | null; /** * [Required] The ID of the project containing this job. */ - projectId?: string; + projectId?: string | null; } export interface Schema$JobStatistics { /** * [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. */ - completionRatio?: number; + completionRatio?: number | null; /** * [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. */ - creationTime?: string; + creationTime?: string | null; /** * [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. */ - endTime?: string; + endTime?: string | null; /** * [Output-only] Statistics for an extract job. */ @@ -1360,11 +1360,11 @@ export namespace bigquery_v2 { /** * [Output-only] Number of child jobs executed. */ - numChildJobs?: string; + numChildJobs?: string | null; /** * [Output-only] If this is a child job, the id of the parent. */ - parentJobId?: string; + parentJobId?: string | null; /** * [Output-only] Statistics for a query job. */ @@ -1372,41 +1372,41 @@ export namespace bigquery_v2 { /** * [Output-only] Quotas which delayed this job's start time. */ - quotaDeferments?: string[]; + quotaDeferments?: string[] | null; /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{slotMs?: string; name?: string}>; + reservationUsage?: Array<{slotMs?: string; name?: string}> | null; /** * [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. */ - reservation_id?: string; + reservation_id?: string | null; /** * [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. */ - startTime?: string; + startTime?: string | null; /** * [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. */ - totalBytesProcessed?: string; + totalBytesProcessed?: string | null; /** * [Output-only] Slot-milliseconds for the job. */ - totalSlotMs?: string; + totalSlotMs?: string | null; } export interface Schema$JobStatistics2 { /** * [Output-only] Billing tier for the job. */ - billingTier?: number; + billingTier?: number | null; /** * [Output-only] Whether the query result was fetched from the query cache. */ - cacheHit?: boolean; + cacheHit?: boolean | null; /** * The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. */ - ddlOperationPerformed?: string; + ddlOperationPerformed?: string | null; /** * The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. */ @@ -1418,7 +1418,7 @@ export namespace bigquery_v2 { /** * [Output-only] The original estimate of bytes processed for the job. */ - estimatedBytesProcessed?: string; + estimatedBytesProcessed?: string | null; /** * [Output-only, Beta] Information about create model query job progress. */ @@ -1426,15 +1426,15 @@ export namespace bigquery_v2 { /** * [Output-only, Beta] Deprecated; do not use. */ - modelTrainingCurrentIteration?: number; + modelTrainingCurrentIteration?: number | null; /** * [Output-only, Beta] Deprecated; do not use. */ - modelTrainingExpectedTotalIteration?: string; + modelTrainingExpectedTotalIteration?: string | null; /** * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */ - numDmlAffectedRows?: string; + numDmlAffectedRows?: string | null; /** * [Output-only] Describes execution plan for the query. */ @@ -1450,7 +1450,7 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{name?: string; slotMs?: string}>; + reservationUsage?: Array<{name?: string; slotMs?: string}> | null; /** * [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */ @@ -1458,7 +1458,7 @@ export namespace bigquery_v2 { /** * The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. */ - statementType?: string; + statementType?: string | null; /** * [Output-only] [Beta] Describes a timeline of job execution. */ @@ -1466,23 +1466,23 @@ export namespace bigquery_v2 { /** * [Output-only] Total bytes billed for the job. */ - totalBytesBilled?: string; + totalBytesBilled?: string | null; /** * [Output-only] Total bytes processed for the job. */ - totalBytesProcessed?: string; + totalBytesProcessed?: string | null; /** * [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. */ - totalBytesProcessedAccuracy?: string; + totalBytesProcessedAccuracy?: string | null; /** * [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. */ - totalPartitionsProcessed?: string; + totalPartitionsProcessed?: string | null; /** * [Output-only] Slot-milliseconds for the job. */ - totalSlotMs?: string; + totalSlotMs?: string | null; /** * Standard SQL only: list of undeclared query parameters detected during a dry run validation. */ @@ -1492,33 +1492,33 @@ export namespace bigquery_v2 { /** * [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. */ - badRecords?: string; + badRecords?: string | null; /** * [Output-only] Number of bytes of source data in a load job. */ - inputFileBytes?: string; + inputFileBytes?: string | null; /** * [Output-only] Number of source files in a load job. */ - inputFiles?: string; + inputFiles?: string | null; /** * [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. */ - outputBytes?: string; + outputBytes?: string | null; /** * [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. */ - outputRows?: string; + outputRows?: string | null; } export interface Schema$JobStatistics4 { /** * [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. */ - destinationUriFileCounts?: string[]; + destinationUriFileCounts?: string[] | null; /** * [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. */ - inputBytes?: string; + inputBytes?: string | null; } export interface Schema$JobStatus { /** @@ -1532,7 +1532,7 @@ export namespace bigquery_v2 { /** * [Output-only] Running state of the job. */ - state?: string; + state?: string | null; } /** * Represents a single JSON object. @@ -1547,13 +1547,13 @@ export namespace bigquery_v2 { /** * A token to request the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListRoutinesResponse { /** * A token to request the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Routines in the requested dataset. Only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, language. */ @@ -1566,27 +1566,27 @@ export namespace bigquery_v2 { /** * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations. */ - legacyLocationId?: string; + legacyLocationId?: string | null; } export interface Schema$MaterializedViewDefinition { /** * [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch. */ - lastRefreshTime?: string; + lastRefreshTime?: string | null; /** * [Required] A query whose result is persisted. */ - query?: string; + query?: string | null; } export interface Schema$Model { /** * Output only. The time when this model was created, in millisecs since the epoch. */ - creationTime?: string; + creationTime?: string | null; /** - * [Optional] A user-friendly description of this model. + * Optional. A user-friendly description of this model. */ - description?: string; + 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. */ @@ -1594,35 +1594,35 @@ export namespace bigquery_v2 { /** * Output only. A hash of this resource. */ - etag?: string; + etag?: string | null; /** - * [Optional] The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. + * Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. */ - expirationTime?: string; + expirationTime?: string | null; /** * Output only. Input feature columns that were used to train this model. */ featureColumns?: Schema$StandardSqlField[]; /** - * [Optional] A descriptive name for this model. + * Optional. A descriptive name for this model. */ - friendlyName?: string; + friendlyName?: string | null; /** * Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns. */ labelColumns?: Schema$StandardSqlField[]; /** - * [Optional] The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. + * The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The time when this model was last modified, in millisecs since the epoch. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * Output only. The geographic location where the model resides. This value is inherited from the dataset. */ - location?: string; + location?: string | null; /** * Required. Unique identifier for this model. */ @@ -1630,7 +1630,7 @@ export namespace bigquery_v2 { /** * Output only. Type of the model resource. */ - modelType?: string; + modelType?: string | null; /** * Output only. Information for all training runs in increasing order of start_time. */ @@ -1640,7 +1640,11 @@ export namespace bigquery_v2 { /** * [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query. */ - modelOptions?: {modelType?: string; labels?: string[]; lossType?: string}; + modelOptions?: { + lossType?: string; + modelType?: string; + labels?: string[]; + } | null; /** * [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query. */ @@ -1650,15 +1654,15 @@ export namespace bigquery_v2 { /** * [Required] The ID of the dataset containing this model. */ - datasetId?: string; + datasetId?: string | null; /** * [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. */ - modelId?: string; + modelId?: string | null; /** * [Required] The ID of the project containing this model. */ - projectId?: string; + projectId?: string | null; } /** * Evaluation metrics for multi-class classification/classifier models. @@ -1677,41 +1681,41 @@ export namespace bigquery_v2 { /** * A hash of the page of results */ - etag?: string; + etag?: string | null; /** * The type of list. */ - kind?: string; + kind?: string | null; /** * A token to request the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Projects to which you have at least READ access. */ projects?: Array<{ - id?: string; - projectReference?: Schema$ProjectReference; friendlyName?: string; numericId?: string; kind?: string; - }>; + id?: string; + projectReference?: Schema$ProjectReference; + }> | null; /** * The total number of projects in the list. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$ProjectReference { /** * [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project. */ - projectId?: string; + projectId?: string | null; } export interface Schema$QueryParameter { /** * [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. */ - name?: string; + name?: string | null; /** * [Required] The type of this parameter. */ @@ -1733,11 +1737,11 @@ export namespace bigquery_v2 { type?: Schema$QueryParameterType; name?: string; description?: string; - }>; + }> | null; /** * [Required] The top level type of this field. */ - type?: string; + type?: string | null; } export interface Schema$QueryParameterValue { /** @@ -1747,11 +1751,11 @@ export namespace bigquery_v2 { /** * [Optional] The struct field values, in order of the struct type's declaration. */ - structValues?: {[key: string]: Schema$QueryParameterValue}; + structValues?: {[key: string]: Schema$QueryParameterValue} | null; /** * [Optional] The value of this value, if a simple scalar type. */ - value?: string; + value?: string | null; } export interface Schema$QueryRequest { /** @@ -1761,31 +1765,31 @@ export namespace bigquery_v2 { /** * [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false. */ - dryRun?: boolean; + dryRun?: boolean | null; /** * The resource type of the request. */ - kind?: string; + kind?: string | null; /** * The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ - location?: string; + location?: string | null; /** * [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. */ - maxResults?: number; + maxResults?: number | null; /** * Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */ - parameterMode?: string; + parameterMode?: string | null; /** * [Deprecated] This property is deprecated. */ - preserveNulls?: boolean; + preserveNulls?: boolean | null; /** * [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". */ - query?: string; + query?: string | null; /** * Query parameters for Standard SQL queries. */ @@ -1793,21 +1797,21 @@ export namespace bigquery_v2 { /** * [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds). */ - timeoutMs?: number; + timeoutMs?: number | null; /** * Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */ - useLegacySql?: boolean; + useLegacySql?: boolean | null; /** * [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. */ - useQueryCache?: boolean; + useQueryCache?: boolean | null; } export interface Schema$QueryResponse { /** * Whether the query result was fetched from the query cache. */ - cacheHit?: boolean; + cacheHit?: boolean | null; /** * [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. */ @@ -1815,7 +1819,7 @@ export namespace bigquery_v2 { /** * Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. */ - jobComplete?: boolean; + jobComplete?: boolean | null; /** * Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). */ @@ -1823,15 +1827,15 @@ export namespace bigquery_v2 { /** * The resource type. */ - kind?: string; + kind?: string | null; /** * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */ - numDmlAffectedRows?: string; + numDmlAffectedRows?: string | null; /** * A token used for paging results. */ - pageToken?: string; + pageToken?: string | null; /** * An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. */ @@ -1843,43 +1847,43 @@ export namespace bigquery_v2 { /** * The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run. */ - totalBytesProcessed?: string; + totalBytesProcessed?: string | null; /** * The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. */ - totalRows?: string; + totalRows?: string | null; } export interface Schema$QueryTimelineSample { /** * Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. */ - activeUnits?: string; + activeUnits?: string | null; /** * Total parallel units of work completed by this query. */ - completedUnits?: string; + completedUnits?: string | null; /** * Milliseconds elapsed since the start of query execution. */ - elapsedMs?: string; + elapsedMs?: string | null; /** * Total parallel units of work remaining for the active stages. */ - pendingUnits?: string; + pendingUnits?: string | null; /** * Cumulative slot-ms consumed by the query. */ - totalSlotMs?: string; + totalSlotMs?: string | null; } export interface Schema$RangePartitioning { /** * [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. */ - field?: string; + field?: string | null; /** * [TrustedTester] [Required] Defines the ranges for range partitioning. */ - range?: {interval?: string; start?: string; end?: string}; + range?: {start?: string; end?: string; interval?: string} | null; } /** * Evaluation metrics for regression and explicit feedback type matrix factorization models. @@ -1888,23 +1892,23 @@ export namespace bigquery_v2 { /** * Mean absolute error. */ - meanAbsoluteError?: number; + meanAbsoluteError?: number | null; /** * Mean squared error. */ - meanSquaredError?: number; + meanSquaredError?: number | null; /** * Mean squared log error. */ - meanSquaredLogError?: number; + meanSquaredLogError?: number | null; /** * Median absolute error. */ - medianAbsoluteError?: number; + medianAbsoluteError?: number | null; /** * R^2 score. */ - rSquared?: number; + rSquared?: number | null; } /** * A user-defined function or a stored procedure. @@ -1917,27 +1921,31 @@ export namespace bigquery_v2 { /** * Output only. The time when this routine was created, in milliseconds since the epoch. */ - creationTime?: string; + creationTime?: string | null; /** * Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "x/", y))` The definition_body is `concat(x, "x/", y)` (x/ is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "x/";x/'` The definition_body is `return "x/";x/` Note that both x/ are replaced with linebreaks. */ - definitionBody?: string; + definitionBody?: string | null; + /** + * Optional. [Experimental] The description of the routine if defined. + */ + description?: string | null; /** * Output only. A hash of this resource. */ - etag?: string; + etag?: string | null; /** * Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. */ - importedLibraries?: string[]; + importedLibraries?: string[] | null; /** * Optional. Defaults to "SQL". */ - language?: string; + language?: string | null; /** * Output only. The time when this routine was last modified, in milliseconds since the epoch. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. */ @@ -1947,23 +1955,23 @@ export namespace bigquery_v2 { */ routineReference?: Schema$RoutineReference; /** - * Required. + * Required. The type of routine. */ - routineType?: string; + routineType?: string | null; } export interface Schema$RoutineReference { /** * [Required] The ID of the dataset containing this routine. */ - datasetId?: string; + datasetId?: string | null; /** * [Required] The ID of the project containing this routine. */ - projectId?: string; + projectId?: string | null; /** * [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. */ - routineId?: string; + routineId?: string | null; } /** * A single row in the confusion matrix. @@ -1972,7 +1980,7 @@ export namespace bigquery_v2 { /** * The original label of this row. */ - actualLabel?: string; + actualLabel?: string | null; /** * Info describing predicted label distribution. */ @@ -1993,7 +2001,7 @@ export namespace bigquery_v2 { /** * Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY"). */ - typeKind?: string; + typeKind?: string | null; } /** * A field or a column. @@ -2002,7 +2010,7 @@ export namespace bigquery_v2 { /** * Optional. The name of this field. Can be absent for struct fields. */ - name?: string; + name?: string | null; /** * Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). */ @@ -2015,15 +2023,15 @@ export namespace bigquery_v2 { /** * [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer. */ - estimatedBytes?: string; + estimatedBytes?: string | null; /** * [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer. */ - estimatedRows?: string; + estimatedRows?: string | null; /** * [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available. */ - oldestEntryTime?: string; + oldestEntryTime?: string | null; } export interface Schema$Table { /** @@ -2033,11 +2041,11 @@ export namespace bigquery_v2 { /** * [Output-only] The time when this table was created, in milliseconds since the epoch. */ - creationTime?: string; + creationTime?: string | null; /** * [Optional] A user-friendly description of this table. */ - description?: string; + description?: string | null; /** * Custom encryption configuration (e.g., Cloud KMS keys). */ @@ -2045,11 +2053,11 @@ export namespace bigquery_v2 { /** * [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change. */ - etag?: string; + etag?: string | null; /** * [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables. */ - expirationTime?: string; + expirationTime?: string | null; /** * [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. */ @@ -2057,27 +2065,27 @@ export namespace bigquery_v2 { /** * [Optional] A descriptive name for this table. */ - friendlyName?: string; + friendlyName?: string | null; /** * [Output-only] An opaque ID uniquely identifying the table. */ - id?: string; + id?: string | null; /** * [Output-only] The type of the resource. */ - kind?: string; + kind?: string | null; /** * The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Output-only] The time when this table was last modified, in milliseconds since the epoch. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * [Output-only] The geographic location where the table resides. This value is inherited from the dataset. */ - location?: string; + location?: string | null; /** * [Optional] Materialized view definition. */ @@ -2089,19 +2097,19 @@ export namespace bigquery_v2 { /** * [Output-only] The size of this table in bytes, excluding any data in the streaming buffer. */ - numBytes?: string; + numBytes?: string | null; /** * [Output-only] The number of bytes in the table that are considered "long-term storage". */ - numLongTermBytes?: string; + numLongTermBytes?: string | null; /** * [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel. */ - numPhysicalBytes?: string; + numPhysicalBytes?: string | null; /** * [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer. */ - numRows?: string; + numRows?: string | null; /** * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */ @@ -2109,7 +2117,7 @@ export namespace bigquery_v2 { /** * [Beta] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. */ - requirePartitionFilter?: boolean; + requirePartitionFilter?: boolean | null; /** * [Optional] Describes the schema of this table. */ @@ -2117,7 +2125,7 @@ export namespace bigquery_v2 { /** * [Output-only] A URL that can be used to access this resource again. */ - selfLink?: string; + selfLink?: string | null; /** * [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer. */ @@ -2133,60 +2141,60 @@ export namespace bigquery_v2 { /** * [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. */ - type?: string; + type?: string | null; /** * [Optional] The view definition. */ view?: Schema$ViewDefinition; } export interface Schema$TableCell { - v?: any; + v?: any | null; } export interface Schema$TableDataInsertAllRequest { /** * [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors. */ - ignoreUnknownValues?: boolean; + ignoreUnknownValues?: boolean | null; /** * The resource type of the response. */ - kind?: string; + kind?: string | null; /** * The rows to insert. */ - rows?: Array<{insertId?: string; json?: Schema$JsonObject}>; + rows?: Array<{insertId?: string; json?: Schema$JsonObject}> | null; /** * [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist. */ - skipInvalidRows?: boolean; + skipInvalidRows?: boolean | null; /** * If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables. */ - templateSuffix?: string; + templateSuffix?: string | null; } export interface Schema$TableDataInsertAllResponse { /** * An array of errors for rows that were not inserted. */ - insertErrors?: Array<{errors?: Schema$ErrorProto[]; index?: number}>; + insertErrors?: Array<{errors?: Schema$ErrorProto[]; index?: number}> | null; /** * The resource type of the response. */ - kind?: string; + kind?: string | null; } export interface Schema$TableDataList { /** * A hash of this page of results. */ - etag?: string; + etag?: string | null; /** * The resource type of the response. */ - kind?: string; + kind?: string | null; /** * A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing. */ - pageToken?: string; + pageToken?: string | null; /** * Rows of results. */ @@ -2194,17 +2202,17 @@ export namespace bigquery_v2 { /** * The total number of rows in the complete table. */ - totalRows?: string; + totalRows?: string | null; } export interface Schema$TableFieldSchema { /** * [Optional] The categories attached to this field, used for field-level access control. */ - categories?: {names?: string[]}; + categories?: {names?: string[]} | null; /** * [Optional] The field description. The maximum length is 1,024 characters. */ - description?: string; + description?: string | null; /** * [Optional] Describes the nested schema fields if the type property is set to RECORD. */ @@ -2212,63 +2220,63 @@ export namespace bigquery_v2 { /** * [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. */ - mode?: string; + mode?: string | null; /** * [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. */ - name?: string; + name?: string | null; /** * [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). */ - type?: string; + type?: string | null; } export interface Schema$TableList { /** * A hash of this page of results. */ - etag?: string; + etag?: string | null; /** * The type of list. */ - kind?: string; + kind?: string | null; /** * A token to request the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Tables in the requested dataset. */ tables?: Array<{ + tableReference?: Schema$TableReference; + friendlyName?: string; + timePartitioning?: Schema$TimePartitioning; + kind?: string; view?: {useLegacySql?: boolean}; creationTime?: string; labels?: {[key: string]: string}; - clustering?: Schema$Clustering; type?: string; - id?: string; + clustering?: Schema$Clustering; expirationTime?: string; - tableReference?: Schema$TableReference; - timePartitioning?: Schema$TimePartitioning; - friendlyName?: string; - kind?: string; - }>; + id?: string; + }> | null; /** * The total number of tables in the dataset. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$TableReference { /** * [Required] The ID of the dataset containing this table. */ - datasetId?: string; + datasetId?: string | null; /** * [Required] The ID of the project containing this table. */ - projectId?: string; + projectId?: string | null; /** * [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. */ - tableId?: string; + tableId?: string | null; } export interface Schema$TableRow { /** @@ -2286,102 +2294,102 @@ export namespace bigquery_v2 { /** * [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. */ - expirationMs?: string; + expirationMs?: string | null; /** * [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. */ - field?: string; - requirePartitionFilter?: boolean; + field?: string | null; + requirePartitionFilter?: boolean | null; /** * [Required] The only type supported is DAY, which will generate one partition per day. */ - type?: string; + type?: string | null; } export interface Schema$TrainingOptions { /** * The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties */ - dataSplitColumn?: string; + dataSplitColumn?: string | null; /** * The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2. */ - dataSplitEvalFraction?: number; + dataSplitEvalFraction?: number | null; /** * The data split type for training and evaluation, e.g. RANDOM. */ - dataSplitMethod?: string; + dataSplitMethod?: string | null; /** * Distance type for clustering models. */ - distanceType?: string; + distanceType?: string | null; /** * Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. */ - earlyStop?: boolean; + earlyStop?: boolean | null; /** * Specifies the initial learning rate for the line search learn rate strategy. */ - initialLearnRate?: number; + initialLearnRate?: number | null; /** * Name of input label columns in training data. */ - inputLabelColumns?: string[]; + inputLabelColumns?: string[] | null; /** * The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM. */ - kmeansInitializationColumn?: string; + kmeansInitializationColumn?: string | null; /** * The method used to initialize the centroids for kmeans algorithm. */ - kmeansInitializationMethod?: string; + kmeansInitializationMethod?: string | null; /** * L1 regularization coefficient. */ - l1Regularization?: number; + l1Regularization?: number | null; /** * L2 regularization coefficient. */ - l2Regularization?: number; + l2Regularization?: number | null; /** * Weights associated with each label class, for rebalancing the training data. Only applicable for classification models. */ - labelClassWeights?: {[key: string]: number}; + labelClassWeights?: {[key: string]: number} | null; /** * Learning rate in training. Used only for iterative training algorithms. */ - learnRate?: number; + learnRate?: number | null; /** * The strategy to determine learn rate for the current iteration. */ - learnRateStrategy?: string; + learnRateStrategy?: string | null; /** * Type of loss function used during training run. */ - lossType?: string; + lossType?: string | null; /** * The maximum number of iterations in training. Used only for iterative training algorithms. */ - maxIterations?: string; + maxIterations?: string | null; /** * When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. */ - minRelativeProgress?: number; + minRelativeProgress?: number | null; /** * [Beta] Google Cloud Storage URI from which the model was imported. Only applicable for imported models. */ - modelUri?: string; + modelUri?: string | null; /** * Number of clusters for clustering models. */ - numClusters?: string; + numClusters?: string | null; /** * Optimization strategy for training linear regression models. */ - optimizationStrategy?: string; + optimizationStrategy?: string | null; /** * Whether to train a model from the last checkpoint. */ - warmStart?: boolean; + warmStart?: boolean | null; } /** * Information about a single training query run for the model. @@ -2398,7 +2406,7 @@ export namespace bigquery_v2 { /** * The start time of this training run. */ - startTime?: string; + startTime?: string | null; /** * Options that were used for this training run, includes user specified and default options that were used. */ @@ -2408,21 +2416,21 @@ export namespace bigquery_v2 { /** * [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. */ - inlineCode?: string; + inlineCode?: string | null; /** * [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). */ - resourceUri?: string; + resourceUri?: string | null; } export interface Schema$ViewDefinition { /** * [Required] A query that BigQuery executes when the view is referenced. */ - query?: string; + query?: string | null; /** * Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value. */ - useLegacySql?: boolean; + useLegacySql?: boolean | null; /** * Describes user-defined function resources used in the query. */ @@ -4319,9 +4327,9 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the model to delete. - * @param {string} params.modelId Model ID of the model to delete. - * @param {string} params.projectId Project ID of the model to delete. + * @param {string} params.datasetId Required. Dataset ID of the model to delete. + * @param {string} params.modelId Required. Model ID of the model to delete. + * @param {string} params.projectId Required. Project ID of the model to delete. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4444,9 +4452,9 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the requested model. - * @param {string} params.modelId Model ID of the requested model. - * @param {string} params.projectId Project ID of the requested model. + * @param {string} params.datasetId Required. Dataset ID of the requested model. + * @param {string} params.modelId Required. Model ID of the requested model. + * @param {string} params.projectId Required. Project ID of the requested model. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4579,10 +4587,10 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the models to list. + * @param {string} params.datasetId Required. Dataset ID of the models to list. * @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 Project ID of the models to list. + * @param {string} params.projectId Required. Project ID of the models to list. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4712,9 +4720,9 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the model to patch. - * @param {string} params.modelId Model ID of the model to patch. - * @param {string} params.projectId Project ID of the model to patch. + * @param {string} params.datasetId Required. Dataset ID of the model to patch. + * @param {string} params.modelId Required. Model ID of the model to patch. + * @param {string} params.projectId Required. Project ID of the model to patch. * @param {().Model} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4787,15 +4795,15 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the model to delete. + * Required. Dataset ID of the model to delete. */ datasetId?: string; /** - * Model ID of the model to delete. + * Required. Model ID of the model to delete. */ modelId?: string; /** - * Project ID of the model to delete. + * Required. Project ID of the model to delete. */ projectId?: string; } @@ -4806,15 +4814,15 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the requested model. + * Required. Dataset ID of the requested model. */ datasetId?: string; /** - * Model ID of the requested model. + * Required. Model ID of the requested model. */ modelId?: string; /** - * Project ID of the requested model. + * Required. Project ID of the requested model. */ projectId?: string; } @@ -4825,7 +4833,7 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the models to list. + * Required. Dataset ID of the models to list. */ datasetId?: string; /** @@ -4837,7 +4845,7 @@ export namespace bigquery_v2 { */ pageToken?: string; /** - * Project ID of the models to list. + * Required. Project ID of the models to list. */ projectId?: string; } @@ -4848,15 +4856,15 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the model to patch. + * Required. Dataset ID of the model to patch. */ datasetId?: string; /** - * Model ID of the model to patch. + * Required. Model ID of the model to patch. */ modelId?: string; /** - * Project ID of the model to patch. + * Required. Project ID of the model to patch. */ projectId?: string; @@ -5219,9 +5227,9 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the routine to delete - * @param {string} params.projectId Project ID of the routine to delete - * @param {string} params.routineId Routine ID of the routine to delete + * @param {string} params.datasetId Required. Dataset ID of the routine to delete + * @param {string} params.projectId Required. Project ID of the routine to delete + * @param {string} params.routineId Required. Routine ID of the routine 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 @@ -5344,10 +5352,10 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the requested routine + * @param {string} params.datasetId Required. Dataset ID of the requested routine * @param {string=} params.fieldMask 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.projectId Project ID of the requested routine - * @param {string} params.routineId Routine ID of the requested routine + * @param {string} params.projectId Required. Project ID of the requested routine + * @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. * @return {object} Request object @@ -5471,8 +5479,8 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the new routine - * @param {string} params.projectId Project ID of the new routine + * @param {string} params.datasetId Required. Dataset ID of the new routine + * @param {string} params.projectId Required. Project ID of the new routine * @param {().Routine} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5606,10 +5614,10 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the routines to list + * @param {string} params.datasetId Required. Dataset ID of the routines to list * @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 Project ID of the routines to list + * @param {string} params.projectId Required. Project ID of the routines to list * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5741,9 +5749,9 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the routine to update - * @param {string} params.projectId Project ID of the routine to update - * @param {string} params.routineId Routine ID of the routine to update + * @param {string} params.datasetId Required. Dataset ID of the routine to update + * @param {string} params.projectId Required. Project ID of the routine to update + * @param {string} params.routineId Required. Routine ID of the routine to update * @param {().Routine} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5816,15 +5824,15 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the routine to delete + * Required. Dataset ID of the routine to delete */ datasetId?: string; /** - * Project ID of the routine to delete + * Required. Project ID of the routine to delete */ projectId?: string; /** - * Routine ID of the routine to delete + * Required. Routine ID of the routine to delete */ routineId?: string; } @@ -5835,7 +5843,7 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the requested routine + * Required. Dataset ID of the requested routine */ datasetId?: string; /** @@ -5843,11 +5851,11 @@ export namespace bigquery_v2 { */ fieldMask?: string; /** - * Project ID of the requested routine + * Required. Project ID of the requested routine */ projectId?: string; /** - * Routine ID of the requested routine + * Required. Routine ID of the requested routine */ routineId?: string; } @@ -5858,11 +5866,11 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the new routine + * Required. Dataset ID of the new routine */ datasetId?: string; /** - * Project ID of the new routine + * Required. Project ID of the new routine */ projectId?: string; @@ -5878,7 +5886,7 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the routines to list + * Required. Dataset ID of the routines to list */ datasetId?: string; /** @@ -5890,7 +5898,7 @@ export namespace bigquery_v2 { */ pageToken?: string; /** - * Project ID of the routines to list + * Required. Project ID of the routines to list */ projectId?: string; } @@ -5901,15 +5909,15 @@ export namespace bigquery_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset ID of the routine to update + * Required. Dataset ID of the routine to update */ datasetId?: string; /** - * Project ID of the routine to update + * Required. Project ID of the routine to update */ projectId?: string; /** - * Routine ID of the routine to update + * Required. Routine ID of the routine to update */ routineId?: string; diff --git a/src/apis/bigqueryconnection/README.md b/src/apis/bigqueryconnection/README.md new file mode 100644 index 00000000000..e8e34413e6e --- /dev/null +++ b/src/apis/bigqueryconnection/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# bigqueryconnection + +> Allows users to manage BigQuery connections to external data sources. + +## Installation + +```sh +$ npm install googleapis +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). + +## Building a browser bundle + +This library can be used in a browser. To prepare a single file bundle, clone the +[repository](https://github.com/googleapis/google-api-nodejs-client) and run + +```sh +$ cd src/apis/bigqueryconnection +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/bigqueryconnection.min.js`. Use it from your HTML file: + +```html + + +``` + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/master/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/bigqueryconnection/index.ts b/src/apis/bigqueryconnection/index.ts new file mode 100644 index 00000000000..6d19339e659 --- /dev/null +++ b/src/apis/bigqueryconnection/index.ts @@ -0,0 +1,39 @@ +// Copyright 2019 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {bigqueryconnection_v1beta1} from './v1beta1'; + +export const VERSIONS = { + v1beta1: bigqueryconnection_v1beta1.Bigqueryconnection, +}; + +export function bigqueryconnection( + version: 'v1beta1' +): bigqueryconnection_v1beta1.Bigqueryconnection; +export function bigqueryconnection( + options: bigqueryconnection_v1beta1.Options +): bigqueryconnection_v1beta1.Bigqueryconnection; +export function bigqueryconnection< + T = bigqueryconnection_v1beta1.Bigqueryconnection +>( + this: GoogleConfigurable, + versionOrOptions: 'v1beta1' | bigqueryconnection_v1beta1.Options +) { + return getAPI('bigqueryconnection', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/bigqueryconnection/package.json b/src/apis/bigqueryconnection/package.json new file mode 100644 index 00000000000..f4510a7aba5 --- /dev/null +++ b/src/apis/bigqueryconnection/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/bigqueryconnection", + "version": "0.1.0", + "description": "bigqueryconnection", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=8.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "docs": "typedoc --out docs/", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^3.0.0" + }, + "devDependencies": { + "gts": "^1.0.0", + "null-loader": "^3.0.0", + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.6.0", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" + } +} diff --git a/src/apis/bigqueryconnection/tsconfig.json b/src/apis/bigqueryconnection/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/bigqueryconnection/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/bigqueryconnection/v1beta1.ts b/src/apis/bigqueryconnection/v1beta1.ts new file mode 100644 index 00000000000..b5097e5e30f --- /dev/null +++ b/src/apis/bigqueryconnection/v1beta1.ts @@ -0,0 +1,1199 @@ +/** + * 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 bigqueryconnection_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * BigQuery Connection API + * + * Allows users to manage BigQuery connections to external data sources. + * + * @example + * const {google} = require('googleapis'); + * const bigqueryconnection = google.bigqueryconnection('v1beta1'); + * + * @namespace bigqueryconnection + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Bigqueryconnection + */ + export class Bigqueryconnection { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + service?: string | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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; + } + /** + * Credential info for the Cloud SQL. + */ + export interface Schema$CloudSqlCredential { + /** + * The password for the credential. + */ + password?: string | null; + /** + * The username for the credential. + */ + username?: string | null; + } + /** + * Connection properties specific to the Cloud SQL. + */ + export interface Schema$CloudSqlProperties { + /** + * Database name. + */ + database?: string | null; + /** + * Cloud SQL instance ID in the form `project:location:instance`. + */ + instanceId?: string | null; + /** + * Type of the Cloud SQL database. + */ + type?: string | null; + } + /** + * Configuration parameters to establish connection with an external data source, except the credential attributes. + */ + export interface Schema$Connection { + /** + * Cloud SQL properties. + */ + cloudSql?: Schema$CloudSqlProperties; + /** + * Output only. The creation timestamp of the connection. + */ + creationTime?: string | null; + /** + * User provided description. + */ + description?: string | null; + /** + * User provided display name for the connection. + */ + friendlyName?: string | null; + /** + * Output only. True, if credential is configured for this connection. + */ + hasCredential?: boolean | null; + /** + * Output only. The last update timestamp of the connection. + */ + lastModifiedTime?: string | null; + /** + * The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + */ + name?: string | null; + } + /** + * Credential to use with a connection. + */ + export interface Schema$ConnectionCredential { + /** + * Credential for Cloud SQL database. + */ + cloudSql?: Schema$CloudSqlCredential; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + */ + expression?: string | null; + /** + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + /** + * Request message for `GetIamPolicy` method. + */ + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + requestedPolicyVersion?: number | null; + } + /** + * The response for ConnectionService.ListConnections. + */ + export interface Schema$ListConnectionsResponse { + /** + * List of connections. + */ + connections?: Schema$Connection[]; + /** + * Next page token. + */ + nextPageToken?: string | null; + } + /** + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + version?: number | 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; + } + + 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; + connections: Resource$Projects$Locations$Connections; + constructor(context: APIRequestContext) { + this.context = context; + this.connections = new Resource$Projects$Locations$Connections( + this.context + ); + } + } + + export class Resource$Projects$Locations$Connections { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * bigqueryconnection.projects.locations.connections.create + * @desc Creates a new connection. + * @alias bigqueryconnection.projects.locations.connections.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.connectionId Optional connection id that should be assigned to the created connection. + * @param {string} params.parent Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` + * @param {().Connection} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Connections$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Connections$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Connections$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/connections').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryconnection.projects.locations.connections.delete + * @desc Deletes connection and associated credential. + * @alias bigqueryconnection.projects.locations.connections.delete + * @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 {object} [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$Connections$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Connections$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Connections$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.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); + } + } + + /** + * bigqueryconnection.projects.locations.connections.get + * @desc Returns specified connection. + * @alias bigqueryconnection.projects.locations.connections.get + * @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 {object} [options] Optionally override request 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$Connections$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Connections$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Connections$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.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); + } + } + + /** + * bigqueryconnection.projects.locations.connections.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 bigqueryconnection.projects.locations.connections.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Locations$Connections$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Connections$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Connections$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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); + } + } + + /** + * bigqueryconnection.projects.locations.connections.list + * @desc Returns a list of connections in the given project. + * @alias bigqueryconnection.projects.locations.connections.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Page token. + * @param {string} params.parent Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Connections$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Connections$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Connections$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/connections').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryconnection.projects.locations.connections.patch + * @desc Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask. + * @alias bigqueryconnection.projects.locations.connections.patch + * @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 {().Connection} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Locations$Connections$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Connections$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Connections$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.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); + } + } + + /** + * bigqueryconnection.projects.locations.connections.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias bigqueryconnection.projects.locations.connections.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Connections$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Connections$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Connections$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.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); + } + } + + /** + * bigqueryconnection.projects.locations.connections.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 bigqueryconnection.projects.locations.connections.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Connections$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Connections$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Connections$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.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); + } + } + + /** + * bigqueryconnection.projects.locations.connections.updateCredential + * @desc Sets the credential for the specified connection. + * @alias bigqueryconnection.projects.locations.connections.updateCredential + * @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 {().ConnectionCredential} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateCredential( + params?: Params$Resource$Projects$Locations$Connections$Updatecredential, + options?: MethodOptions + ): GaxiosPromise; + updateCredential( + params: Params$Resource$Projects$Locations$Connections$Updatecredential, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCredential( + params: Params$Resource$Projects$Locations$Connections$Updatecredential, + callback: BodyResponseCallback + ): void; + updateCredential(callback: BodyResponseCallback): void; + updateCredential( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Updatecredential + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Updatecredential; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connections$Updatecredential; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryconnection.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Connections$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional connection id that should be assigned to the created connection. + */ + connectionId?: string; + /** + * Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Connection; + } + export interface Params$Resource$Projects$Locations$Connections$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Connections$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Connections$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Connections$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; + /** + * Page token. + */ + pageToken?: string; + /** + * Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Connections$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Connection; + } + export interface Params$Resource$Projects$Locations$Connections$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$Connections$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Locations$Connections$Updatecredential + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConnectionCredential; + } +} diff --git a/src/apis/bigqueryconnection/webpack.config.js b/src/apis/bigqueryconnection/webpack.config.js new file mode 100644 index 00000000000..6d444cebfb8 --- /dev/null +++ b/src/apis/bigqueryconnection/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Bigqueryconnection', + filename: 'bigqueryconnection.min.js', + path: path.resolve(__dirname, 'dist'), + }, + node: { + child_process: 'empty', + fs: 'empty', + crypto: 'empty', + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index 48100c413a3..add07f9070c 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -128,7 +128,7 @@ export namespace bigquerydatatransfer_v1 { /** * If set to `true`, the credentials exist and are valid. */ - hasValidCreds?: boolean; + hasValidCreds?: boolean | null; } /** * Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens. @@ -137,51 +137,51 @@ export namespace bigquerydatatransfer_v1 { /** * Indicates the type of authorization. */ - authorizationType?: string; + authorizationType?: string | null; /** * Data source client id which should be used to receive refresh token. */ - clientId?: string; + clientId?: string | null; /** * Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically. */ - dataRefreshType?: string; + dataRefreshType?: string | null; /** * Data source id. */ - dataSourceId?: string; + dataSourceId?: string | null; /** * Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. */ - defaultDataRefreshWindowDays?: number; + defaultDataRefreshWindowDays?: number | null; /** * Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. */ - defaultSchedule?: string; + defaultSchedule?: string | null; /** * User friendly data source description string. */ - description?: string; + description?: string | null; /** * User friendly data source name. */ - displayName?: string; + displayName?: string | null; /** * Url for the help document for this data source. */ - helpUrl?: string; + helpUrl?: string | null; /** * Disables backfilling and manual run scheduling for the data source. */ - manualRunsDisabled?: boolean; + manualRunsDisabled?: boolean | null; /** * The minimum interval for scheduler to schedule runs. */ - minimumScheduleInterval?: string; + minimumScheduleInterval?: string | null; /** * Output only. Data source resource name. */ - name?: string; + name?: string | null; /** * Data source parameters. */ @@ -189,23 +189,23 @@ export namespace bigquerydatatransfer_v1 { /** * Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery */ - scopes?: string[]; + scopes?: string[] | null; /** * Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule. */ - supportsCustomSchedule?: boolean; + supportsCustomSchedule?: boolean | null; /** * Deprecated. This field has no effect. */ - supportsMultipleTransfers?: boolean; + supportsMultipleTransfers?: boolean | null; /** * Deprecated. This field has no effect. */ - transferType?: string; + transferType?: string | null; /** * The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. */ - updateDeadlineSeconds?: number; + updateDeadlineSeconds?: number | null; } /** * Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms. @@ -214,19 +214,19 @@ export namespace bigquerydatatransfer_v1 { /** * All possible values for the parameter. */ - allowedValues?: string[]; + allowedValues?: string[] | null; /** * If true, it should not be used in new transfers, and it should not be visible to users. */ - deprecated?: boolean; + deprecated?: boolean | null; /** * Parameter description. */ - description?: string; + description?: string | null; /** * Parameter display name in the user interface. */ - displayName?: string; + displayName?: string | null; /** * Deprecated. This field has no effect. */ @@ -234,47 +234,47 @@ export namespace bigquerydatatransfer_v1 { /** * Cannot be changed after initial creation. */ - immutable?: boolean; + immutable?: boolean | null; /** * For integer and double values specifies maxminum allowed value. */ - maxValue?: number; + maxValue?: number | null; /** * For integer and double values specifies minimum allowed value. */ - minValue?: number; + minValue?: number | null; /** * Parameter identifier. */ - paramId?: string; + paramId?: string | null; /** * Deprecated. This field has no effect. */ - recurse?: boolean; + recurse?: boolean | null; /** * Deprecated. This field has no effect. */ - repeated?: boolean; + repeated?: boolean | null; /** * Is parameter required. */ - required?: boolean; + required?: boolean | null; /** * Parameter type. */ - type?: string; + type?: string | null; /** * Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values. */ - validationDescription?: string; + validationDescription?: string | null; /** * URL to a help document to further explain the naming requirements. */ - validationHelpUrl?: string; + validationHelpUrl?: string | null; /** * Regular expression which can be used for parameter validation. */ - validationRegex?: string; + validationRegex?: 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 `{}`. @@ -291,7 +291,7 @@ export namespace bigquerydatatransfer_v1 { /** * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -304,7 +304,7 @@ export namespace bigquerydatatransfer_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The returned list of pipelines in the project. @@ -313,7 +313,7 @@ export namespace bigquerydatatransfer_v1 { /** * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. The stored pipeline transfer configurations. */ @@ -326,7 +326,7 @@ export namespace bigquerydatatransfer_v1 { /** * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. The stored pipeline transfer messages. */ @@ -339,7 +339,7 @@ export namespace bigquerydatatransfer_v1 { /** * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. The stored pipeline transfer runs. */ @@ -352,23 +352,23 @@ export namespace bigquerydatatransfer_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Options customizing the data transfer schedule. @@ -377,15 +377,15 @@ export namespace bigquerydatatransfer_v1 { /** * If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored. */ - disableAutoScheduling?: boolean; + disableAutoScheduling?: boolean | null; /** * Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option. */ - endTime?: string; + endTime?: string | null; /** * Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option. */ - startTime?: string; + startTime?: string | null; } /** * A request to schedule transfer runs for a time range. @@ -394,11 +394,11 @@ export namespace bigquerydatatransfer_v1 { /** * End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. */ - endTime?: string; + endTime?: string | null; /** * Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. */ - startTime?: string; + startTime?: string | null; } /** * A response to schedule transfer runs for a time range. @@ -416,7 +416,7 @@ export namespace bigquerydatatransfer_v1 { /** * Specific run_time for a transfer run to be started. The requested_run_time must not be in the future. */ - requestedRunTime?: string; + requestedRunTime?: string | null; /** * Time range for the transfer runs that should be started. */ @@ -438,15 +438,15 @@ export namespace bigquerydatatransfer_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive). @@ -455,11 +455,11 @@ export namespace bigquerydatatransfer_v1 { /** * End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive). */ - endTime?: string; + endTime?: string | null; /** * Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive). */ - startTime?: string; + startTime?: string | null; } /** * Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. @@ -468,43 +468,43 @@ export namespace bigquerydatatransfer_v1 { /** * The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. */ - dataRefreshWindowDays?: number; + dataRefreshWindowDays?: number | null; /** * Output only. Region in which BigQuery dataset is located. */ - datasetRegion?: string; + datasetRegion?: string | null; /** * Data source id. Cannot be changed once data transfer is created. */ - dataSourceId?: string; + dataSourceId?: string | null; /** * The BigQuery target dataset id. */ - destinationDatasetId?: string; + destinationDatasetId?: string | null; /** * Is this config disabled. When set to true, no runs are scheduled for a given transfer. */ - disabled?: boolean; + disabled?: boolean | null; /** * User specified display name for the data transfer. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. */ - name?: string; + name?: string | null; /** * Output only. Next time when data transfer will run. */ - nextRunTime?: string; + nextRunTime?: string | null; /** * Data transfer specific parameters. */ - params?: {[key: string]: any}; + params?: {[key: string]: any} | null; /** * Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent. */ - schedule?: string; + schedule?: string | null; /** * Options customizing the data transfer schedule. */ @@ -512,15 +512,15 @@ export namespace bigquerydatatransfer_v1 { /** * Output only. State of the most recently updated transfer run. */ - state?: string; + state?: string | null; /** * Output only. Data transfer modification time. Ignored by server on input. */ - updateTime?: string; + updateTime?: string | null; /** * Deprecated. Unique ID of the user on whose behalf transfer is done. */ - userId?: string; + userId?: string | null; } /** * Represents a user facing message for a particular data transfer run. @@ -529,15 +529,15 @@ export namespace bigquerydatatransfer_v1 { /** * Message text. */ - messageText?: string; + messageText?: string | null; /** * Time when message was logged. */ - messageTime?: string; + messageTime?: string | null; /** * Message severity. */ - severity?: string; + severity?: string | null; } /** * Represents a data transfer run. @@ -546,15 +546,15 @@ export namespace bigquerydatatransfer_v1 { /** * Output only. Data source id. */ - dataSourceId?: string; + dataSourceId?: string | null; /** * Output only. The BigQuery target dataset id. */ - destinationDatasetId?: string; + destinationDatasetId?: string | null; /** * Output only. Time when transfer run ended. Parameter ignored by server for input requests. */ - endTime?: string; + endTime?: string | null; /** * Status of the transfer run. */ @@ -562,39 +562,39 @@ export namespace bigquerydatatransfer_v1 { /** * The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. */ - name?: string; + name?: string | null; /** * Output only. Data transfer specific parameters. */ - params?: {[key: string]: any}; + params?: {[key: string]: any} | null; /** * For batch transfer runs, specifies the date and time of the data should be ingested. */ - runTime?: string; + runTime?: string | null; /** * Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this. */ - schedule?: string; + schedule?: string | null; /** * Minimum time after which a transfer run can be started. */ - scheduleTime?: string; + scheduleTime?: string | null; /** * Output only. Time when transfer run was started. Parameter ignored by server for input requests. */ - startTime?: string; + startTime?: string | null; /** * Data transfer run state. Ignored for input requests. */ - state?: string; + state?: string | null; /** * Output only. Last time the data transfer run state was updated. */ - updateTime?: string; + updateTime?: string | null; /** * Deprecated. Unique ID of the user on whose behalf transfer is done. */ - userId?: string; + userId?: string | null; } export class Resource$Projects { diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index a02afdaf6cc..4b361960eda 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -124,7 +124,7 @@ export namespace bigqueryreservation_v1 { /** * Resource name of the slot pool that is being created. E.g., projects/myproject/locations/us-central1/reservations/foo/slotPools/123 */ - slotPool?: string; + slotPool?: 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 `{}`. @@ -137,7 +137,7 @@ export namespace bigqueryreservation_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -150,7 +150,7 @@ export namespace bigqueryreservation_v1 { /** * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations. */ - legacyLocationId?: string; + legacyLocationId?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -159,7 +159,7 @@ export namespace bigqueryreservation_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -167,15 +167,15 @@ export namespace bigqueryreservation_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -184,15 +184,15 @@ export namespace bigqueryreservation_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Operations { diff --git a/src/apis/bigqueryreservation/v1alpha2.ts b/src/apis/bigqueryreservation/v1alpha2.ts index f5824ce85cf..4e44796611e 100644 --- a/src/apis/bigqueryreservation/v1alpha2.ts +++ b/src/apis/bigqueryreservation/v1alpha2.ts @@ -124,7 +124,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * Resource name of the slot pool that is being created. E.g., projects/myproject/locations/us-central1/reservations/foo/slotPools/123 */ - slotPool?: string; + slotPool?: 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 `{}`. @@ -141,7 +141,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for ReservationService.ListReservationGrants. @@ -150,7 +150,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of reservation grants visible to the user. */ @@ -163,7 +163,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of reservations visible to the user. */ @@ -176,7 +176,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of slot pools visible to the user. */ @@ -189,23 +189,23 @@ export namespace bigqueryreservation_v1alpha2 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses. @@ -214,7 +214,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations. */ - legacyLocationId?: string; + legacyLocationId?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -223,7 +223,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -231,15 +231,15 @@ export namespace bigqueryreservation_v1alpha2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A reservation is a mechanism used to guarantee slots to users. @@ -248,15 +248,15 @@ export namespace bigqueryreservation_v1alpha2 { /** * The resource name of the reservation, e.g., "projects/x/locations/x/reservations/dev/team/product". Reservation names (e.g., "dev/team/product") exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`. */ - name?: string; + name?: string | null; /** * Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. */ - slotCapacity?: string; + slotCapacity?: string | null; /** * If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation. */ - useParentReservation?: boolean; + useParentReservation?: boolean | null; } /** * A ReservationGrant allows a project to submit jobs of a certain type using slots from the specified reservation. @@ -265,19 +265,19 @@ export namespace bigqueryreservation_v1alpha2 { /** * The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456. */ - grantee?: string; + grantee?: string | null; /** * Which type of jobs will use the reservation. */ - jobType?: string; + jobType?: string | null; /** * Output only. Name of the resource. E.g.: projects/myproject/locations/eu/reservationGrants/123. */ - name?: string; + name?: string | null; /** * 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; + reservation?: string | null; } /** * The response for ReservationService.SearchReservationGrants. @@ -286,7 +286,7 @@ export namespace bigqueryreservation_v1alpha2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of reservation grants visible to the user. */ @@ -299,23 +299,23 @@ export namespace bigqueryreservation_v1alpha2 { /** * Output only. The end of the commitment period. Slot pool cannot be removed before commitment_end_time. It is applicable only for ACTIVE slot pools and is computed as a combination of the plan and the time when the slot pool became ACTIVE. */ - commitmentEndTime?: string; + commitmentEndTime?: string | null; /** * Output only. The resource name of the slot pool, e.g., projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123 */ - name?: string; + name?: string | null; /** * Slot pool commitment plan. */ - plan?: string; + plan?: string | null; /** * Number of slots in this pool. */ - slotCount?: string; + slotCount?: string | null; /** * Output only. */ - state?: string; + state?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -324,15 +324,15 @@ export namespace bigqueryreservation_v1alpha2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/bigtableadmin/v1.ts b/src/apis/bigtableadmin/v1.ts index e57a7ff4486..d46e7961604 100644 --- a/src/apis/bigtableadmin/v1.ts +++ b/src/apis/bigtableadmin/v1.ts @@ -121,23 +121,23 @@ export namespace bigtableadmin_v1 { /** * (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. */ - defaultStorageType?: string; + defaultStorageType?: string | null; /** * (`CreationOnly`) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`. */ - location?: string; + location?: string | null; /** * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/a-z*`. */ - name?: string; + name?: string | null; /** * The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. */ - serveNodes?: number; + serveNodes?: number | null; /** * (`OutputOnly`) The current state of the cluster. */ - state?: string; + state?: string | null; } /** * The metadata for the Operation returned by CreateCluster. @@ -146,7 +146,7 @@ export namespace bigtableadmin_v1 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this CreateCluster operation. */ @@ -154,11 +154,11 @@ export namespace bigtableadmin_v1 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; /** * Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>`. Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far. */ - tables?: {[key: string]: Schema$TableProgress}; + tables?: {[key: string]: Schema$TableProgress} | null; } /** * Request message for BigtableInstanceAdmin.CreateCluster. @@ -171,11 +171,11 @@ export namespace bigtableadmin_v1 { /** * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. */ - clusterId?: string; + clusterId?: string | null; /** * The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`. */ - parent?: string; + parent?: string | null; } /** * The metadata for the Operation returned by CreateInstance. @@ -184,7 +184,7 @@ export namespace bigtableadmin_v1 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this CreateInstance operation. */ @@ -192,7 +192,7 @@ export namespace bigtableadmin_v1 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; } /** * Request message for BigtableInstanceAdmin.CreateInstance. @@ -201,7 +201,7 @@ export namespace bigtableadmin_v1 { /** * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified. */ - clusters?: {[key: string]: Schema$Cluster}; + clusters?: {[key: string]: Schema$Cluster} | null; /** * The instance to create. Fields marked `OutputOnly` must be left blank. */ @@ -209,11 +209,11 @@ export namespace bigtableadmin_v1 { /** * The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`. */ - instanceId?: string; + instanceId?: string | null; /** * The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`. */ - parent?: string; + parent?: string | null; } /** * A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. @@ -222,23 +222,23 @@ export namespace bigtableadmin_v1 { /** * The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. */ - displayName?: string; + displayName?: string | null; /** * Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * (`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/a-z+[a-z0-9]`. */ - name?: string; + name?: string | null; /** * (`OutputOnly`) The current state of the instance. */ - state?: string; + state?: string | null; /** * The type of the instance. Defaults to `PRODUCTION`. */ - type?: string; + type?: string | null; } /** * Request message for BigtableInstanceAdmin.PartialUpdateInstance. @@ -251,7 +251,7 @@ export namespace bigtableadmin_v1 { /** * The subset of Instance fields which should be replaced. Must be explicitly set. */ - updateMask?: string; + updateMask?: string | null; } /** * Progress info for copying a table's data to the new cluster. @@ -260,12 +260,12 @@ export namespace bigtableadmin_v1 { /** * Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED. */ - estimatedCopiedBytes?: string; + estimatedCopiedBytes?: string | null; /** * Estimate of the size of the table to be copied. */ - estimatedSizeBytes?: string; - state?: string; + estimatedSizeBytes?: string | null; + state?: string | null; } /** * The metadata for the Operation returned by UpdateAppProfile. @@ -278,7 +278,7 @@ export namespace bigtableadmin_v1 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this UpdateCluster operation. */ @@ -286,7 +286,7 @@ export namespace bigtableadmin_v1 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; } /** * The metadata for the Operation returned by UpdateInstance. @@ -295,7 +295,7 @@ export namespace bigtableadmin_v1 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this UpdateInstance operation. */ @@ -303,6 +303,6 @@ export namespace bigtableadmin_v1 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; } } diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 589f4fc6da8..0c82c1ed8f5 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -126,11 +126,11 @@ export namespace bigtableadmin_v2 { /** * Optional long form description of the use case for this AppProfile. */ - description?: string; + description?: string | null; /** * Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. */ - etag?: string; + etag?: string | null; /** * Use a multi-cluster routing policy. */ @@ -138,7 +138,7 @@ export namespace bigtableadmin_v2 { /** * (`OutputOnly`) The unique name of the app profile. Values are of the form `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. */ - name?: string; + name?: string | null; /** * Use a single-cluster routing policy. */ @@ -155,7 +155,7 @@ export namespace bigtableadmin_v2 { /** * 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; + 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. @@ -164,11 +164,11 @@ export namespace bigtableadmin_v2 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -181,11 +181,11 @@ export namespace bigtableadmin_v2 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency @@ -194,7 +194,7 @@ export namespace bigtableadmin_v2 { /** * The token created using GenerateConsistencyToken for the Table. */ - consistencyToken?: string; + consistencyToken?: string | null; } /** * Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency @@ -203,7 +203,7 @@ export namespace bigtableadmin_v2 { /** * True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request. */ - consistent?: boolean; + consistent?: boolean | null; } /** * A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. @@ -212,23 +212,23 @@ export namespace bigtableadmin_v2 { /** * (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. */ - defaultStorageType?: string; + defaultStorageType?: string | null; /** * (`CreationOnly`) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`. */ - location?: string; + location?: string | null; /** * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/a-z*`. */ - name?: string; + name?: string | null; /** * The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. */ - serveNodes?: number; + serveNodes?: number | null; /** * (`OutputOnly`) The current state of the cluster. */ - state?: string; + state?: string | null; } /** * The state of a table's data in a particular cluster. @@ -237,7 +237,7 @@ export namespace bigtableadmin_v2 { /** * Output only. The state of replication for the table in this cluster. */ - replicationState?: string; + replicationState?: string | null; } /** * A set of columns within a table which share a common configuration. @@ -255,7 +255,7 @@ export namespace bigtableadmin_v2 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this CreateCluster operation. */ @@ -263,11 +263,11 @@ export namespace bigtableadmin_v2 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; /** * Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>`. Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far. */ - tables?: {[key: string]: Schema$TableProgress}; + tables?: {[key: string]: Schema$TableProgress} | null; } /** * Request message for BigtableInstanceAdmin.CreateCluster. @@ -280,11 +280,11 @@ export namespace bigtableadmin_v2 { /** * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. */ - clusterId?: string; + clusterId?: string | null; /** * The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`. */ - parent?: string; + parent?: string | null; } /** * The metadata for the Operation returned by CreateInstance. @@ -293,7 +293,7 @@ export namespace bigtableadmin_v2 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this CreateInstance operation. */ @@ -301,7 +301,7 @@ export namespace bigtableadmin_v2 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; } /** * Request message for BigtableInstanceAdmin.CreateInstance. @@ -310,7 +310,7 @@ export namespace bigtableadmin_v2 { /** * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified. */ - clusters?: {[key: string]: Schema$Cluster}; + clusters?: {[key: string]: Schema$Cluster} | null; /** * The instance to create. Fields marked `OutputOnly` must be left blank. */ @@ -318,11 +318,11 @@ export namespace bigtableadmin_v2 { /** * The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`. */ - instanceId?: string; + instanceId?: string | null; /** * The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`. */ - parent?: string; + parent?: string | null; } /** * Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable @@ -339,7 +339,7 @@ export namespace bigtableadmin_v2 { /** * The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`. Maximum 50 characters. */ - tableId?: string; + tableId?: string | null; } /** * Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange @@ -348,11 +348,11 @@ export namespace bigtableadmin_v2 { /** * Delete all rows in the table. Setting this to false is a no-op. */ - deleteAllDataFromTable?: boolean; + deleteAllDataFromTable?: boolean | null; /** * Delete all rows that start with this row key prefix. Prefix cannot be zero length. */ - rowKeyPrefix?: string; + rowKeyPrefix?: 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 `{}`. @@ -365,19 +365,19 @@ export namespace bigtableadmin_v2 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Rule for determining which cells to delete during garbage collection. @@ -390,11 +390,11 @@ export namespace bigtableadmin_v2 { /** * Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity. */ - maxAge?: string; + maxAge?: string | null; /** * Delete all cells in a column except the most recent N. */ - maxNumVersions?: number; + maxNumVersions?: number | null; /** * Delete cells that would be deleted by any nested rule. */ @@ -411,7 +411,7 @@ export namespace bigtableadmin_v2 { /** * The generated consistency token. */ - consistencyToken?: string; + consistencyToken?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -427,9 +427,9 @@ export namespace bigtableadmin_v2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. @@ -438,23 +438,23 @@ export namespace bigtableadmin_v2 { /** * The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. */ - displayName?: string; + displayName?: string | null; /** * Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * (`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/a-z+[a-z0-9]`. */ - name?: string; + name?: string | null; /** * (`OutputOnly`) The current state of the instance. */ - state?: string; + state?: string | null; /** * The type of the instance. Defaults to `PRODUCTION`. */ - type?: string; + type?: string | null; } /** * A GcRule which deletes cells matching all of the given rules. @@ -476,11 +476,11 @@ export namespace bigtableadmin_v2 { /** * Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from `app_profiles`. Values are of the form `projects/<project>/locations/<zone_id>` */ - failedLocations?: string[]; + failedLocations?: string[] | null; /** * Set if not all app profiles could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for BigtableInstanceAdmin.ListClusters. @@ -493,11 +493,11 @@ export namespace bigtableadmin_v2 { /** * Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from `clusters`, or may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>` */ - failedLocations?: string[]; + failedLocations?: string[] | null; /** * DEPRECATED: This field is unused and ignored. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for BigtableInstanceAdmin.ListInstances. @@ -506,7 +506,7 @@ export namespace bigtableadmin_v2 { /** * Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from `instances`, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>` */ - failedLocations?: string[]; + failedLocations?: string[] | null; /** * The list of requested instances. */ @@ -514,7 +514,7 @@ export namespace bigtableadmin_v2 { /** * DEPRECATED: This field is unused and ignored. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -527,7 +527,7 @@ export namespace bigtableadmin_v2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -536,7 +536,7 @@ export namespace bigtableadmin_v2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -549,7 +549,7 @@ export namespace bigtableadmin_v2 { /** * Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The tables present in the requested instance. */ @@ -562,23 +562,23 @@ export namespace bigtableadmin_v2 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * A create, update, or delete of a particular column family. @@ -591,11 +591,11 @@ export namespace bigtableadmin_v2 { /** * Drop (delete) the column family with the given ID, or fail if no such family exists. */ - drop?: boolean; + drop?: boolean | null; /** * The ID of the column family to be modified. */ - id?: string; + id?: string | null; /** * Update an existing column family to the specified schema, or fail if no column family exists with the given ID. */ @@ -621,7 +621,7 @@ export namespace bigtableadmin_v2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -629,15 +629,15 @@ export namespace bigtableadmin_v2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Request message for BigtableInstanceAdmin.PartialUpdateInstance. @@ -650,7 +650,7 @@ export namespace bigtableadmin_v2 { /** * The subset of Instance fields which should be replaced. Must be explicitly set. */ - updateMask?: string; + updateMask?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -667,11 +667,11 @@ export namespace bigtableadmin_v2 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -684,7 +684,7 @@ export namespace bigtableadmin_v2 { /** * 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; + updateMask?: string | null; } /** * Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. @@ -693,11 +693,11 @@ export namespace bigtableadmin_v2 { /** * Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters. */ - allowTransactionalWrites?: boolean; + allowTransactionalWrites?: boolean | null; /** * The cluster to which read/write requests should be routed. */ - clusterId?: string; + clusterId?: string | null; } /** * An initial split point for a newly created table. @@ -706,7 +706,7 @@ export namespace bigtableadmin_v2 { /** * Row key to use as an initial tablet boundary. */ - key?: string; + key?: 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). @@ -715,15 +715,15 @@ export namespace bigtableadmin_v2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. @@ -732,19 +732,19 @@ export namespace bigtableadmin_v2 { /** * Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `FULL` */ - clusterStates?: {[key: string]: Schema$ClusterState}; + clusterStates?: {[key: string]: Schema$ClusterState} | null; /** * (`CreationOnly`) The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL` */ - columnFamilies?: {[key: string]: Schema$ColumnFamily}; + columnFamilies?: {[key: string]: Schema$ColumnFamily} | null; /** * (`CreationOnly`) The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. */ - granularity?: string; + granularity?: string | null; /** * Output only. The unique name of the table. Values are of the form `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL` */ - name?: string; + name?: string | null; } /** * Progress info for copying a table's data to the new cluster. @@ -753,12 +753,12 @@ export namespace bigtableadmin_v2 { /** * Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED. */ - estimatedCopiedBytes?: string; + estimatedCopiedBytes?: string | null; /** * Estimate of the size of the table to be copied. */ - estimatedSizeBytes?: string; - state?: string; + estimatedSizeBytes?: string | null; + state?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -767,7 +767,7 @@ export namespace bigtableadmin_v2 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -776,7 +776,7 @@ export namespace bigtableadmin_v2 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A GcRule which deletes cells matching any of the given rules. @@ -798,7 +798,7 @@ export namespace bigtableadmin_v2 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this UpdateCluster operation. */ @@ -806,7 +806,7 @@ export namespace bigtableadmin_v2 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; } /** * The metadata for the Operation returned by UpdateInstance. @@ -815,7 +815,7 @@ export namespace bigtableadmin_v2 { /** * The time at which the operation failed or was completed successfully. */ - finishTime?: string; + finishTime?: string | null; /** * The request that prompted the initiation of this UpdateInstance operation. */ @@ -823,7 +823,7 @@ export namespace bigtableadmin_v2 { /** * The time at which the original request was received. */ - requestTime?: string; + requestTime?: string | null; } export class Resource$Operations { @@ -3445,6 +3445,80 @@ 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. + * @alias bigtableadmin.projects.instances.tables.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Instances$Tables$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Instances$Tables$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Tables$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Tables$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * bigtableadmin.projects.instances.tables.list * @desc Lists all tables served from a specified instance. @@ -3596,6 +3670,163 @@ export namespace bigtableadmin_v2 { return createAPIRequest(parameters); } } + + /** + * bigtableadmin.projects.instances.tables.setIamPolicy + * @desc Sets the access control policy on a table resource. Replaces any existing policy. + * @alias bigtableadmin.projects.instances.tables.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Instances$Tables$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Instances$Tables$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Tables$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Tables$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigtableadmin.projects.instances.tables.testIamPermissions + * @desc Returns permissions that the caller has on the specified table resource. + * @alias bigtableadmin.projects.instances.tables.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Instances$Tables$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Instances$Tables$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Tables$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Tables$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}: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$Tables$Checkconsistency @@ -3694,6 +3925,23 @@ export namespace bigtableadmin_v2 { */ view?: string; } + export interface Params$Resource$Projects$Instances$Tables$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } export interface Params$Resource$Projects$Instances$Tables$List extends StandardParameters { /** @@ -3735,6 +3983,40 @@ export namespace bigtableadmin_v2 { */ requestBody?: Schema$ModifyColumnFamiliesRequest; } + export interface Params$Resource$Projects$Instances$Tables$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$Instances$Tables$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 { context: APIRequestContext; diff --git a/src/apis/binaryauthorization/index.ts b/src/apis/binaryauthorization/index.ts index 019a6a771c2..ee3d020ae8d 100644 --- a/src/apis/binaryauthorization/index.ts +++ b/src/apis/binaryauthorization/index.ts @@ -14,12 +14,20 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {binaryauthorization_v1} from './v1'; import {binaryauthorization_v1beta1} from './v1beta1'; export const VERSIONS = { + v1: binaryauthorization_v1.Binaryauthorization, v1beta1: binaryauthorization_v1beta1.Binaryauthorization, }; +export function binaryauthorization( + version: 'v1' +): binaryauthorization_v1.Binaryauthorization; +export function binaryauthorization( + options: binaryauthorization_v1.Options +): binaryauthorization_v1.Binaryauthorization; export function binaryauthorization( version: 'v1beta1' ): binaryauthorization_v1beta1.Binaryauthorization; @@ -27,10 +35,16 @@ export function binaryauthorization( options: binaryauthorization_v1beta1.Options ): binaryauthorization_v1beta1.Binaryauthorization; export function binaryauthorization< - T = binaryauthorization_v1beta1.Binaryauthorization + T = + | binaryauthorization_v1.Binaryauthorization + | binaryauthorization_v1beta1.Binaryauthorization >( this: GoogleConfigurable, - versionOrOptions: 'v1beta1' | binaryauthorization_v1beta1.Options + versionOrOptions: + | 'v1' + | binaryauthorization_v1.Options + | 'v1beta1' + | binaryauthorization_v1beta1.Options ) { return getAPI('binaryauthorization', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/binaryauthorization/v1.ts b/src/apis/binaryauthorization/v1.ts new file mode 100644 index 00000000000..1c4b480d1e9 --- /dev/null +++ b/src/apis/binaryauthorization/v1.ts @@ -0,0 +1,903 @@ +/** + * 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 binaryauthorization_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; + } + + /** + * Binary Authorization API + * + * The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters. + * + * @example + * const {google} = require('googleapis'); + * const binaryauthorization = google.binaryauthorization('v1'); + * + * @namespace binaryauthorization + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Binaryauthorization + */ + export class Binaryauthorization { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission whitelist pattern are exempted from admission rules and will never block a pod creation. + */ + export interface Schema$AdmissionRule { + /** + * Required. The action when a pod creation is denied by the admission rule. + */ + enforcementMode?: string | null; + /** + * Required. How this admission rule will be evaluated. + */ + evaluationMode?: string | null; + /** + * Optional. The resource names of the attestors that must attest to a container image, in the format `projects/x/attestors/x. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + */ + requireAttestationsBy?: string[] | null; + } + /** + * An admission whitelist pattern exempts images from checks by admission rules. + */ + export interface Schema$AdmissionWhitelistPattern { + /** + * An image name pattern to whitelist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part. + */ + namePattern?: string | null; + } + /** + * An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated. + */ + export interface Schema$Attestor { + /** + * Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs. + */ + description?: string | null; + /** + * Required. The resource name, in the format: `projects/x/attestors/x. This field may not be updated. + */ + name?: string | null; + /** + * Output only. Time when the attestor was last updated. + */ + updateTime?: string | null; + /** + * A Grafeas Attestation.Authority Note, created by the user. + */ + userOwnedGrafeasNote?: Schema$UserOwnedGrafeasNote; + } + /** + * An attestor public key that will be used to verify attestations signed by this attestor. + */ + export interface Schema$AttestorPublicKey { + /** + * ASCII-armored representation of a PGP public key, as the entire output by the command `gpg --export --armor foo@example.com` (either LF or CRLF line endings). When using this field, `id` should be left blank. The BinAuthz API handlers will calculate the ID and fill it in automatically. BinAuthz computes this ID as the OpenPGP RFC4880 V4 fingerprint, represented as upper-case hex. If `id` is provided by the caller, it will be overwritten by the API-calculated ID. + */ + asciiArmoredPgpPublicKey?: string | null; + /** + * Optional. A descriptive comment. This field may be updated. + */ + comment?: string | null; + /** + * The ID of this public key. Signatures verified by BinAuthz must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. Additional restrictions on this field can be imposed based on which public key type is encapsulated. See the documentation on `public_key` cases below for details. + */ + id?: string | null; + /** + * A raw PKIX SubjectPublicKeyInfo format public key. NOTE: `id` may be explicitly provided by the caller when using this type of public key, but it MUST be a valid RFC3986 URI. If `id` is left blank, a default one will be computed based on the digest of the DER encoding of the public key. + */ + pkixPublicKey?: Schema$PkixPublicKey; + } + /** + * 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 message for BinauthzManagementService.ListAttestors. + */ + export interface Schema$ListAttestorsResponse { + /** + * The list of attestors. + */ + attestors?: Schema$Attestor[]; + /** + * A token to retrieve the next page of results. Pass this value in the ListAttestorsRequest.page_token field in the subsequent call to the `ListAttestors` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * A public key in the PkixPublicKey format (see https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public keys of this type are typically textually encoded using the PEM format. + */ + export interface Schema$PkixPublicKey { + /** + * A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13 + */ + publicKeyPem?: string | null; + /** + * The signature algorithm used to verify a message against a signature using this key. These signature algorithm must match the structure and any object identifiers encoded in `public_key_pem` (i.e. this algorithm must match that of the public key). + */ + signatureAlgorithm?: string | null; + } + /** + * A policy for container image binary authorization. + */ + export interface Schema$Policy { + /** + * Optional. Admission policy whitelisting. A matching admission request will always be permitted. This feature is typically used to exclude Google or third-party infrastructure images from Binary Authorization policies. + */ + admissionWhitelistPatterns?: Schema$AdmissionWhitelistPattern[]; + /** + * Optional. Per-cluster admission rules. Cluster spec format: `location.clusterId`. There can be at most one admission rule per cluster spec. A `location` is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). For `clusterId` syntax restrictions see https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters. + */ + clusterAdmissionRules?: {[key: string]: Schema$AdmissionRule} | null; + /** + * Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule. + */ + defaultAdmissionRule?: Schema$AdmissionRule; + /** + * Optional. A descriptive comment. + */ + description?: string | null; + /** + * Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy. + */ + globalPolicyEvaluationMode?: string | null; + /** + * Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project. + */ + name?: string | null; + /** + * Output only. Time when the policy was last updated. + */ + updateTime?: string | null; + } + /** + * An user owned Grafeas note references a Grafeas Attestation.Authority Note created by the user. + */ + export interface Schema$UserOwnedGrafeasNote { + /** + * Output only. This field will contain the service account email address that this Attestor will use as the principal when querying Container Analysis. Attestor administrators must grant this service account the IAM role needed to read attestations from the note_reference in Container Analysis (`containeranalysis.notes.occurrences.viewer`). This email address is fixed for the lifetime of the Attestor, but callers should not make any other assumptions about the service account email; future versions may use an email based on a different naming pattern. + */ + delegationServiceAccountEmail?: string | null; + /** + * Required. The Grafeas resource name of a Attestation.Authority Note, created by the user, in the format: `projects/x/notes/x. This field may not be updated. An attestation by this attestor is stored as a Grafeas Attestation.Authority Occurrence that names a container image and that links to this Note. Grafeas is an external dependency. + */ + noteReference?: string | null; + /** + * Optional. Public keys that verify attestations signed by this attestor. This field may be updated. If this field is non-empty, one of the specified public keys must verify that an attestation was signed by this attestor for the image specified in the admission request. If this field is empty, this attestor always returns that no valid attestations exist. + */ + publicKeys?: Schema$AttestorPublicKey[]; + } + + export class Resource$Projects { + context: APIRequestContext; + attestors: Resource$Projects$Attestors; + constructor(context: APIRequestContext) { + this.context = context; + this.attestors = new Resource$Projects$Attestors(this.context); + } + + /** + * binaryauthorization.projects.getPolicy + * @desc A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the policy for this project. Returns a default policy if the project does not have one. + * @alias binaryauthorization.projects.getPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the policy to retrieve, in the format `projects/x/policy`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getPolicy( + params?: Params$Resource$Projects$Getpolicy, + options?: MethodOptions + ): GaxiosPromise; + getPolicy( + params: Params$Resource$Projects$Getpolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPolicy( + params: Params$Resource$Projects$Getpolicy, + callback: BodyResponseCallback + ): void; + getPolicy(callback: BodyResponseCallback): void; + getPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Getpolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getpolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getpolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + + /** + * binaryauthorization.projects.updatePolicy + * @desc Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed. + * @alias binaryauthorization.projects.updatePolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updatePolicy( + params?: Params$Resource$Projects$Updatepolicy, + options?: MethodOptions + ): GaxiosPromise; + updatePolicy( + params: Params$Resource$Projects$Updatepolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updatePolicy( + params: Params$Resource$Projects$Updatepolicy, + callback: BodyResponseCallback + ): void; + updatePolicy(callback: BodyResponseCallback): void; + updatePolicy( + paramsOrCallback?: + | Params$Resource$Projects$Updatepolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Updatepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Updatepolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Getpolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the policy to retrieve, in the format `projects/x/policy`. + */ + name?: string; + } + export interface Params$Resource$Projects$Updatepolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + + export class Resource$Projects$Attestors { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * binaryauthorization.projects.attestors.create + * @desc Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists. + * @alias binaryauthorization.projects.attestors.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.attestorId Required. The attestors ID. + * @param {string} params.parent Required. The parent of this attestor. + * @param {().Attestor} params.resource Request body data + * @param {object} [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$Attestors$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Attestors$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Attestors$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/attestors').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * binaryauthorization.projects.attestors.delete + * @desc Deletes an attestor. Returns NOT_FOUND if the attestor does not exist. + * @alias binaryauthorization.projects.attestors.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the attestors to delete, in the format `projects/x/attestors/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$Attestors$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Attestors$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Attestors$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + + /** + * binaryauthorization.projects.attestors.get + * @desc Gets an attestor. Returns NOT_FOUND if the attestor does not exist. + * @alias binaryauthorization.projects.attestors.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the attestor to retrieve, in the format `projects/x/attestors/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$Attestors$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Attestors$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Attestors$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + + /** + * binaryauthorization.projects.attestors.list + * @desc Lists attestors. Returns INVALID_ARGUMENT if the project does not exist. + * @alias binaryauthorization.projects.attestors.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListAttestorsResponse.next_page_token returned from the previous call to the `ListAttestors` method. + * @param {string} params.parent Required. The resource name of the project associated with the attestors, 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$Attestors$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Attestors$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Attestors$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/attestors').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * binaryauthorization.projects.attestors.update + * @desc Updates an attestor. Returns NOT_FOUND if the attestor does not exist. + * @alias binaryauthorization.projects.attestors.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name, in the format: `projects/x/attestors/x`. This field may not be updated. + * @param {().Attestor} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Projects$Attestors$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Attestors$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Attestors$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Attestors$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The attestors ID. + */ + attestorId?: string; + /** + * Required. The parent of this attestor. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Attestor; + } + export interface Params$Resource$Projects$Attestors$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the attestors to delete, in the format `projects/x/attestors/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Attestors$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the attestor to retrieve, in the format `projects/x/attestors/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Attestors$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of ListAttestorsResponse.next_page_token returned from the previous call to the `ListAttestors` method. + */ + pageToken?: string; + /** + * Required. The resource name of the project associated with the attestors, in the format `projects/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Attestors$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name, in the format: `projects/x/attestors/x`. This field may not be updated. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Attestor; + } +} diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index 91f5a667c94..683c4bbd478 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -124,15 +124,15 @@ export namespace binaryauthorization_v1beta1 { /** * Required. The action when a pod creation is denied by the admission rule. */ - enforcementMode?: string; + enforcementMode?: string | null; /** * Required. How this admission rule will be evaluated. */ - evaluationMode?: string; + evaluationMode?: string | null; /** * Optional. The resource names of the attestors that must attest to a container image, in the format `projects/x/attestors/x. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. */ - requireAttestationsBy?: string[]; + requireAttestationsBy?: string[] | null; } /** * An admission whitelist pattern exempts images from checks by admission rules. @@ -141,7 +141,7 @@ export namespace binaryauthorization_v1beta1 { /** * An image name pattern to whitelist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part. */ - namePattern?: string; + namePattern?: string | null; } /** * An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated. @@ -150,15 +150,15 @@ export namespace binaryauthorization_v1beta1 { /** * Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs. */ - description?: string; + description?: string | null; /** * Required. The resource name, in the format: `projects/x/attestors/x. This field may not be updated. */ - name?: string; + name?: string | null; /** * Output only. Time when the attestor was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * A Drydock ATTESTATION_AUTHORITY Note, created by the user. */ @@ -171,15 +171,15 @@ export namespace binaryauthorization_v1beta1 { /** * ASCII-armored representation of a PGP public key, as the entire output by the command `gpg --export --armor foo@example.com` (either LF or CRLF line endings). When using this field, `id` should be left blank. The BinAuthz API handlers will calculate the ID and fill it in automatically. BinAuthz computes this ID as the OpenPGP RFC4880 V4 fingerprint, represented as upper-case hex. If `id` is provided by the caller, it will be overwritten by the API-calculated ID. */ - asciiArmoredPgpPublicKey?: string; + asciiArmoredPgpPublicKey?: string | null; /** * Optional. A descriptive comment. This field may be updated. */ - comment?: string; + comment?: string | null; /** * The ID of this public key. Signatures verified by BinAuthz must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. Additional restrictions on this field can be imposed based on which public key type is encapsulated. See the documentation on `public_key` cases below for details. */ - id?: string; + id?: string | null; /** * A raw PKIX SubjectPublicKeyInfo format public key. NOTE: `id` may be explicitly provided by the caller when using this type of public key, but it MUST be a valid RFC3986 URI. If `id` is left blank, a default one will be computed based on the digest of the DER encoding of the public key. */ @@ -196,11 +196,11 @@ export namespace binaryauthorization_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -213,19 +213,19 @@ export namespace binaryauthorization_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -238,11 +238,11 @@ export namespace binaryauthorization_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Response message for BinauthzManagementService.ListAttestors. @@ -255,7 +255,7 @@ export namespace binaryauthorization_v1beta1 { /** * A token to retrieve the next page of results. Pass this value in the ListAttestorsRequest.page_token field in the subsequent call to the `ListAttestors` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A public key in the PkixPublicKey format (see https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public keys of this type are typically textually encoded using the PEM format. @@ -264,11 +264,11 @@ export namespace binaryauthorization_v1beta1 { /** * A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13 */ - publicKeyPem?: string; + publicKeyPem?: string | null; /** * The signature algorithm used to verify a message against a signature using this key. These signature algorithm must match the structure and any object identifiers encoded in `public_key_pem` (i.e. this algorithm must match that of the public key). */ - signatureAlgorithm?: string; + signatureAlgorithm?: string | null; } /** * A policy for container image binary authorization. @@ -281,7 +281,7 @@ export namespace binaryauthorization_v1beta1 { /** * Optional. Per-cluster admission rules. Cluster spec format: `location.clusterId`. There can be at most one admission rule per cluster spec. A `location` is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). For `clusterId` syntax restrictions see https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters. */ - clusterAdmissionRules?: {[key: string]: Schema$AdmissionRule}; + clusterAdmissionRules?: {[key: string]: Schema$AdmissionRule} | null; /** * Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule. */ @@ -289,19 +289,19 @@ export namespace binaryauthorization_v1beta1 { /** * Optional. A descriptive comment. */ - description?: string; + description?: string | null; /** * Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy. */ - globalPolicyEvaluationMode?: string; + globalPolicyEvaluationMode?: string | null; /** * Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project. */ - name?: string; + name?: string | null; /** * Output only. Time when the policy was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -319,7 +319,7 @@ export namespace binaryauthorization_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -328,7 +328,7 @@ export namespace binaryauthorization_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * An user owned drydock note references a Drydock ATTESTATION_AUTHORITY Note created by the user. @@ -337,11 +337,11 @@ export namespace binaryauthorization_v1beta1 { /** * Output only. This field will contain the service account email address that this Attestor will use as the principal when querying Container Analysis. Attestor administrators must grant this service account the IAM role needed to read attestations from the note_reference in Container Analysis (`containeranalysis.notes.occurrences.viewer`). This email address is fixed for the lifetime of the Attestor, but callers should not make any other assumptions about the service account email; future versions may use an email based on a different naming pattern. */ - delegationServiceAccountEmail?: string; + delegationServiceAccountEmail?: string | null; /** * Required. The Drydock resource name of a ATTESTATION_AUTHORITY Note, created by the user, in the format: `projects/x/notes/x (or the legacy `providers/x/notes/x). This field may not be updated. An attestation by this attestor is stored as a Drydock ATTESTATION_AUTHORITY Occurrence that names a container image and that links to this Note. Drydock is an external dependency. */ - noteReference?: string; + noteReference?: string | null; /** * Optional. Public keys that verify attestations signed by this attestor. This field may be updated. If this field is non-empty, one of the specified public keys must verify that an attestation was signed by this attestor for the image specified in the admission request. If this field is empty, this attestor always returns that no valid attestations exist. */ @@ -758,7 +758,7 @@ export namespace binaryauthorization_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1190,7 +1190,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** @@ -1283,7 +1283,7 @@ export namespace binaryauthorization_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1520,7 +1520,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts index e6b99e2974b..80b9c3860d6 100644 --- a/src/apis/blogger/v2.ts +++ b/src/apis/blogger/v2.ts @@ -113,47 +113,47 @@ export namespace blogger_v2 { /** * The description of this blog. This is displayed underneath the title. */ - description?: string; + description?: string | null; /** * The identifier for this resource. */ - id?: string; + id?: string | null; /** * The kind of this entry. Always blogger#blog */ - kind?: string; + kind?: string | null; /** * The locale this Blog is set to. */ - locale?: {country?: string; language?: string; variant?: string}; + locale?: {country?: string; language?: string; variant?: string} | null; /** * The name of this blog. This is displayed as the title. */ - name?: string; + name?: string | null; /** * The container of pages in this blog. */ - pages?: {selfLink?: string; totalItems?: number}; + pages?: {selfLink?: string; totalItems?: number} | null; /** * The container of posts in this blog. */ - posts?: {selfLink?: string; totalItems?: number}; + posts?: {selfLink?: string; totalItems?: number} | null; /** * RFC 3339 date-time when this blog was published. */ - published?: string; + published?: string | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * RFC 3339 date-time when this blog was last updated. */ - updated?: string; + updated?: string | null; /** * The URL where this blog is published. */ - url?: string; + url?: string | null; } export interface Schema$BlogList { /** @@ -163,7 +163,7 @@ export namespace blogger_v2 { /** * The kind of this entity. Always blogger#blogList */ - kind?: string; + kind?: string | null; } export interface Schema$Comment { /** @@ -174,43 +174,43 @@ export namespace blogger_v2 { id?: string; image?: {url?: string}; url?: string; - }; + } | null; /** * Data about the blog containing this comment. */ - blog?: {id?: string}; + blog?: {id?: string} | null; /** * The actual content of the comment. May include HTML markup. */ - content?: string; + content?: string | null; /** * The identifier for this resource. */ - id?: string; + id?: string | null; /** * Data about the comment this is in reply to. */ - inReplyTo?: {id?: string}; + inReplyTo?: {id?: string} | null; /** * The kind of this entry. Always blogger#comment */ - kind?: string; + kind?: string | null; /** * Data about the post containing this comment. */ - post?: {id?: string}; + post?: {id?: string} | null; /** * RFC 3339 date-time when this comment was published. */ - published?: string; + published?: string | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * RFC 3339 date-time when this comment was last updated. */ - updated?: string; + updated?: string | null; } export interface Schema$CommentList { /** @@ -220,15 +220,15 @@ export namespace blogger_v2 { /** * The kind of this entry. Always blogger#commentList */ - kind?: string; + kind?: string | null; /** * Pagination token to fetch the next page, if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Pagination token to fetch the previous page, if one exists. */ - prevPageToken?: string; + prevPageToken?: string | null; } export interface Schema$Page { /** @@ -239,43 +239,43 @@ export namespace blogger_v2 { id?: string; image?: {url?: string}; url?: string; - }; + } | null; /** * Data about the blog containing this Page. */ - blog?: {id?: string}; + blog?: {id?: string} | null; /** * The body content of this Page, in HTML. */ - content?: string; + content?: string | null; /** * The identifier for this resource. */ - id?: string; + id?: string | null; /** * The kind of this entity. Always blogger#page */ - kind?: string; + kind?: string | null; /** * RFC 3339 date-time when this Page was published. */ - published?: string; + published?: string | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * The title of this entity. This is the name displayed in the Admin user interface. */ - title?: string; + title?: string | null; /** * RFC 3339 date-time when this Page was last updated. */ - updated?: string; + updated?: string | null; /** * The URL that this Page is displayed at. */ - url?: string; + url?: string | null; } export interface Schema$PageList { /** @@ -285,7 +285,7 @@ export namespace blogger_v2 { /** * The kind of this entity. Always blogger#pageList */ - kind?: string; + kind?: string | null; } export interface Schema$Post { /** @@ -296,51 +296,51 @@ export namespace blogger_v2 { id?: string; image?: {url?: string}; url?: string; - }; + } | null; /** * Data about the blog containing this Post. */ - blog?: {id?: string}; + blog?: {id?: string} | null; /** * The content of the Post. May contain HTML markup. */ - content?: string; + content?: string | null; /** * The identifier of this Post. */ - id?: string; + id?: string | null; /** * The kind of this entity. Always blogger#post */ - kind?: string; + kind?: string | null; /** * The list of labels this Post was tagged with. */ - labels?: string[]; + labels?: string[] | null; /** * RFC 3339 date-time when this Post was published. */ - published?: string; + published?: string | null; /** * The container of comments on this Post. */ - replies?: {selfLink?: string; totalItems?: string}; + replies?: {selfLink?: string; totalItems?: string} | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * The title of the Post. */ - title?: string; + title?: string | null; /** * RFC 3339 date-time when this Post was last updated. */ - updated?: string; + updated?: string | null; /** * The URL where this Post is displayed. */ - url?: string; + url?: string | null; } export interface Schema$PostList { /** @@ -350,53 +350,53 @@ export namespace blogger_v2 { /** * The kind of this entity. Always blogger#postList */ - kind?: string; + kind?: string | null; /** * Pagination token to fetch the next page, if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Pagination token to fetch the previous page, if one exists. */ - prevPageToken?: string; + prevPageToken?: string | null; } export interface Schema$User { /** * Profile summary information. */ - about?: string; + about?: string | null; /** * The container of blogs for this user. */ - blogs?: {selfLink?: string}; + blogs?: {selfLink?: string} | null; /** * The timestamp of when this profile was created, in seconds since epoch. */ - created?: string; + created?: string | null; /** * The display name. */ - displayName?: string; + displayName?: string | null; /** * The identifier for this User. */ - id?: string; + id?: string | null; /** * The kind of this entity. Always blogger#user */ - kind?: string; + kind?: string | null; /** * This user's locale */ - locale?: {country?: string; language?: string; variant?: string}; + locale?: {country?: string; language?: string; variant?: string} | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * The user's profile page. */ - url?: string; + url?: string | null; } export class Resource$Blogs { diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts index 9df8e66368e..57feafe1838 100644 --- a/src/apis/blogger/v3.ts +++ b/src/apis/blogger/v3.ts @@ -119,55 +119,59 @@ export namespace blogger_v3 { /** * The JSON custom meta-data for the Blog */ - customMetaData?: string; + customMetaData?: string | null; /** * The description of this blog. This is displayed underneath the title. */ - description?: string; + description?: string | null; /** * The identifier for this resource. */ - id?: string; + id?: string | null; /** * The kind of this entry. Always blogger#blog */ - kind?: string; + kind?: string | null; /** * The locale this Blog is set to. */ - locale?: {country?: string; language?: string; variant?: string}; + locale?: {country?: string; language?: string; variant?: string} | null; /** * The name of this blog. This is displayed as the title. */ - name?: string; + name?: string | null; /** * The container of pages in this blog. */ - pages?: {selfLink?: string; totalItems?: number}; + pages?: {selfLink?: string; totalItems?: number} | null; /** * The container of posts in this blog. */ - posts?: {items?: Schema$Post[]; selfLink?: string; totalItems?: number}; + posts?: { + items?: Schema$Post[]; + selfLink?: string; + totalItems?: number; + } | null; /** * RFC 3339 date-time when this blog was published. */ - published?: string; + published?: string | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * The status of the blog. */ - status?: string; + status?: string | null; /** * RFC 3339 date-time when this blog was last updated. */ - updated?: string; + updated?: string | null; /** * The URL where this blog is published. */ - url?: string; + url?: string | null; } export interface Schema$BlogList { /** @@ -181,33 +185,33 @@ export namespace blogger_v3 { /** * The kind of this entity. Always blogger#blogList */ - kind?: string; + kind?: string | null; } export interface Schema$BlogPerUserInfo { /** * ID of the Blog resource */ - blogId?: string; + blogId?: string | null; /** * True if the user has Admin level access to the blog. */ - hasAdminAccess?: boolean; + hasAdminAccess?: boolean | null; /** * The kind of this entity. Always blogger#blogPerUserInfo */ - kind?: string; + kind?: string | null; /** * The Photo Album Key for the user when adding photos to the blog */ - photosAlbumKey?: string; + photosAlbumKey?: string | null; /** * Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). */ - role?: string; + role?: string | null; /** * ID of the User */ - userId?: string; + userId?: string | null; } export interface Schema$BlogUserInfo { /** @@ -221,7 +225,7 @@ export namespace blogger_v3 { /** * The kind of this entity. Always blogger#blogUserInfo */ - kind?: string; + kind?: string | null; } export interface Schema$Comment { /** @@ -232,53 +236,53 @@ export namespace blogger_v3 { id?: string; image?: {url?: string}; url?: string; - }; + } | null; /** * Data about the blog containing this comment. */ - blog?: {id?: string}; + blog?: {id?: string} | null; /** * The actual content of the comment. May include HTML markup. */ - content?: string; + content?: string | null; /** * The identifier for this resource. */ - id?: string; + id?: string | null; /** * Data about the comment this is in reply to. */ - inReplyTo?: {id?: string}; + inReplyTo?: {id?: string} | null; /** * The kind of this entry. Always blogger#comment */ - kind?: string; + kind?: string | null; /** * Data about the post containing this comment. */ - post?: {id?: string}; + post?: {id?: string} | null; /** * RFC 3339 date-time when this comment was published. */ - published?: string; + published?: string | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * The status of the comment (only populated for admin users) */ - status?: string; + status?: string | null; /** * RFC 3339 date-time when this comment was last updated. */ - updated?: string; + updated?: string | null; } export interface Schema$CommentList { /** * Etag of the response. */ - etag?: string; + etag?: string | null; /** * The List of Comments for a Post. */ @@ -286,15 +290,15 @@ export namespace blogger_v3 { /** * The kind of this entry. Always blogger#commentList */ - kind?: string; + kind?: string | null; /** * Pagination token to fetch the next page, if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Pagination token to fetch the previous page, if one exists. */ - prevPageToken?: string; + prevPageToken?: string | null; } export interface Schema$Page { /** @@ -305,57 +309,57 @@ export namespace blogger_v3 { id?: string; image?: {url?: string}; url?: string; - }; + } | null; /** * Data about the blog containing this Page. */ - blog?: {id?: string}; + blog?: {id?: string} | null; /** * The body content of this Page, in HTML. */ - content?: string; + content?: string | null; /** * Etag of the resource. */ - etag?: string; + etag?: string | null; /** * The identifier for this resource. */ - id?: string; + id?: string | null; /** * The kind of this entity. Always blogger#page */ - kind?: string; + kind?: string | null; /** * RFC 3339 date-time when this Page was published. */ - published?: string; + published?: string | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * The status of the page for admin resources (either LIVE or DRAFT). */ - status?: string; + status?: string | null; /** * The title of this entity. This is the name displayed in the Admin user interface. */ - title?: string; + title?: string | null; /** * RFC 3339 date-time when this Page was last updated. */ - updated?: string; + updated?: string | null; /** * The URL that this Page is displayed at. */ - url?: string; + url?: string | null; } export interface Schema$PageList { /** * Etag of the response. */ - etag?: string; + etag?: string | null; /** * The list of Pages for a Blog. */ @@ -363,25 +367,25 @@ export namespace blogger_v3 { /** * The kind of this entity. Always blogger#pageList */ - kind?: string; + kind?: string | null; /** * Pagination token to fetch the next page, if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$Pageviews { /** * Blog Id */ - blogId?: string; + blogId?: string | null; /** * The container of posts in this blog. */ - counts?: Array<{count?: string; timeRange?: string}>; + counts?: Array<{count?: string; timeRange?: string}> | null; /** * The kind of this entry. Always blogger#page_views */ - kind?: string; + kind?: string | null; } export interface Schema$Post { /** @@ -392,51 +396,56 @@ export namespace blogger_v3 { id?: string; image?: {url?: string}; url?: string; - }; + } | null; /** * Data about the blog containing this Post. */ - blog?: {id?: string}; + blog?: {id?: string} | null; /** * The content of the Post. May contain HTML markup. */ - content?: string; + content?: string | null; /** * The JSON meta-data for the Post. */ - customMetaData?: string; + customMetaData?: string | null; /** * Etag of the resource. */ - etag?: string; + etag?: string | null; /** * The identifier of this Post. */ - id?: string; + id?: string | null; /** * Display image for the Post. */ - images?: Array<{url?: string}>; + images?: Array<{url?: string}> | null; /** * The kind of this entity. Always blogger#post */ - kind?: string; + kind?: string | null; /** * The list of labels this Post was tagged with. */ - labels?: string[]; + labels?: string[] | null; /** * The location for geotagged posts. */ - location?: {lat?: number; lng?: number; name?: string; span?: string}; + location?: { + lat?: number; + lng?: number; + name?: string; + span?: string; + } | null; /** * RFC 3339 date-time when this Post was published. */ - published?: string; + published?: string | null; /** * Comment control and display setting for readers of this post. */ - readerComments?: string; + readerComments?: string | null; /** * The container of comments on this Post. */ @@ -444,37 +453,37 @@ export namespace blogger_v3 { items?: Schema$Comment[]; selfLink?: string; totalItems?: string; - }; + } | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * Status of the post. Only set for admin-level requests */ - status?: string; + status?: string | null; /** * The title of the Post. */ - title?: string; + title?: string | null; /** * The title link URL, similar to atom's related link. */ - titleLink?: string; + titleLink?: string | null; /** * RFC 3339 date-time when this Post was last updated. */ - updated?: string; + updated?: string | null; /** * The URL where this Post is displayed. */ - url?: string; + url?: string | null; } export interface Schema$PostList { /** * Etag of the response. */ - etag?: string; + etag?: string | null; /** * The list of Posts for this Blog. */ @@ -482,39 +491,39 @@ export namespace blogger_v3 { /** * The kind of this entity. Always blogger#postList */ - kind?: string; + kind?: string | null; /** * Pagination token to fetch the next page, if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$PostPerUserInfo { /** * ID of the Blog that the post resource belongs to. */ - blogId?: string; + blogId?: string | null; /** * True if the user has Author level access to the post. */ - hasEditAccess?: boolean; + hasEditAccess?: boolean | null; /** * The kind of this entity. Always blogger#postPerUserInfo */ - kind?: string; + kind?: string | null; /** * ID of the Post resource. */ - postId?: string; + postId?: string | null; /** * ID of the User. */ - userId?: string; + userId?: string | null; } export interface Schema$PostUserInfo { /** * The kind of this entity. Always blogger#postUserInfo */ - kind?: string; + kind?: string | null; /** * The Post resource. */ @@ -532,49 +541,49 @@ export namespace blogger_v3 { /** * The kind of this entity. Always blogger#postList */ - kind?: string; + kind?: string | null; /** * Pagination token to fetch the next page, if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$User { /** * Profile summary information. */ - about?: string; + about?: string | null; /** * The container of blogs for this user. */ - blogs?: {selfLink?: string}; + blogs?: {selfLink?: string} | null; /** * The timestamp of when this profile was created, in seconds since epoch. */ - created?: string; + created?: string | null; /** * The display name. */ - displayName?: string; + displayName?: string | null; /** * The identifier for this User. */ - id?: string; + id?: string | null; /** * The kind of this entity. Always blogger#user */ - kind?: string; + kind?: string | null; /** * This user's locale */ - locale?: {country?: string; language?: string; variant?: string}; + locale?: {country?: string; language?: string; variant?: string} | null; /** * The API REST URL to fetch this resource from. */ - selfLink?: string; + selfLink?: string | null; /** * The user's profile page. */ - url?: string; + url?: string | null; } export class Resource$Blogs { diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts index 665043363e6..e791598a78f 100644 --- a/src/apis/books/v1.ts +++ b/src/apis/books/v1.ts @@ -129,11 +129,11 @@ export namespace books_v1 { /** * Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. */ - afterSelectedText?: string; + afterSelectedText?: string | null; /** * Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. */ - beforeSelectedText?: string; + beforeSelectedText?: string | null; /** * Selection ranges sent from the client. */ @@ -143,11 +143,11 @@ export namespace books_v1 { gbImageRange?: Schema$BooksAnnotationsRange; gbTextRange?: Schema$BooksAnnotationsRange; imageCfiRange?: Schema$BooksAnnotationsRange; - }; + } | null; /** * Timestamp for the created time of this annotation. */ - created?: string; + created?: string | null; /** * Selection ranges for the most recent content version. */ @@ -157,91 +157,91 @@ export namespace books_v1 { gbImageRange?: Schema$BooksAnnotationsRange; gbTextRange?: Schema$BooksAnnotationsRange; imageCfiRange?: Schema$BooksAnnotationsRange; - }; + } | null; /** * User-created data for this annotation. */ - data?: string; + data?: string | null; /** * Indicates that this annotation is deleted. */ - deleted?: boolean; + deleted?: boolean | null; /** * The highlight style for this annotation. */ - highlightStyle?: string; + highlightStyle?: string | null; /** * Id of this annotation, in the form of a GUID. */ - id?: string; + id?: string | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The layer this annotation is for. */ - layerId?: string; + layerId?: string | null; layerSummary?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; - }; + } | null; /** * Pages that this annotation spans. */ - pageIds?: string[]; + pageIds?: string[] | null; /** * Excerpt from the volume. */ - selectedText?: string; + selectedText?: string | null; /** * URL to this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Timestamp for the last time this annotation was modified. */ - updated?: string; + updated?: string | null; /** * The volume that this annotation belongs to. */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$Annotationdata { /** * The type of annotation this data is for. */ - annotationType?: string; - data?: any; + annotationType?: string | null; + data?: any | null; /** * Base64 encoded data for this annotation data. */ - encoded_data?: string; + encoded_data?: string | null; /** * Unique id for this annotation data. */ - id?: string; + id?: string | null; /** * Resource Type */ - kind?: string; + kind?: string | null; /** * The Layer id for this data. * */ - layerId?: string; + layerId?: string | null; /** * URL for this resource. * */ - selfLink?: string; + selfLink?: string | null; /** * Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). */ - updated?: string; + updated?: string | null; /** * The volume id for this data. * */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$Annotations { /** @@ -251,15 +251,15 @@ export namespace books_v1 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Token to pass in for pagination for the next page. This will not be present if this request does not have more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$Annotationsdata { /** @@ -269,91 +269,91 @@ export namespace books_v1 { /** * Resource type */ - kind?: string; + kind?: string | null; /** * Token to pass in for pagination for the next page. This will not be present if this request does not have more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of volume annotations found. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$AnnotationsSummary { - kind?: string; + kind?: string | null; layers?: Array<{ allowedCharacterCount?: number; layerId?: string; limitType?: string; remainingCharacterCount?: number; updated?: string; - }>; + }> | null; } export interface Schema$BooksAnnotationsRange { /** * The offset from the ending position. */ - endOffset?: string; + endOffset?: string | null; /** * The ending position for the range. */ - endPosition?: string; + endPosition?: string | null; /** * The offset from the starting position. */ - startOffset?: string; + startOffset?: string | null; /** * The starting position for the range. */ - startPosition?: string; + startPosition?: string | null; } export interface Schema$BooksCloudloadingResource { - author?: string; - processingState?: string; - title?: string; - volumeId?: string; + author?: string | null; + processingState?: string | null; + title?: string | null; + volumeId?: string | null; } export interface Schema$Bookshelf { /** * Whether this bookshelf is PUBLIC or PRIVATE. */ - access?: string; + access?: string | null; /** * Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). */ - created?: string; + created?: string | null; /** * Description of this bookshelf. */ - description?: string; + description?: string | null; /** * Id of this bookshelf, only unique by user. */ - id?: number; + id?: number | null; /** * Resource type for bookshelf metadata. */ - kind?: string; + kind?: string | null; /** * URL to this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Title of this bookshelf. */ - title?: string; + title?: string | null; /** * Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). */ - updated?: string; + updated?: string | null; /** * Number of volumes in this bookshelf. */ - volumeCount?: number; + volumeCount?: number | null; /** * Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). */ - volumesLastUpdated?: string; + volumesLastUpdated?: string | null; } export interface Schema$Bookshelves { /** @@ -363,69 +363,73 @@ export namespace books_v1 { /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$BooksVolumesRecommendedRateResponse { - consistency_token?: string; + consistency_token?: string | null; } export interface Schema$Category { /** * A list of onboarding categories. */ - items?: Array<{badgeUrl?: string; categoryId?: string; name?: string}>; + items?: Array<{ + badgeUrl?: string; + categoryId?: string; + name?: string; + }> | null; /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$ConcurrentAccessRestriction { /** * Whether access is granted for this (user, device, volume). */ - deviceAllowed?: boolean; + deviceAllowed?: boolean | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The maximum number of concurrent access licenses for this volume. */ - maxConcurrentDevices?: number; + maxConcurrentDevices?: number | null; /** * Error/warning message. */ - message?: string; + message?: string | null; /** * Client nonce for verification. Download access and client-validation only. */ - nonce?: string; + nonce?: string | null; /** * Error/warning reason code. */ - reasonCode?: string; + reasonCode?: string | null; /** * Whether this volume has any concurrent access restrictions. */ - restricted?: boolean; + restricted?: boolean | null; /** * Response signature. */ - signature?: string; + signature?: string | null; /** * Client app identifier for verification. Download access and client-validation only. */ - source?: string; + source?: string | null; /** * Time in seconds for license auto-expiration. */ - timeWindowSeconds?: number; + timeWindowSeconds?: number | null; /** * Identifies the volume for which this entry applies. */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$Dictlayerdata { - common?: {title?: string}; + common?: {title?: string} | null; dict?: { source?: {attribution?: string; url?: string}; words?: Array<{ @@ -458,8 +462,8 @@ export namespace books_v1 { }>; source?: {attribution?: string; url?: string}; }>; - }; - kind?: string; + } | null; + kind?: string | null; } export interface Schema$Discoveryclusters { clusters?: Array<{ @@ -476,12 +480,12 @@ export namespace books_v1 { totalVolumes?: number; uid?: string; volumes?: Schema$Volume[]; - }>; + }> | null; /** * Resorce type. */ - kind?: string; - totalClusters?: number; + kind?: string | null; + totalClusters?: number | null; } export interface Schema$DownloadAccesses { /** @@ -491,63 +495,63 @@ export namespace books_v1 { /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$DownloadAccessRestriction { /** * If restricted, whether access is granted for this (user, device, volume). */ - deviceAllowed?: boolean; + deviceAllowed?: boolean | null; /** * If restricted, the number of content download licenses already acquired (including the requesting client, if licensed). */ - downloadsAcquired?: number; + downloadsAcquired?: number | null; /** * If deviceAllowed, whether access was just acquired with this request. */ - justAcquired?: boolean; + justAcquired?: boolean | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * If restricted, the maximum number of content download licenses for this volume. */ - maxDownloadDevices?: number; + maxDownloadDevices?: number | null; /** * Error/warning message. */ - message?: string; + message?: string | null; /** * Client nonce for verification. Download access and client-validation only. */ - nonce?: string; + nonce?: string | null; /** * Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS */ - reasonCode?: string; + reasonCode?: string | null; /** * Whether this volume has any download access restrictions. */ - restricted?: boolean; + restricted?: boolean | null; /** * Response signature. */ - signature?: string; + signature?: string | null; /** * Client app identifier for verification. Download access and client-validation only. */ - source?: string; + source?: string | null; /** * Identifies the volume for which this entry applies. */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$FamilyInfo { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Family membership info of the user that made the request. */ @@ -557,7 +561,7 @@ export namespace books_v1 { allowedMaturityRating?: string; isInFamily?: boolean; role?: string; - }; + } | null; } export interface Schema$Geolayerdata { common?: { @@ -566,7 +570,7 @@ export namespace books_v1 { snippet?: string; snippetUrl?: string; title?: string; - }; + } | null; geo?: { boundary?: Array>; cachePolicy?: string; @@ -579,8 +583,8 @@ export namespace books_v1 { lo?: {latitude?: number; longitude?: number}; }; zoom?: number; - }; - kind?: string; + } | null; + kind?: string | null; } export interface Schema$Layersummaries { /** @@ -590,65 +594,65 @@ export namespace books_v1 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * The total number of layer summaries found. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$Layersummary { /** * The number of annotations for this layer. */ - annotationCount?: number; + annotationCount?: number | null; /** * Link to get data for this annotation. */ - annotationsDataLink?: string; + annotationsDataLink?: string | null; /** * The link to get the annotations for this layer. */ - annotationsLink?: string; + annotationsLink?: string | null; /** * The list of annotation types contained for this layer. */ - annotationTypes?: string[]; + annotationTypes?: string[] | null; /** * The content version this resource is for. */ - contentVersion?: string; + contentVersion?: string | null; /** * The number of data items for this layer. */ - dataCount?: number; + dataCount?: number | null; /** * Unique id of this layer summary. */ - id?: string; + id?: string | null; /** * Resource Type */ - kind?: string; + kind?: string | null; /** * The layer id for this summary. */ - layerId?: string; + layerId?: string | null; /** * URL to this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format). */ - updated?: string; + updated?: string | null; /** * The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately. */ - volumeAnnotationsVersion?: string; + volumeAnnotationsVersion?: string | null; /** * The volume id this resource is for. */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$Metadata { /** @@ -660,35 +664,35 @@ export namespace books_v1 { language?: string; size?: string; version?: string; - }>; + }> | null; /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$Notification { - body?: string; + body?: string | null; /** * The list of crm experiment ids. */ - crmExperimentIds?: string[]; - doc_id?: string; - doc_type?: string; - dont_show_notification?: boolean; - iconUrl?: string; - is_document_mature?: boolean; + crmExperimentIds?: string[] | null; + doc_id?: string | null; + doc_type?: string | null; + dont_show_notification?: boolean | null; + iconUrl?: string | null; + is_document_mature?: boolean | null; /** * Resource type. */ - kind?: string; - notificationGroup?: string; - notification_type?: string; - pcampaign_id?: string; - reason?: string; - show_notification_settings_action?: boolean; - targetUrl?: string; - timeToExpireMs?: string; - title?: string; + kind?: string | null; + notificationGroup?: string | null; + notification_type?: string | null; + pcampaign_id?: string | null; + reason?: string | null; + show_notification_settings_action?: boolean | null; + targetUrl?: string | null; + timeToExpireMs?: string | null; + title?: string | null; } export interface Schema$Offers { /** @@ -706,41 +710,41 @@ export namespace books_v1 { title?: string; volumeId?: string; }>; - }>; + }> | null; /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$ReadingPosition { /** * Position in an EPUB as a CFI. */ - epubCfiPosition?: string; + epubCfiPosition?: string | null; /** * Position in a volume for image-based content. */ - gbImagePosition?: string; + gbImagePosition?: string | null; /** * Position in a volume for text-based content. */ - gbTextPosition?: string; + gbTextPosition?: string | null; /** * Resource type for a reading position. */ - kind?: string; + kind?: string | null; /** * Position in a PDF file. */ - pdfPosition?: string; + pdfPosition?: string | null; /** * Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution). */ - updated?: string; + updated?: string | null; /** * Volume id associated with this reading position. */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$RequestAccess { /** @@ -754,87 +758,91 @@ export namespace books_v1 { /** * Resource type. */ - kind?: string; + kind?: string | null; } export interface Schema$Review { /** * Author of this review. */ - author?: {displayName?: string}; + author?: {displayName?: string} | null; /** * Review text. */ - content?: string; + content?: string | null; /** * Date of this review. */ - date?: string; + date?: string | null; /** * URL for the full review text, for reviews gathered from the web. */ - fullTextUrl?: string; + fullTextUrl?: string | null; /** * Resource type for a review. */ - kind?: string; + kind?: string | null; /** * Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. */ - rating?: string; + rating?: string | null; /** * Information regarding the source of this review, when the review is not from a Google Books user. */ - source?: {description?: string; extraDescription?: string; url?: string}; + source?: { + description?: string; + extraDescription?: string; + url?: string; + } | null; /** * Title for this review. */ - title?: string; + title?: string | null; /** * Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. */ - type?: string; + type?: string | null; /** * Volume that this review is for. */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$Series { /** * Resource type. */ - kind?: string; + kind?: string | null; series?: Array<{ bannerImageUrl?: string; imageUrl?: string; seriesId?: string; seriesType?: string; title?: string; - }>; + }> | null; } export interface Schema$Seriesmembership { /** * Resorce type. */ - kind?: string; + kind?: string | null; member?: Schema$Volume[]; - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$Usersettings { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * User settings in sub-objects, each for different purposes. */ - notesExport?: {folderName?: string; isEnabled?: boolean}; + notesExport?: {folderName?: string; isEnabled?: boolean} | null; notification?: { matchMyInterests?: {opted_state?: string}; moreFromAuthors?: {opted_state?: string}; moreFromSeries?: {opted_state?: string}; priceDrop?: {opted_state?: string}; rewardExpirations?: {opted_state?: string}; - }; + } | null; } export interface Schema$Volume { /** @@ -863,29 +871,29 @@ export namespace books_v1 { viewOrderUrl?: string; viewability?: string; webReaderLink?: string; - }; + } | null; /** * Opaque identifier for a specific version of a volume resource. (In LITE projection) */ - etag?: string; + etag?: string | null; /** * Unique identifier for a volume. (In LITE projection.) */ - id?: string; + id?: string | null; /** * Resource type for a volume. (In LITE projection.) */ - kind?: string; + kind?: string | null; /** * What layers exist in this volume and high level information about them. */ layerInfo?: { layers?: Array<{layerId?: string; volumeAnnotationsVersion?: string}>; - }; + } | null; /** * Recommendation related information for this volume. */ - recommendedInfo?: {explanation?: string}; + recommendedInfo?: {explanation?: string} | null; /** * Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries). */ @@ -904,15 +912,15 @@ export namespace books_v1 { onSaleDate?: string; retailPrice?: {amount?: number; currencyCode?: string}; saleability?: string; - }; + } | null; /** * Search result information related to this volume. */ - searchInfo?: {textSnippet?: string}; + searchInfo?: {textSnippet?: string} | null; /** * URL to this resource. (In LITE projection.) */ - selfLink?: string; + selfLink?: string | null; /** * User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) */ @@ -945,7 +953,7 @@ export namespace books_v1 { review?: Schema$Review; updated?: string; userUploadedVolumeInfo?: {processingState?: string}; - }; + } | null; /** * General volume information. */ @@ -990,7 +998,7 @@ export namespace books_v1 { seriesInfo?: Schema$Volumeseriesinfo; subtitle?: string; title?: string; - }; + } | null; } export interface Schema$Volume2 { /** @@ -1000,22 +1008,22 @@ export namespace books_v1 { /** * Resource type. */ - kind?: string; - nextPageToken?: string; + kind?: string | null; + nextPageToken?: string | null; } export interface Schema$Volumeannotation { /** * The annotation data id for this volume annotation. */ - annotationDataId?: string; + annotationDataId?: string | null; /** * Link to get data for this annotation. */ - annotationDataLink?: string; + annotationDataLink?: string | null; /** * The type of annotation this is. */ - annotationType?: string; + annotationType?: string | null; /** * The content ranges to identify the selected text. */ @@ -1024,47 +1032,47 @@ export namespace books_v1 { contentVersion?: string; gbImageRange?: Schema$BooksAnnotationsRange; gbTextRange?: Schema$BooksAnnotationsRange; - }; + } | null; /** * Data for this annotation. */ - data?: string; + data?: string | null; /** * Indicates that this annotation is deleted. */ - deleted?: boolean; + deleted?: boolean | null; /** * Unique id of this volume annotation. */ - id?: string; + id?: string | null; /** * Resource Type */ - kind?: string; + kind?: string | null; /** * The Layer this annotation is for. */ - layerId?: string; + layerId?: string | null; /** * Pages the annotation spans. */ - pageIds?: string[]; + pageIds?: string[] | null; /** * Excerpt from the volume. */ - selectedText?: string; + selectedText?: string | null; /** * URL to this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). */ - updated?: string; + updated?: string | null; /** * The Volume this annotation is for. */ - volumeId?: string; + volumeId?: string | null; } export interface Schema$Volumeannotations { /** @@ -1074,19 +1082,19 @@ export namespace books_v1 { /** * Resource type */ - kind?: string; + kind?: string | null; /** * Token to pass in for pagination for the next page. This will not be present if this request does not have more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of volume annotations found. */ - totalItems?: number; + totalItems?: number | null; /** * The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book). */ - version?: string; + version?: string | null; } export interface Schema$Volumes { /** @@ -1096,31 +1104,31 @@ export namespace books_v1 { /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$Volumeseriesinfo { /** * The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. */ - bookDisplayNumber?: string; + bookDisplayNumber?: string | null; /** * Resource type. */ - kind?: string; + kind?: string | null; /** * Short book title in the context of the series. */ - shortSeriesBookTitle?: string; + shortSeriesBookTitle?: string | null; volumeSeries?: Array<{ issue?: Array<{issueDisplayNumber?: string; issueOrderNumber?: number}>; orderNumber?: number; seriesBookType?: string; seriesId?: string; - }>; + }> | null; } export class Resource$Bookshelves { diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 8142eebf52b..244b7d66320 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -119,7 +119,7 @@ export namespace calendar_v3 { /** * ETag of the collection. */ - etag?: string; + etag?: string | null; /** * List of rules on the access control list. */ @@ -127,37 +127,37 @@ export namespace calendar_v3 { /** * Type of the collection ("calendar#acl"). */ - kind?: string; + kind?: string | null; /** * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ - nextSyncToken?: string; + nextSyncToken?: string | null; } export interface Schema$AclRule { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Identifier of the ACL rule. */ - id?: string; + id?: string | null; /** * Type of the resource ("calendar#aclRule"). */ - kind?: string; + kind?: string | null; /** * The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. */ - role?: string; + role?: string | null; /** * The scope of the rule. */ - scope?: {type?: string; value?: string}; + scope?: {type?: string; value?: string} | null; } export interface Schema$Calendar { /** @@ -167,37 +167,37 @@ export namespace calendar_v3 { /** * Description of the calendar. Optional. */ - description?: string; + description?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Identifier of the calendar. To retrieve IDs call the calendarList.list() method. */ - id?: string; + id?: string | null; /** * Type of the resource ("calendar#calendar"). */ - kind?: string; + kind?: string | null; /** * Geographic location of the calendar as free-form text. Optional. */ - location?: string; + location?: string | null; /** * Title of the calendar. */ - summary?: string; + summary?: string | null; /** * The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. */ - timeZone?: string; + timeZone?: string | null; } export interface Schema$CalendarList { /** * ETag of the collection. */ - etag?: string; + etag?: string | null; /** * Calendars that are present on the user's calendar list. */ @@ -205,29 +205,29 @@ export namespace calendar_v3 { /** * Type of the collection ("calendar#calendarList"). */ - kind?: string; + kind?: string | null; /** * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ - nextSyncToken?: string; + nextSyncToken?: string | null; } export interface Schema$CalendarListEntry { /** * The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. */ - accessRole?: string; + accessRole?: string | null; /** * The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. */ - backgroundColor?: string; + backgroundColor?: string | null; /** * The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional. */ - colorId?: string; + colorId?: string | null; /** * Conferencing properties for this calendar, for example what types of conferences are allowed. */ @@ -239,145 +239,147 @@ export namespace calendar_v3 { /** * Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. */ - deleted?: boolean; + deleted?: boolean | null; /** * Description of the calendar. Optional. Read-only. */ - description?: string; + description?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. */ - foregroundColor?: string; + foregroundColor?: string | null; /** * Whether the calendar has been hidden from the list. Optional. The default is False. */ - hidden?: boolean; + hidden?: boolean | null; /** * Identifier of the calendar. */ - id?: string; + id?: string | null; /** * Type of the resource ("calendar#calendarListEntry"). */ - kind?: string; + kind?: string | null; /** * Geographic location of the calendar as free-form text. Optional. Read-only. */ - location?: string; + location?: string | null; /** * The notifications that the authenticated user is receiving for this calendar. */ - notificationSettings?: {notifications?: Schema$CalendarNotification[]}; + notificationSettings?: { + notifications?: Schema$CalendarNotification[]; + } | null; /** * Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. */ - primary?: boolean; + primary?: boolean | null; /** * Whether the calendar content shows up in the calendar UI. Optional. The default is False. */ - selected?: boolean; + selected?: boolean | null; /** * Title of the calendar. Read-only. */ - summary?: string; + summary?: string | null; /** * The summary that the authenticated user has set for this calendar. Optional. */ - summaryOverride?: string; + summaryOverride?: string | null; /** * The time zone of the calendar. Optional. Read-only. */ - timeZone?: string; + timeZone?: string | null; } export interface Schema$CalendarNotification { /** * The method used to deliver the notification. Possible values are: - "email" - Notifications are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information. Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers. Required when adding a notification. */ - method?: string; + method?: string | null; /** * The type of notification. Possible values are: - "eventCreation" - Notification sent when a new event is put on the calendar. - "eventChange" - Notification sent when an event is changed. - "eventCancellation" - Notification sent when an event is cancelled. - "eventResponse" - Notification sent when an attendee responds to the event invitation. - "agenda" - An agenda with the events of the day (sent out in the morning). Required when adding a notification. */ - type?: string; + type?: string | null; } export interface Schema$Channel { /** * The address where notifications are delivered for this channel. */ - address?: string; + address?: string | null; /** * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ - expiration?: string; + expiration?: string | null; /** * A UUID or similar unique string that identifies this channel. */ - id?: string; + id?: string | null; /** * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ - kind?: string; + kind?: string | null; /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: {[key: string]: string}; + params?: {[key: string]: string} | null; /** * A Boolean value to indicate whether payload is wanted. Optional. */ - payload?: boolean; + payload?: boolean | null; /** * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ - resourceId?: string; + resourceId?: string | null; /** * A version-specific identifier for the watched resource. */ - resourceUri?: string; + resourceUri?: string | null; /** * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ - token?: string; + token?: string | null; /** * The type of delivery mechanism used for this channel. */ - type?: string; + type?: string | null; } export interface Schema$ColorDefinition { /** * The background color associated with this color definition. */ - background?: string; + background?: string | null; /** * The foreground color that can be used to write on top of a background with 'background' color. */ - foreground?: string; + foreground?: string | null; } export interface Schema$Colors { /** * A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only. */ - calendar?: {[key: string]: Schema$ColorDefinition}; + calendar?: {[key: string]: Schema$ColorDefinition} | null; /** * A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only. */ - event?: {[key: string]: Schema$ColorDefinition}; + event?: {[key: string]: Schema$ColorDefinition} | null; /** * Type of the resource ("calendar#colors"). */ - kind?: string; + kind?: string | null; /** * Last modification time of the color palette (as a RFC3339 timestamp). Read-only. */ - updated?: string; + updated?: string | null; } export interface Schema$ConferenceData { /** * The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types: - "eventHangout": unset. - "eventNamedHangout": the name of the Hangout. - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". - "addOn": defined by 3P conference provider. Optional. */ - conferenceId?: string; + conferenceId?: string | null; /** * The conference solution, such as Hangouts or Hangouts Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required. */ @@ -393,7 +395,7 @@ export namespace calendar_v3 { /** * Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. */ - notes?: string; + notes?: string | null; /** * Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. */ @@ -401,7 +403,7 @@ export namespace calendar_v3 { /** * The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request. */ - signature?: string; + signature?: string | null; } export interface Schema$ConferenceParameters { /** @@ -410,25 +412,25 @@ export namespace calendar_v3 { addOnParameters?: Schema$ConferenceParametersAddOnParameters; } export interface Schema$ConferenceParametersAddOnParameters { - parameters?: {[key: string]: string}; + parameters?: {[key: string]: string} | null; } export interface Schema$ConferenceProperties { /** * The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional. */ - allowedConferenceSolutionTypes?: string[]; + allowedConferenceSolutionTypes?: string[] | null; } export interface Schema$ConferenceRequestStatus { /** * The current status of the conference create request. Read-only. The possible values are: - "pending": the conference create request is still being processed. - "success": the conference create request succeeded, the entry points are populated. - "failure": the conference create request failed, there are no entry points. */ - statusCode?: string; + statusCode?: string | null; } export interface Schema$ConferenceSolution { /** * The user-visible icon for this solution. */ - iconUri?: string; + iconUri?: string | null; /** * The key which can uniquely identify the conference solution for this event. */ @@ -436,13 +438,13 @@ export namespace calendar_v3 { /** * The user-visible name of this solution. Not localized. */ - name?: string; + name?: string | null; } export interface Schema$ConferenceSolutionKey { /** * The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) */ - type?: string; + type?: string | null; } export interface Schema$CreateConferenceRequest { /** @@ -452,7 +454,7 @@ export namespace calendar_v3 { /** * The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. */ - requestId?: string; + requestId?: string | null; /** * The status of the conference create request. */ @@ -462,59 +464,59 @@ export namespace calendar_v3 { /** * The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ - accessCode?: string; + accessCode?: string | null; /** * Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. */ - entryPointFeatures?: string[]; + entryPointFeatures?: string[] | null; /** * The type of the conference entry point. Possible values are: - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. */ - entryPointType?: string; + entryPointType?: string | null; /** * The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples: - for video: meet.google.com/aaa-bbbb-ccc - for phone: +1 123 268 2601 - for sip: 12345678@altostrat.com - for more: should not be filled Optional. */ - label?: string; + label?: string | null; /** * The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ - meetingCode?: string; + meetingCode?: string | null; /** * The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. */ - passcode?: string; + passcode?: string | null; /** * The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ - password?: string; + password?: string | null; /** * The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ - pin?: string; + pin?: string | null; /** * The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE. */ - regionCode?: string; + regionCode?: string | null; /** * The URI of the entry point. The maximum length is 1300 characters. Format: - for video, http: or https: schema is required. - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. - for more, http: or https: schema is required. */ - uri?: string; + uri?: string | null; } export interface Schema$Error { /** * Domain, or broad category, of the error. */ - domain?: string; + domain?: string | null; /** * Specific reason for the error. Some of the possible values are: - "groupTooBig" - The group of users requested is too large for a single query. - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query. - "notFound" - The requested resource was not found. - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list. */ - reason?: string; + reason?: string | null; } export interface Schema$Event { /** * Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. */ - anyoneCanAddSelf?: boolean; + anyoneCanAddSelf?: boolean | null; /** * File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, */ @@ -526,11 +528,11 @@ export namespace calendar_v3 { /** * Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. */ - attendeesOmitted?: boolean; + attendeesOmitted?: boolean | null; /** * The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. */ - colorId?: string; + colorId?: string | null; /** * The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. */ @@ -538,7 +540,7 @@ export namespace calendar_v3 { /** * Creation time of the event (as a RFC3339 timestamp). Read-only. */ - created?: string; + created?: string | null; /** * The creator of the event. Read-only. */ @@ -547,11 +549,11 @@ export namespace calendar_v3 { email?: string; id?: string; self?: boolean; - }; + } | null; /** * Description of the event. Optional. */ - description?: string; + description?: string | null; /** * The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. */ @@ -559,18 +561,18 @@ export namespace calendar_v3 { /** * Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. */ - endTimeUnspecified?: boolean; + endTimeUnspecified?: boolean | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Extended properties of the event. */ extendedProperties?: { private?: {[key: string]: string}; shared?: {[key: string]: string}; - }; + } | null; /** * A gadget that extends this event. */ @@ -583,47 +585,47 @@ export namespace calendar_v3 { title?: string; type?: string; width?: number; - }; + } | null; /** * Whether attendees other than the organizer can invite others to the event. Optional. The default is True. */ - guestsCanInviteOthers?: boolean; + guestsCanInviteOthers?: boolean | null; /** * Whether attendees other than the organizer can modify the event. Optional. The default is False. */ - guestsCanModify?: boolean; + guestsCanModify?: boolean | null; /** * Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. */ - guestsCanSeeOtherGuests?: boolean; + guestsCanSeeOtherGuests?: boolean | null; /** * An absolute link to the Google+ hangout associated with this event. Read-only. */ - hangoutLink?: string; + hangoutLink?: string | null; /** * An absolute link to this event in the Google Calendar Web UI. Read-only. */ - htmlLink?: string; + htmlLink?: string | null; /** * Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. */ - iCalUID?: string; + iCalUID?: string | null; /** * Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. */ - id?: string; + id?: string | null; /** * Type of the resource ("calendar#event"). */ - kind?: string; + kind?: string | null; /** * Geographic location of the event as free-form text. Optional. */ - location?: string; + location?: string | null; /** * Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. */ - locked?: boolean; + locked?: boolean | null; /** * The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. */ @@ -632,35 +634,38 @@ export namespace calendar_v3 { email?: string; id?: string; self?: boolean; - }; + } | null; /** * For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. */ originalStartTime?: Schema$EventDateTime; /** - * Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. + * If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. */ - privateCopy?: boolean; + privateCopy?: boolean | null; /** * List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. */ - recurrence?: string[]; + recurrence?: string[] | null; /** * For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. */ - recurringEventId?: string; + recurringEventId?: string | null; /** * Information about the event's reminders for the authenticated user. */ - reminders?: {overrides?: Schema$EventReminder[]; useDefault?: boolean}; + reminders?: { + overrides?: Schema$EventReminder[]; + useDefault?: boolean; + } | null; /** * Sequence number as per iCalendar. */ - sequence?: number; + sequence?: number | null; /** * Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. */ - source?: {title?: string; url?: string}; + source?: {title?: string; url?: string} | null; /** * The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. */ @@ -668,117 +673,117 @@ export namespace calendar_v3 { /** * Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. */ - status?: string; + status?: string | null; /** * Title of the event. */ - summary?: string; + summary?: string | null; /** * Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. */ - transparency?: string; + transparency?: string | null; /** * Last modification time of the event (as a RFC3339 timestamp). Read-only. */ - updated?: string; + updated?: string | null; /** * Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons. */ - visibility?: string; + visibility?: string | null; } export interface Schema$EventAttachment { /** * ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. */ - fileId?: string; + fileId?: string | null; /** * URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment. */ - fileUrl?: string; + fileUrl?: string | null; /** * URL link to the attachment's icon. Read-only. */ - iconLink?: string; + iconLink?: string | null; /** * Internet media type (MIME type) of the attachment. */ - mimeType?: string; + mimeType?: string | null; /** * Attachment title. */ - title?: string; + title?: string | null; } export interface Schema$EventAttendee { /** * Number of additional guests. Optional. The default is 0. */ - additionalGuests?: number; + additionalGuests?: number | null; /** * The attendee's response comment. Optional. */ - comment?: string; + comment?: string | null; /** * The attendee's name, if available. Optional. */ - displayName?: string; + displayName?: string | null; /** * The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee. */ - email?: string; + email?: string | null; /** * The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API */ - id?: string; + id?: string | null; /** * Whether this is an optional attendee. Optional. The default is False. */ - optional?: boolean; + optional?: boolean | null; /** * Whether the attendee is the organizer of the event. Read-only. The default is False. */ - organizer?: boolean; + organizer?: boolean | null; /** * Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. */ - resource?: boolean; + resource?: boolean | null; /** * The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation. - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation. */ - responseStatus?: string; + responseStatus?: string | null; /** * Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. */ - self?: boolean; + self?: boolean | null; } export interface Schema$EventDateTime { /** * The date, in the format "yyyy-mm-dd", if this is an all-day event. */ - date?: string; + date?: string | null; /** * The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. */ - dateTime?: string; + dateTime?: string | null; /** * The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. */ - timeZone?: string; + timeZone?: string | null; } export interface Schema$EventReminder { /** * The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder. */ - method?: string; + method?: string | null; /** * Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder. */ - minutes?: number; + minutes?: number | null; } export interface Schema$Events { /** * The user's access role for this calendar. Read-only. Possible values are: - "none" - The user has no access. - "freeBusyReader" - The user has read access to free/busy information. - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. */ - accessRole?: string; + accessRole?: string | null; /** * The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). */ @@ -786,11 +791,11 @@ export namespace calendar_v3 { /** * Description of the calendar. Read-only. */ - description?: string; + description?: string | null; /** * ETag of the collection. */ - etag?: string; + etag?: string | null; /** * List of events on the calendar. */ @@ -798,27 +803,27 @@ export namespace calendar_v3 { /** * Type of the collection ("calendar#events"). */ - kind?: string; + kind?: string | null; /** * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ - nextSyncToken?: string; + nextSyncToken?: string | null; /** * Title of the calendar. Read-only. */ - summary?: string; + summary?: string | null; /** * The time zone of the calendar. Read-only. */ - timeZone?: string; + timeZone?: string | null; /** * Last modification time of the calendar (as a RFC3339 timestamp). Read-only. */ - updated?: string; + updated?: string | null; } export interface Schema$FreeBusyCalendar { /** @@ -834,7 +839,7 @@ export namespace calendar_v3 { /** * List of calendars' identifiers within a group. */ - calendars?: string[]; + calendars?: string[] | null; /** * Optional error(s) (if computation for the group failed). */ @@ -844,11 +849,11 @@ export namespace calendar_v3 { /** * Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50. */ - calendarExpansionMax?: number; + calendarExpansionMax?: number | null; /** * Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100. */ - groupExpansionMax?: number; + groupExpansionMax?: number | null; /** * List of calendars and/or groups to query. */ @@ -856,67 +861,67 @@ export namespace calendar_v3 { /** * The end of the interval for the query formatted as per RFC3339. */ - timeMax?: string; + timeMax?: string | null; /** * The start of the interval for the query formatted as per RFC3339. */ - timeMin?: string; + timeMin?: string | null; /** * Time zone used in the response. Optional. The default is UTC. */ - timeZone?: string; + timeZone?: string | null; } export interface Schema$FreeBusyRequestItem { /** * The identifier of a calendar or a group. */ - id?: string; + id?: string | null; } export interface Schema$FreeBusyResponse { /** * List of free/busy information for calendars. */ - calendars?: {[key: string]: Schema$FreeBusyCalendar}; + calendars?: {[key: string]: Schema$FreeBusyCalendar} | null; /** * Expansion of groups. */ - groups?: {[key: string]: Schema$FreeBusyGroup}; + groups?: {[key: string]: Schema$FreeBusyGroup} | null; /** * Type of the resource ("calendar#freeBusy"). */ - kind?: string; + kind?: string | null; /** * The end of the interval. */ - timeMax?: string; + timeMax?: string | null; /** * The start of the interval. */ - timeMin?: string; + timeMin?: string | null; } export interface Schema$Setting { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The id of the user setting. */ - id?: string; + id?: string | null; /** * Type of the resource ("calendar#setting"). */ - kind?: string; + kind?: string | null; /** * Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters. */ - value?: string; + value?: string | null; } export interface Schema$Settings { /** * Etag of the collection. */ - etag?: string; + etag?: string | null; /** * List of user settings. */ @@ -924,25 +929,25 @@ export namespace calendar_v3 { /** * Type of the collection ("calendar#settings"). */ - kind?: string; + kind?: string | null; /** * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ - nextSyncToken?: string; + nextSyncToken?: string | null; } export interface Schema$TimePeriod { /** * The (exclusive) end of the time period. */ - end?: string; + end?: string | null; /** * The (inclusive) start of the time period. */ - start?: string; + start?: string | null; } export class Resource$Acl { diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index ac5ae137155..e0e19bd3b55 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -124,11 +124,11 @@ export namespace chat_v1 { /** * The name of the parameter for the action script. */ - key?: string; + key?: string | null; /** * The value of the parameter. */ - value?: string; + value?: string | null; } /** * Parameters that a bot can use to configure how it's response is posted. @@ -137,11 +137,11 @@ export namespace chat_v1 { /** * The type of bot response. */ - type?: string; + type?: string | null; /** * URL for users to auth or config. (Only for REQUEST_CONFIG response types.) */ - url?: string; + url?: string | null; } /** * Annotations associated with the plain-text body of the message. Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/107946847022116401880", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` @@ -150,15 +150,15 @@ export namespace chat_v1 { /** * Length of the substring in the plain-text message body this annotation corresponds to. */ - length?: number; + length?: number | null; /** * Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to. */ - startIndex?: number; + startIndex?: number | null; /** * The type of this annotation. */ - type?: string; + type?: string | null; /** * The metadata of user mention. */ @@ -192,7 +192,7 @@ export namespace chat_v1 { /** * Name of the card. */ - name?: string; + name?: string | null; /** * Sections are separated by a line divider. */ @@ -205,7 +205,7 @@ export namespace chat_v1 { /** * The label used to be displayed in the action menu item. */ - actionLabel?: string; + actionLabel?: string | null; /** * The onclick action for this action item. */ @@ -215,19 +215,19 @@ export namespace chat_v1 { /** * The image's type (e.g. square border or circular border). */ - imageStyle?: string; + imageStyle?: string | null; /** * The URL of the image in the card header. */ - imageUrl?: string; + imageUrl?: string | null; /** * The subtitle of the card header. */ - subtitle?: string; + subtitle?: string | null; /** * The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each will take up 1 line. If only the title is specified, it will take up both lines. */ - title?: string; + title?: string | null; } /** * Hangouts Chat events. @@ -240,11 +240,11 @@ export namespace chat_v1 { /** * The URL the bot should redirect the user to after they have completed an authorization or configuration flow outside of Hangouts Chat. See the [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p) for more information. */ - configCompleteRedirectUrl?: string; + configCompleteRedirectUrl?: string | null; /** * The timestamp indicating when the event was dispatched. */ - eventTime?: string; + eventTime?: string | null; /** * The message that triggered the event, if applicable. */ @@ -256,15 +256,15 @@ export namespace chat_v1 { /** * The bot-defined key for the thread related to the event. See the thread_key field of the `spaces.message.create` request for more information. */ - threadKey?: string; + threadKey?: string | null; /** * A secret value that bots can use to verify if a request is from Google. The token is randomly generated by Google, remains static, and can be obtained from the Hangouts Chat API configuration page in the Cloud Console. Developers can revoke/regenerate it if needed from the same page. */ - token?: string; + token?: string | null; /** * The type of the event. */ - type?: string; + type?: string | null; /** * The user that triggered the event. */ @@ -281,7 +281,7 @@ export namespace chat_v1 { /** * Apps Script function to invoke when the containing element is clicked/activated. */ - actionMethodName?: string; + actionMethodName?: string | null; /** * List of action parameters. */ @@ -294,11 +294,11 @@ export namespace chat_v1 { /** * The aspect ratio of this image (width/height). */ - aspectRatio?: number; + aspectRatio?: number | null; /** * The URL of the image. */ - imageUrl?: string; + imageUrl?: string | null; /** * The onclick action. */ @@ -311,15 +311,15 @@ export namespace chat_v1 { /** * The icon specified by an enum that indices to an icon provided by Chat API. */ - icon?: string; + icon?: string | null; /** * The icon specified by a URL. */ - iconUrl?: string; + iconUrl?: string | null; /** * The name of this image_button which will be used for accessibility. Default value will be provided if developers don't specify. */ - name?: string; + name?: string | null; /** * The onclick action. */ @@ -332,7 +332,7 @@ export namespace chat_v1 { /** * The text of the bottom label. Formatted text supported. */ - bottomLabel?: string; + bottomLabel?: string | null; /** * A button that can be clicked to trigger an action. */ @@ -340,19 +340,19 @@ export namespace chat_v1 { /** * The text of the content. Formatted text supported and always required. */ - content?: string; + content?: string | null; /** * If the content should be multiline. */ - contentMultiline?: boolean; + contentMultiline?: boolean | null; /** * An enum value that will be replaced by the Chat API with the corresponding icon image. */ - icon?: string; + icon?: string | null; /** * The icon specified by a URL. */ - iconUrl?: string; + iconUrl?: string | null; /** * The onclick action. Only the top label, bottom label and content region are clickable. */ @@ -360,7 +360,7 @@ export namespace chat_v1 { /** * The text of the top label. Formatted text supported. */ - topLabel?: string; + topLabel?: string | null; } export interface Schema$ListMembershipsResponse { /** @@ -370,13 +370,13 @@ export namespace chat_v1 { /** * Continuation token to retrieve the next page of results. It will be empty for the last page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListSpacesResponse { /** * Continuation token to retrieve the next page of results. It will be empty for the last page of results. Tokens expire in an hour. An error is thrown if an expired token is passed. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of spaces in the requested (or first) page. */ @@ -389,7 +389,7 @@ export namespace chat_v1 { /** * The creation time of the membership a.k.a the time at which the member joined the space, if applicable. */ - createTime?: string; + createTime?: string | null; /** * Member details. */ @@ -397,11 +397,11 @@ export namespace chat_v1 { /** * Resource name of the membership, in the form "spaces/x/members/*". Example: spaces/AAAAMpdlehY/members/105115627578887013105 */ - name?: string; + name?: string | null; /** * State of the membership. */ - state?: string; + state?: string | null; } /** * A message in Hangouts Chat. @@ -418,7 +418,7 @@ export namespace chat_v1 { /** * Plain-text body of the message with all bot mentions stripped out. */ - argumentText?: string; + argumentText?: string | null; /** * Rich, formatted and interactive cards that can be used to display UI elements such as: formatted texts, buttons, clickable images. Cards are normally displayed below the plain-text body of the message. */ @@ -426,19 +426,19 @@ export namespace chat_v1 { /** * Output only. The time at which the message was created in Hangouts Chat server. */ - createTime?: string; + createTime?: string | null; /** * A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). */ - fallbackText?: string; + fallbackText?: string | null; /** * Resource name, in the form "spaces/x/messages/*". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 */ - name?: string; + name?: string | null; /** * Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. */ - previewText?: string; + previewText?: string | null; /** * The user who created the message. */ @@ -450,7 +450,7 @@ export namespace chat_v1 { /** * Plain-text body of the message. */ - text?: string; + text?: string | null; /** * The thread the message belongs to. */ @@ -476,7 +476,7 @@ export namespace chat_v1 { /** * The URL to open. */ - url?: string; + url?: string | null; } /** * A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there is currently no need for layout properties (e.g. float). @@ -485,7 +485,7 @@ export namespace chat_v1 { /** * The header of the section, text formatted supported. */ - header?: string; + header?: string | null; /** * A section must contain at least 1 widget. */ @@ -498,15 +498,15 @@ export namespace chat_v1 { /** * Output only. The display name (only if the space is a room). */ - displayName?: string; + displayName?: string | null; /** * Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs */ - name?: string; + name?: string | null; /** * Output only. The type of a space. */ - type?: string; + type?: string | null; } /** * A button with text and onclick action. @@ -519,13 +519,13 @@ export namespace chat_v1 { /** * The text of the button. */ - text?: string; + text?: string | null; } /** * A paragraph of text. Formatted text supported. */ export interface Schema$TextParagraph { - text?: string; + text?: string | null; } /** * A thread in Hangouts Chat. @@ -534,7 +534,7 @@ export namespace chat_v1 { /** * Resource name, in the form "spaces/x/threads/*". Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4 */ - name?: string; + name?: string | null; } /** * A user in Hangouts Chat. @@ -543,15 +543,15 @@ export namespace chat_v1 { /** * The user's display name. */ - displayName?: string; + displayName?: string | null; /** * Resource name, in the format "users/*". */ - name?: string; + name?: string | null; /** * User type. */ - type?: string; + type?: string | null; } /** * Annotation metadata for user mentions (@). @@ -560,7 +560,7 @@ export namespace chat_v1 { /** * The type of user mention. */ - type?: string; + type?: string | null; /** * The user mentioned. */ diff --git a/src/apis/civicinfo/v2.ts b/src/apis/civicinfo/v2.ts index 5c0ea2bab81..aa783316b5f 100644 --- a/src/apis/civicinfo/v2.ts +++ b/src/apis/civicinfo/v2.ts @@ -116,7 +116,7 @@ export namespace civicinfo_v2 { /** * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page. */ - id?: string; + id?: string | null; /** * The city or county that provides election information for this voter. This object can have the same elements as state. */ @@ -124,7 +124,7 @@ export namespace civicinfo_v2 { /** * The name of the jurisdiction. */ - name?: string; + name?: string | null; /** * A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources. */ @@ -137,12 +137,12 @@ export namespace civicinfo_v2 { /** * A URL provided by this administrative body for information on absentee voting. */ - absenteeVotingInfoUrl?: string; - addressLines?: string[]; + absenteeVotingInfoUrl?: string | null; + addressLines?: string[] | null; /** * A URL provided by this administrative body to give contest information to the voter. */ - ballotInfoUrl?: string; + ballotInfoUrl?: string | null; /** * The mailing address of this administrative body. */ @@ -150,7 +150,7 @@ export namespace civicinfo_v2 { /** * A URL provided by this administrative body for looking up general election information. */ - electionInfoUrl?: string; + electionInfoUrl?: string | null; /** * The election officials for this election administrative body. */ @@ -158,23 +158,23 @@ export namespace civicinfo_v2 { /** * A URL provided by this administrative body for confirming that the voter is registered to vote. */ - electionRegistrationConfirmationUrl?: string; + electionRegistrationConfirmationUrl?: string | null; /** * A URL provided by this administrative body for looking up how to register to vote. */ - electionRegistrationUrl?: string; + electionRegistrationUrl?: string | null; /** * A URL provided by this administrative body describing election rules to the voter. */ - electionRulesUrl?: string; + electionRulesUrl?: string | null; /** * A description of the hours of operation for this administrative body. */ - hoursOfOperation?: string; + hoursOfOperation?: string | null; /** * The name of this election administrative body. */ - name?: string; + name?: string | null; /** * The physical address of this administrative body. */ @@ -182,11 +182,11 @@ export namespace civicinfo_v2 { /** * A description of the services this administrative body may provide. */ - voter_services?: string[]; + voter_services?: string[] | null; /** * A URL provided by this administrative body for looking up where to vote. */ - votingLocationFinderUrl?: string; + votingLocationFinderUrl?: string | null; } /** * Information about a candidate running for elected office. @@ -195,7 +195,7 @@ export namespace civicinfo_v2 { /** * The URL for the candidate's campaign web site. */ - candidateUrl?: string; + candidateUrl?: string | null; /** * A list of known (social) media channels for this candidate. */ @@ -203,27 +203,27 @@ export namespace civicinfo_v2 { /** * The email address for the candidate's campaign. */ - email?: string; + email?: string | null; /** * The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan" */ - name?: string; + name?: string | null; /** * The order the candidate appears on the ballot for this contest. */ - orderOnBallot?: string; + orderOnBallot?: string | null; /** * The full name of the party the candidate is a member of. */ - party?: string; + party?: string | null; /** * The voice phone number for the candidate's campaign office. */ - phone?: string; + phone?: string | null; /** * A URL for a photo of the candidate. */ - photoUrl?: string; + photoUrl?: string | null; } /** * A social media or web channel for a candidate. @@ -232,11 +232,11 @@ export namespace civicinfo_v2 { /** * The unique public identifier for the candidate's channel. */ - id?: string; + id?: string | null; /** * The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter */ - type?: string; + type?: string | null; } /** * Information about a contest that appears on a voter's ballot. @@ -245,11 +245,11 @@ export namespace civicinfo_v2 { /** * A number specifying the position of this contest on the voter's ballot. */ - ballotPlacement?: string; + ballotPlacement?: string | null; /** * The official title on the ballot for this contest, only where available. */ - ballotTitle?: string; + ballotTitle?: string | null; /** * The candidate choices for this contest. */ @@ -261,75 +261,75 @@ export namespace civicinfo_v2 { /** * A description of any additional eligibility requirements for voting in this contest. */ - electorateSpecifications?: string; + electorateSpecifications?: string | null; /** * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page. */ - id?: string; + id?: string | null; /** * The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1". */ - level?: string[]; + level?: string[] | null; /** * The number of candidates that will be elected to office in this contest. */ - numberElected?: string; + numberElected?: string | null; /** * The number of candidates that a voter may vote for in this contest. */ - numberVotingFor?: string; + numberVotingFor?: string | null; /** * The name of the office for this contest. */ - office?: string; + office?: string | null; /** * If this is a partisan election, the name of the party it is for. */ - primaryParty?: string; + primaryParty?: string | null; /** * The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'. */ - referendumBallotResponses?: string[]; + referendumBallotResponses?: string[] | null; /** * Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'. */ - referendumBrief?: string; + referendumBrief?: string | null; /** * A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'. */ - referendumConStatement?: string; + referendumConStatement?: string | null; /** * Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'. */ - referendumEffectOfAbstain?: string; + referendumEffectOfAbstain?: string | null; /** * The threshold of votes that the referendum needs in order to pass, e.g. "two-thirds". This field is only populated for contests of type 'Referendum'. */ - referendumPassageThreshold?: string; + referendumPassageThreshold?: string | null; /** * A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'. */ - referendumProStatement?: string; + referendumProStatement?: string | null; /** * A brief description of the referendum. This field is only populated for contests of type 'Referendum'. */ - referendumSubtitle?: string; + referendumSubtitle?: string | null; /** * The full text of the referendum. This field is only populated for contests of type 'Referendum'. */ - referendumText?: string; + referendumText?: string | null; /** * The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'. */ - referendumTitle?: string; + referendumTitle?: string | null; /** * A link to the referendum. This field is only populated for contests of type 'Referendum'. */ - referendumUrl?: string; + referendumUrl?: string | null; /** * The roles which this office fulfills. */ - roles?: string[]; + roles?: string[] | null; /** * A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources. */ @@ -337,14 +337,14 @@ export namespace civicinfo_v2 { /** * "Yes" or "No" depending on whether this a contest being held outside the normal election cycle. */ - special?: string; + special?: string | null; /** * The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'. For Retention contests this will typically be 'Retention'. */ - type?: string; + type?: string | null; } export interface Schema$ContextParams { - clientProfile?: string; + clientProfile?: string | null; } /** * A request to look up representative information for a single division. @@ -365,7 +365,7 @@ export namespace civicinfo_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse". */ - kind?: string; + kind?: string | null; results?: Schema$DivisionSearchResult[]; } /** @@ -375,15 +375,15 @@ export namespace civicinfo_v2 { /** * Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district. */ - aliases?: string[]; + aliases?: string[] | null; /** * The name of the division. */ - name?: string; + name?: string | null; /** * The unique Open Civic Data identifier for this division. */ - ocdId?: string; + ocdId?: string | null; } /** * Information about the election that was queried. @@ -392,19 +392,19 @@ export namespace civicinfo_v2 { /** * Day of the election in YYYY-MM-DD format. */ - electionDay?: string; + electionDay?: string | null; /** * The unique ID of this election. */ - id?: string; + id?: string | null; /** * A displayable name for the election. */ - name?: string; + name?: string | null; /** * The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us). */ - ocdDivisionId?: string; + ocdDivisionId?: string | null; } /** * Information about individual election officials. @@ -413,23 +413,23 @@ export namespace civicinfo_v2 { /** * The email address of the election official. */ - emailAddress?: string; + emailAddress?: string | null; /** * The fax number of the election official. */ - faxNumber?: string; + faxNumber?: string | null; /** * The full name of the election official. */ - name?: string; + name?: string | null; /** * The office phone number of the election official. */ - officePhoneNumber?: string; + officePhoneNumber?: string | null; /** * The title of the election official. */ - title?: string; + title?: string | null; } export interface Schema$ElectionsQueryRequest { contextParams?: Schema$ContextParams; @@ -445,7 +445,7 @@ export namespace civicinfo_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse". */ - kind?: string; + kind?: string | null; } /** * Describes the geographic scope of a contest. @@ -454,16 +454,16 @@ export namespace civicinfo_v2 { /** * An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper. */ - id?: string; - kgForeignKey?: string; + id?: string | null; + kgForeignKey?: string | null; /** * The name of the district. */ - name?: string; + name?: string | null; /** * The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special */ - scope?: string; + scope?: string | null; } export interface Schema$FieldMetadataProto { internal?: Schema$InternalFieldMetadataProto; @@ -475,44 +475,44 @@ export namespace civicinfo_v2 { /** * Any other valid OCD IDs that refer to the same division. Because OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list. For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc. */ - alsoKnownAs?: string[]; + alsoKnownAs?: string[] | null; /** * The name of the division. */ - name?: string; + name?: string | null; /** * List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request. */ - officeIndices?: number[]; + officeIndices?: number[] | null; } export interface Schema$InternalFieldMetadataProto { - isAuto?: boolean; + isAuto?: boolean | null; sourceSummary?: Schema$InternalSourceSummaryProto; } export interface Schema$InternalSourceSummaryProto { - dataset?: string; - provider?: string; + dataset?: string | null; + provider?: string | null; } export interface Schema$LivegraphBacktraceRecordInfo { - dataSourcePublishMsec?: string; - expId?: string; + dataSourcePublishMsec?: string | null; + expId?: string | null; expInfo?: Schema$LivegraphBacktraceRecordInfoExpInfo; - isRecon?: boolean; - isWlmThrottled?: boolean; - numberOfTriples?: string; - priority?: string; - process?: string; - proxyReceiveMsec?: string; - proxySentMsec?: string; - recordId?: string; - shouldMonitorLatency?: boolean; - subscriberReceiveMsec?: string; - topicBuildFinishMsec?: string; - topicBuildStartMsec?: string; - version?: string; + isRecon?: boolean | null; + isWlmThrottled?: boolean | null; + numberOfTriples?: string | null; + priority?: string | null; + process?: string | null; + proxyReceiveMsec?: string | null; + proxySentMsec?: string | null; + recordId?: string | null; + shouldMonitorLatency?: boolean | null; + subscriberReceiveMsec?: string | null; + topicBuildFinishMsec?: string | null; + topicBuildStartMsec?: string | null; + version?: string | null; } export interface Schema$LivegraphBacktraceRecordInfoExpInfo { - deletedIns?: string[]; + deletedIns?: string[] | null; } export interface Schema$MessageSet { recordMessageSetExt?: Schema$LivegraphBacktraceRecordInfo; @@ -524,23 +524,23 @@ export namespace civicinfo_v2 { /** * The OCD ID of the division with which this office is associated. */ - divisionId?: string; + divisionId?: string | null; /** * The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1". */ - levels?: string[]; + levels?: string[] | null; /** * The human-readable name of the office. */ - name?: string; + name?: string | null; /** * List of indices in the officials array of people who presently hold this office. */ - officialIndices?: number[]; + officialIndices?: number[] | null; /** * The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices. */ - roles?: string[]; + roles?: string[] | null; /** * A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources. */ @@ -561,31 +561,31 @@ export namespace civicinfo_v2 { /** * The direct email addresses for the official. */ - emails?: string[]; + emails?: string[] | null; /** * The official's name. */ - name?: string; + name?: string | null; /** * The full name of the party the official belongs to. */ - party?: string; + party?: string | null; /** * The official's public contact phone numbers. */ - phones?: string[]; + phones?: string[] | null; /** * A URL for a photo of the official. */ - photoUrl?: string; + photoUrl?: string | null; /** * The official's public website URLs. */ - urls?: string[]; + urls?: string[] | null; } export interface Schema$PointProto { - latE7?: number; - lngE7?: number; + latE7?: number | null; + lngE7?: number | null; metadata?: Schema$FieldMetadataProto; temporaryData?: Schema$MessageSet; } @@ -600,31 +600,31 @@ export namespace civicinfo_v2 { /** * The last date that this early vote site or drop off location may be used. This field is not populated for polling locations. */ - endDate?: string; + endDate?: string | null; /** * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page. */ - id?: string; + id?: string | null; /** * Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point. */ - latitude?: number; + latitude?: number | null; /** * Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point. */ - longitude?: number; + longitude?: number | null; /** * The name of the early vote site or drop off location. This field is not populated for polling locations. */ - name?: string; + name?: string | null; /** * Notes about this location (e.g. accessibility ramp or entrance to use). */ - notes?: string; + notes?: string | null; /** * A description of when this location is open. */ - pollingHours?: string; + pollingHours?: string | null; /** * A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources. */ @@ -632,51 +632,51 @@ export namespace civicinfo_v2 { /** * The first date that this early vote site or drop off location may be used. This field is not populated for polling locations. */ - startDate?: string; + startDate?: string | null; /** * The services provided by this early vote site or drop off location. This field is not populated for polling locations. */ - voterServices?: string; + voterServices?: string | null; } export interface Schema$PostalAddress { - addressLines?: string[]; - administrativeAreaName?: string; - countryName?: string; - countryNameCode?: string; - dependentLocalityName?: string; - dependentThoroughfareName?: string; - firmName?: string; - isDisputed?: boolean; - languageCode?: string; - localityName?: string; - postalCodeNumber?: string; - postalCodeNumberExtension?: string; - postBoxNumber?: string; - premiseName?: string; - recipientName?: string; - sortingCode?: string; - subAdministrativeAreaName?: string; - subPremiseName?: string; - thoroughfareName?: string; - thoroughfareNumber?: string; + addressLines?: string[] | null; + administrativeAreaName?: string | null; + countryName?: string | null; + countryNameCode?: string | null; + dependentLocalityName?: string | null; + dependentThoroughfareName?: string | null; + firmName?: string | null; + isDisputed?: boolean | null; + languageCode?: string | null; + localityName?: string | null; + postalCodeNumber?: string | null; + postalCodeNumberExtension?: string | null; + postBoxNumber?: string | null; + premiseName?: string | null; + recipientName?: string | null; + sortingCode?: string | null; + subAdministrativeAreaName?: string | null; + subPremiseName?: string | null; + thoroughfareName?: string | null; + thoroughfareNumber?: string | null; } export interface Schema$Provenance { collidedSegmentSource?: Schema$StreetSegmentList; - ctclContestUuid?: string; - ctclOfficeUuid?: string; - datasetId?: string; - precinctId?: string; - precinctSplitId?: string; - tsStreetSegmentId?: string; - vip5PrecinctId?: string; - vip5StreetSegmentId?: string; - vipStreetSegmentId?: string; + ctclContestUuid?: string | null; + ctclOfficeUuid?: string | null; + datasetId?: string | null; + precinctId?: string | null; + precinctSplitId?: string | null; + tsStreetSegmentId?: string | null; + vip5PrecinctId?: string | null; + vip5StreetSegmentId?: string | null; + vipStreetSegmentId?: string | null; } export interface Schema$RepresentativeInfoData { /** * Political geographic divisions that contain the requested address. */ - divisions?: {[key: string]: Schema$GeographicDivision}; + divisions?: {[key: string]: Schema$GeographicDivision} | null; /** * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request. */ @@ -699,11 +699,11 @@ export namespace civicinfo_v2 { /** * Political geographic divisions that contain the requested address. */ - divisions?: {[key: string]: Schema$GeographicDivision}; + divisions?: {[key: string]: Schema$GeographicDivision} | null; /** * Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse". */ - kind?: string; + kind?: string | null; /** * The normalized version of the requested address */ @@ -724,31 +724,31 @@ export namespace civicinfo_v2 { /** * The city or town for the address. */ - city?: string; + city?: string | null; /** * The street name and number of this address. */ - line1?: string; + line1?: string | null; /** * The second line the address, if needed. */ - line2?: string; + line2?: string | null; /** * The third line of the address, if needed. */ - line3?: string; + line3?: string | null; /** * The name of the location. */ - locationName?: string; + locationName?: string | null; /** * The US two letter state abbreviation of the address. */ - state?: string; + state?: string | null; /** * The US Postal Zip Code of the address. */ - zip?: string; + zip?: string | null; } /** * Contains information about the data source for the element containing it. @@ -757,58 +757,58 @@ export namespace civicinfo_v2 { /** * The name of the data source. */ - name?: string; + name?: string | null; /** * Whether this data comes from an official government source. */ - official?: boolean; + official?: boolean | null; } export interface Schema$StreetSegment { - administrationRegionIds?: string[]; - beforeGeocodeId?: string; - catalistUniquePrecinctCode?: string; - city?: string; - cityCouncilDistrict?: string; - congressionalDistrict?: string; - contestIds?: string[]; - countyCouncilDistrict?: string; - countyFips?: string; - datasetId?: string; - earlyVoteSiteByIds?: string[]; - endHouseNumber?: string; + administrationRegionIds?: string[] | null; + beforeGeocodeId?: string | null; + catalistUniquePrecinctCode?: string | null; + city?: string | null; + cityCouncilDistrict?: string | null; + congressionalDistrict?: string | null; + contestIds?: string[] | null; + countyCouncilDistrict?: string | null; + countyFips?: string | null; + datasetId?: string | null; + earlyVoteSiteByIds?: string[] | null; + endHouseNumber?: string | null; geocodedPoint?: Schema$PointProto; - geographicDivisionOcdIds?: string[]; - id?: string; - judicialDistrict?: string; - mailOnly?: boolean; - municipalDistrict?: string; - ncoaAddress?: string; - oddOrEvens?: string[]; - originalId?: string; - pollinglocationByIds?: string[]; - precinctName?: string; - precinctOcdId?: string; + geographicDivisionOcdIds?: string[] | null; + id?: string | null; + judicialDistrict?: string | null; + mailOnly?: boolean | null; + municipalDistrict?: string | null; + ncoaAddress?: string | null; + oddOrEvens?: string[] | null; + originalId?: string | null; + pollinglocationByIds?: string[] | null; + precinctName?: string | null; + precinctOcdId?: string | null; provenances?: Schema$Provenance[]; - published?: boolean; - schoolDistrict?: string; - startHouseNumber?: string; - startLatE7?: string; - startLngE7?: string; - state?: string; - stateHouseDistrict?: string; - stateSenateDistrict?: string; - streetName?: string; - subAdministrativeAreaName?: string; - surrogateId?: string; - targetsmartUniquePrecinctCode?: string; - townshipDistrict?: string; - unitNumber?: string; - unitType?: string; - vanPrecinctCode?: string; - voterGeographicDivisionOcdIds?: string[]; - wardDistrict?: string; - wildcard?: boolean; - zip?: string; + published?: boolean | null; + schoolDistrict?: string | null; + startHouseNumber?: string | null; + startLatE7?: string | null; + startLngE7?: string | null; + state?: string | null; + stateHouseDistrict?: string | null; + stateSenateDistrict?: string | null; + streetName?: string | null; + subAdministrativeAreaName?: string | null; + surrogateId?: string | null; + targetsmartUniquePrecinctCode?: string | null; + townshipDistrict?: string | null; + unitNumber?: string | null; + unitType?: string | null; + vanPrecinctCode?: string | null; + voterGeographicDivisionOcdIds?: string[] | null; + wardDistrict?: string | null; + wildcard?: boolean | null; + zip?: string | null; } export interface Schema$StreetSegmentList { segments?: Schema$StreetSegment[]; @@ -843,11 +843,11 @@ export namespace civicinfo_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse". */ - kind?: string; + kind?: string | null; /** * Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well). */ - mailOnly?: boolean; + mailOnly?: boolean | null; /** * The normalized version of the requested address */ @@ -860,7 +860,7 @@ export namespace civicinfo_v2 { * Locations where the voter is eligible to vote on election day. */ pollingLocations?: Schema$PollingLocation[]; - precinctId?: string; + precinctId?: string | null; segments?: Schema$StreetSegment[]; /** * Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array. @@ -868,7 +868,7 @@ export namespace civicinfo_v2 { state?: Schema$AdministrationRegion[]; } export interface Schema$VoterInfoSegmentResult { - generatedMillis?: string; + generatedMillis?: string | null; postalAddress?: Schema$PostalAddress; request?: Schema$VoterInfoRequest; response?: Schema$VoterInfoResponse; diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index bfb5cac32bb..c66fd37c8a7 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -130,27 +130,27 @@ export namespace classroom_v1 { /** * Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. */ - alternateLink?: string; + alternateLink?: string | null; /** * Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`. */ - assigneeMode?: string; + assigneeMode?: string | null; /** * Identifier of the course. Read-only. */ - courseId?: string; + courseId?: string | null; /** * Timestamp when this announcement was created. Read-only. */ - creationTime?: string; + creationTime?: string | null; /** * Identifier for the user that created the announcement. Read-only. */ - creatorUserId?: string; + creatorUserId?: string | null; /** * Classroom-assigned identifier of this announcement, unique per course. Read-only. */ - id?: string; + id?: string | null; /** * Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be able to see the announcement. */ @@ -162,19 +162,19 @@ export namespace classroom_v1 { /** * Optional timestamp when this announcement is scheduled to be published. */ - scheduledTime?: string; + scheduledTime?: string | null; /** * Status of this announcement. If unspecified, the default state is `DRAFT`. */ - state?: string; + state?: string | null; /** * Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters. */ - text?: string; + text?: string | null; /** * Timestamp of the most recent change to this announcement. Read-only. */ - updateTime?: string; + updateTime?: string | null; } /** * Additional details for assignments. @@ -222,7 +222,7 @@ export namespace classroom_v1 { /** * The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). */ - topicName?: string; + topicName?: string | null; } /** * A Course in Classroom. @@ -231,15 +231,15 @@ export namespace classroom_v1 { /** * Absolute link to this course in the Classroom web UI. Read-only. */ - alternateLink?: string; + alternateLink?: string | null; /** * The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. */ - calendarId?: string; + calendarId?: string | null; /** * The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. */ - courseGroupEmail?: string; + courseGroupEmail?: string | null; /** * Sets of materials that appear on the "about" page of this course. Read-only. */ @@ -247,47 +247,47 @@ export namespace classroom_v1 { /** * State of the course. If unspecified, the default state is `PROVISIONED`. */ - courseState?: string; + courseState?: string | null; /** * Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. */ - creationTime?: string; + creationTime?: string | null; /** * Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. */ - description?: string; + description?: string | null; /** * Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. */ - descriptionHeading?: string; + descriptionHeading?: string | null; /** * Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. */ - enrollmentCode?: string; + enrollmentCode?: string | null; /** * Whether or not guardian notifications are enabled for this course. Read-only. */ - guardiansEnabled?: boolean; + guardiansEnabled?: boolean | null; /** * Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. */ - id?: string; + id?: string | null; /** * Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. */ - name?: string; + name?: string | null; /** * The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. */ - ownerId?: string; + ownerId?: string | null; /** * Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. */ - room?: string; + room?: string | null; /** * Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. */ - section?: string; + section?: string | null; /** * Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. */ @@ -295,11 +295,11 @@ export namespace classroom_v1 { /** * The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. */ - teacherGroupEmail?: string; + teacherGroupEmail?: string | null; /** * Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. */ - updateTime?: string; + updateTime?: string | null; } /** * Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded. @@ -308,7 +308,7 @@ export namespace classroom_v1 { /** * Alias string. The format of the string indicates the desired alias scoping. * `d:<name>` indicates a domain-scoped alias. Example: `d:math_101` * `p:<name>` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. */ - alias?: string; + alias?: string | null; } /** * A material attached to a course as part of a material set. @@ -342,7 +342,7 @@ export namespace classroom_v1 { /** * Title for this set. */ - title?: string; + title?: string | null; } /** * Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. @@ -351,7 +351,7 @@ export namespace classroom_v1 { /** * The `course_id` of the course to subscribe to roster changes for. */ - courseId?: string; + courseId?: string | null; } /** * Course work created by a teacher for students of the course. @@ -360,11 +360,11 @@ export namespace classroom_v1 { /** * Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. */ - alternateLink?: string; + alternateLink?: string | null; /** * Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. */ - assigneeMode?: string; + assigneeMode?: string | null; /** * Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. */ @@ -372,23 +372,23 @@ export namespace classroom_v1 { /** * Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only. */ - associatedWithDeveloper?: boolean; + associatedWithDeveloper?: boolean | null; /** * Identifier of the course. Read-only. */ - courseId?: string; + courseId?: string | null; /** * Timestamp when this course work was created. Read-only. */ - creationTime?: string; + creationTime?: string | null; /** * Identifier for the user that created the coursework. Read-only. */ - creatorUserId?: string; + creatorUserId?: string | null; /** * Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. */ - description?: string; + description?: string | null; /** * Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. */ @@ -400,7 +400,7 @@ export namespace classroom_v1 { /** * Classroom-assigned identifier of this course work, unique per course. Read-only. */ - id?: string; + id?: string | null; /** * Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be assigned the coursework. */ @@ -412,7 +412,7 @@ export namespace classroom_v1 { /** * Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. */ - maxPoints?: number; + maxPoints?: number | null; /** * Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. */ @@ -420,31 +420,31 @@ export namespace classroom_v1 { /** * Optional timestamp when this course work is scheduled to be published. */ - scheduledTime?: string; + scheduledTime?: string | null; /** * Status of this course work. If unspecified, the default state is `DRAFT`. */ - state?: string; + state?: string | null; /** * Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. */ - submissionModificationMode?: string; + submissionModificationMode?: string | null; /** * Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. */ - title?: string; + title?: string | null; /** * Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. */ - topicId?: string; + topicId?: string | null; /** * Timestamp of the most recent change to this course work. Read-only. */ - updateTime?: string; + updateTime?: string | null; /** * Type of this course work. The type is set when the course work is created and cannot be changed. */ - workType?: string; + workType?: string | null; } /** * Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. @@ -453,7 +453,7 @@ export namespace classroom_v1 { /** * The `course_id` of the course to subscribe to work changes for. */ - courseId?: string; + courseId?: 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 date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. @@ -462,15 +462,15 @@ export namespace classroom_v1 { /** * 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; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * Representation of a Google Drive file. @@ -479,19 +479,19 @@ export namespace classroom_v1 { /** * URL that can be used to access the Drive item. Read-only. */ - alternateLink?: string; + alternateLink?: string | null; /** * Drive API resource ID. */ - id?: string; + id?: string | null; /** * URL of a thumbnail image of the Drive item. Read-only. */ - thumbnailUrl?: string; + thumbnailUrl?: string | null; /** * Title of the Drive item. Read-only. */ - title?: string; + title?: string | null; } /** * Representation of a Google Drive folder. @@ -500,15 +500,15 @@ export namespace classroom_v1 { /** * URL that can be used to access the Drive folder. Read-only. */ - alternateLink?: string; + alternateLink?: string | null; /** * Drive API resource ID. */ - id?: string; + id?: string | null; /** * Title of the Drive folder. Read-only. */ - title?: string; + title?: 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 `{}`. @@ -529,7 +529,7 @@ export namespace classroom_v1 { /** * The type of feed. */ - feedType?: string; + feedType?: string | null; } /** * Google Forms item. @@ -538,19 +538,19 @@ export namespace classroom_v1 { /** * URL of the form. */ - formUrl?: string; + formUrl?: string | null; /** * URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. */ - responseUrl?: string; + responseUrl?: string | null; /** * URL of a thumbnail image of the Form. Read-only. */ - thumbnailUrl?: string; + thumbnailUrl?: string | null; /** * Title of the Form. Read-only. */ - title?: string; + title?: string | null; } /** * Global user permission description. @@ -559,7 +559,7 @@ export namespace classroom_v1 { /** * Permission value. */ - permission?: string; + permission?: string | null; } /** * The history of each grade on this submission. @@ -568,23 +568,23 @@ export namespace classroom_v1 { /** * The teacher who made the grade change. */ - actorUserId?: string; + actorUserId?: string | null; /** * The type of grade change at this time in the submission grade history. */ - gradeChangeType?: string; + gradeChangeType?: string | null; /** * When the grade of the submission was changed. */ - gradeTimestamp?: string; + gradeTimestamp?: string | null; /** * The denominator of the grade at this time in the submission grade history. */ - maxPoints?: number; + maxPoints?: number | null; /** * The numerator of the grade at this time in the submission grade history. */ - pointsEarned?: number; + pointsEarned?: number | null; } /** * Association between a student and a guardian of that student. The guardian may receive information about the student's course work. @@ -593,7 +593,7 @@ export namespace classroom_v1 { /** * Identifier for the guardian. */ - guardianId?: string; + guardianId?: string | null; /** * User profile for the guardian. */ @@ -601,11 +601,11 @@ export namespace classroom_v1 { /** * The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators. */ - invitedEmailAddress?: string; + invitedEmailAddress?: string | null; /** * Identifier for the student to whom the guardian relationship applies. */ - studentId?: string; + studentId?: string | null; } /** * An invitation to become the guardian of a specified user, sent to a specified email address. @@ -614,23 +614,23 @@ export namespace classroom_v1 { /** * The time that this invitation was created. Read-only. */ - creationTime?: string; + creationTime?: string | null; /** * Unique identifier for this invitation. Read-only. */ - invitationId?: string; + invitationId?: string | null; /** * Email address that the invitation was sent to. This field is only visible to domain administrators. */ - invitedEmailAddress?: string; + invitedEmailAddress?: string | null; /** * The state that this invitation is in. */ - state?: string; + state?: string | null; /** * ID of the student (in standard format) */ - studentId?: string; + studentId?: string | null; } /** * Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. @@ -639,7 +639,7 @@ export namespace classroom_v1 { /** * Identifiers for the students that have access to the coursework/announcement. */ - studentIds?: string[]; + studentIds?: string[] | null; } /** * An invitation to join a course. @@ -648,19 +648,19 @@ export namespace classroom_v1 { /** * Identifier of the course to invite the user to. */ - courseId?: string; + courseId?: string | null; /** * Identifier assigned by Classroom. Read-only. */ - id?: string; + id?: string | null; /** * Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. */ - role?: string; + role?: string | null; /** * Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ - userId?: string; + userId?: string | null; } /** * URL item. @@ -669,15 +669,15 @@ export namespace classroom_v1 { /** * URL of a thumbnail image of the target URL. Read-only. */ - thumbnailUrl?: string; + thumbnailUrl?: string | null; /** * Title of the target of the URL. Read-only. */ - title?: string; + title?: string | null; /** * URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. */ - url?: string; + url?: string | null; } /** * Response when listing course work. @@ -690,7 +690,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response when listing course aliases. @@ -703,7 +703,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response when listing courses. @@ -716,7 +716,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response when listing course work. @@ -729,7 +729,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response when listing guardian invitations. @@ -742,7 +742,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response when listing guardians. @@ -755,7 +755,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response when listing invitations. @@ -768,7 +768,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response when listing students. @@ -777,7 +777,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Students who match the list request. */ @@ -790,7 +790,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Student work that matches the request. */ @@ -803,7 +803,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Teachers who match the list request. */ @@ -816,7 +816,7 @@ export namespace classroom_v1 { /** * Token identifying the next page of results to return. If empty, no further results are available. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Topic items that match the request. */ @@ -850,7 +850,7 @@ export namespace classroom_v1 { /** * Mode of the announcement describing whether it will be accessible by all students or specified individual students. */ - assigneeMode?: string; + assigneeMode?: string | null; /** * Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. */ @@ -872,7 +872,7 @@ export namespace classroom_v1 { /** * Mode of the coursework describing whether it will be assigned to all students or specified individual students. */ - assigneeMode?: string; + assigneeMode?: string | null; /** * Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. */ @@ -885,11 +885,11 @@ export namespace classroom_v1 { /** * Ids of students to be added as having access to this coursework/announcement. */ - addStudentIds?: string[]; + addStudentIds?: string[] | null; /** * Ids of students to be removed from having access to this coursework/announcement. */ - removeStudentIds?: string[]; + removeStudentIds?: string[] | null; } /** * Additional details for multiple-choice questions. @@ -898,7 +898,7 @@ export namespace classroom_v1 { /** * Possible choices. */ - choices?: string[]; + choices?: string[] | null; } /** * Student work for a multiple-choice question. @@ -907,7 +907,7 @@ export namespace classroom_v1 { /** * Student's select choice. */ - answer?: string; + answer?: string | null; } /** * Details of the user's name. @@ -916,15 +916,15 @@ export namespace classroom_v1 { /** * The user's last name. Read-only. */ - familyName?: string; + familyName?: string | null; /** * The user's full name formed by concatenating the first and last name values. Read-only. */ - fullName?: string; + fullName?: string | null; /** * The user's first name. Read-only. */ - givenName?: string; + givenName?: string | null; } /** * Request to reclaim a student submission. @@ -941,7 +941,7 @@ export namespace classroom_v1 { /** * The time until which the `Registration` is effective. This is a read-only field assigned by the server. */ - expiryTime?: string; + expiryTime?: string | null; /** * Specification for the class of notifications that Classroom should deliver to the destination. */ @@ -949,7 +949,7 @@ export namespace classroom_v1 { /** * A server-generated unique identifier for this `Registration`. Read-only. */ - registrationId?: string; + registrationId?: string | null; } /** * Request to return a student submission. @@ -966,7 +966,7 @@ export namespace classroom_v1 { /** * Mechanism by which students access the Drive item. */ - shareMode?: string; + shareMode?: string | null; } /** * Student work for a short answer question. @@ -975,7 +975,7 @@ export namespace classroom_v1 { /** * Student response to a short-answer question. */ - answer?: string; + answer?: string | null; } /** * The history of each state this submission has been in. @@ -984,15 +984,15 @@ export namespace classroom_v1 { /** * The teacher or student who made the change */ - actorUserId?: string; + actorUserId?: string | null; /** * The workflow pipeline stage. */ - state?: string; + state?: string | null; /** * When the submission entered this state. */ - stateTimestamp?: string; + stateTimestamp?: string | null; } /** * Student in a course. @@ -1001,7 +1001,7 @@ export namespace classroom_v1 { /** * Identifier of the course. Read-only. */ - courseId?: string; + courseId?: string | null; /** * Global user information for the student. Read-only. */ @@ -1013,7 +1013,7 @@ export namespace classroom_v1 { /** * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ - userId?: string; + userId?: string | null; } /** * Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. @@ -1022,11 +1022,11 @@ export namespace classroom_v1 { /** * Absolute link to the submission in the Classroom web UI. Read-only. */ - alternateLink?: string; + alternateLink?: string | null; /** * Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This may be modified only by course teachers. */ - assignedGrade?: number; + assignedGrade?: number | null; /** * Submission content when course_work_type is ASSIGNMENT. Students can modify this content using google.classroom.Work.ModifyAttachments. */ @@ -1034,35 +1034,35 @@ export namespace classroom_v1 { /** * Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only. */ - associatedWithDeveloper?: boolean; + associatedWithDeveloper?: boolean | null; /** * Identifier of the course. Read-only. */ - courseId?: string; + courseId?: string | null; /** * Identifier for the course work this corresponds to. Read-only. */ - courseWorkId?: string; + courseWorkId?: string | null; /** * Type of course work this submission is for. Read-only. */ - courseWorkType?: string; + courseWorkType?: string | null; /** * Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. */ - creationTime?: string; + creationTime?: string | null; /** * Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This is only visible to and modifiable by course teachers. */ - draftGrade?: number; + draftGrade?: number | null; /** * Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. */ - id?: string; + id?: string | null; /** * Whether this submission is late. Read-only. */ - late?: boolean; + late?: boolean | null; /** * Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION. */ @@ -1074,7 +1074,7 @@ export namespace classroom_v1 { /** * State of this submission. Read-only. */ - state?: string; + state?: string | null; /** * The history of the submission (includes state and grade histories). Read-only. */ @@ -1082,11 +1082,11 @@ export namespace classroom_v1 { /** * Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. */ - updateTime?: string; + updateTime?: string | null; /** * Identifier for the student that owns this submission. Read-only. */ - userId?: string; + userId?: string | null; } /** * The history of the submission. This currently includes state and grade histories. @@ -1108,7 +1108,7 @@ export namespace classroom_v1 { /** * Identifier of the course. Read-only. */ - courseId?: string; + courseId?: string | null; /** * Global user information for the teacher. Read-only. */ @@ -1116,7 +1116,7 @@ export namespace classroom_v1 { /** * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ - userId?: string; + userId?: string | null; } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. @@ -1125,19 +1125,19 @@ export namespace classroom_v1 { /** * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ - hours?: number; + hours?: number | null; /** * Minutes of hour of day. Must be from 0 to 59. */ - minutes?: number; + minutes?: number | null; /** * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ - nanos?: number; + nanos?: number | null; /** * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ - seconds?: number; + seconds?: number | null; } /** * Topic created by a teacher for the course @@ -1146,19 +1146,19 @@ export namespace classroom_v1 { /** * Identifier of the course. Read-only. */ - courseId?: string; + courseId?: string | null; /** * The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters. */ - name?: string; + name?: string | null; /** * Unique identifier for the topic. Read-only. */ - topicId?: string; + topicId?: string | null; /** * The time the topic was last updated by the system. Read-only. */ - updateTime?: string; + updateTime?: string | null; } /** * Request to turn in a student submission. @@ -1171,11 +1171,11 @@ export namespace classroom_v1 { /** * Email address of the user. Read-only. */ - emailAddress?: string; + emailAddress?: string | null; /** * Identifier of the user. Read-only. */ - id?: string; + id?: string | null; /** * Name of the user. Read-only. */ @@ -1187,11 +1187,11 @@ export namespace classroom_v1 { /** * URL of user's profile photo. Read-only. */ - photoUrl?: string; + photoUrl?: string | null; /** * Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false. Read-only */ - verifiedTeacher?: boolean; + verifiedTeacher?: boolean | null; } /** * YouTube video item. @@ -1200,19 +1200,19 @@ export namespace classroom_v1 { /** * URL that can be used to view the YouTube video. Read-only. */ - alternateLink?: string; + alternateLink?: string | null; /** * YouTube API resource ID. */ - id?: string; + id?: string | null; /** * URL of a thumbnail image of the YouTube video. Read-only. */ - thumbnailUrl?: string; + thumbnailUrl?: string | null; /** * Title of the YouTube video. Read-only. */ - title?: string; + title?: string | null; } export class Resource$Courses { diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index 3b759386f87..8f2fd30c009 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -128,7 +128,7 @@ export namespace cloudasset_v1 { /** * Type of the asset. Example: "compute.googleapis.com/Disk". */ - assetType?: string; + assetType?: string | null; /** * Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it. */ @@ -136,7 +136,7 @@ export namespace cloudasset_v1 { /** * The full name of the asset. 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 information. */ - name?: string; + name?: string | null; /** * Representation of the Cloud Organization Policy set on an asset. For each asset, there could be multiple Organization policies with different constraints. */ @@ -158,7 +158,7 @@ export namespace cloudasset_v1 { /** * 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; + 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. @@ -167,11 +167,11 @@ export namespace cloudasset_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Batch get assets history response. @@ -189,15 +189,15 @@ export namespace cloudasset_v1 { /** * Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId", to which the snapshot result should be exported. If this dataset does not exist, the export call returns an error. */ - dataset?: string; + dataset?: string | null; /** * If the destination table already exists and this flag is `TRUE`, the table will be overwritten by the contents of assets snapshot. If the flag is not set and the destination table already exists, the export call returns an error. */ - force?: boolean; + force?: boolean | null; /** * Required. The BigQuery table to which the snapshot result should be written. If this table does not exist, a new table with the given name will be created. */ - table?: string; + table?: string | null; } /** * Associates `members` with a `role`. @@ -210,11 +210,11 @@ export namespace cloudasset_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Export asset request. @@ -223,11 +223,11 @@ export namespace cloudasset_v1 { /** * A list of asset types of which to take a snapshot for. For example: "compute.googleapis.com/Disk". If specified, only matching assets will be returned. See [Introduction to Cloud Asset Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) for all supported asset types. */ - assetTypes?: string[]; + assetTypes?: string[] | null; /** * Asset content type. If not specified, no content but the asset name will be returned. */ - contentType?: string; + contentType?: string | null; /** * Required. Output configuration indicating where the results will be output to. All results will be in newline delimited JSON format. */ @@ -235,7 +235,7 @@ export namespace cloudasset_v1 { /** * Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results. */ - readTime?: string; + readTime?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -244,19 +244,19 @@ export namespace cloudasset_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * A Cloud Storage location. @@ -265,11 +265,11 @@ export namespace cloudasset_v1 { /** * The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. */ - uri?: string; + uri?: string | null; /** * The uri prefix of all generated Cloud Storage objects. For example: "gs://bucket_name/object_name_prefix". Each object uri is in format: "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only contains assets for that type. <shard number> starts from 0. For example: "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is the first shard of output objects containing all compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be returned if file with the same name "gs://bucket_name/object_name_prefix" already exists. */ - uriPrefix?: string; + uriPrefix?: string | null; } /** * Used in `policy_type` to specify how `boolean_policy` will behave at this resource. @@ -278,7 +278,7 @@ export namespace cloudasset_v1 { /** * If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable. Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess` with `constraint_default` set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following behavior: - If the `Policy` at this resource has enforced set to `false`, serial port connection attempts will be allowed. - If the `Policy` at this resource has enforced set to `true`, serial port connection attempts will be refused. - If the `Policy` at this resource is `RestoreDefault`, serial port connection attempts will be allowed. - If no `Policy` is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed. - If no `Policy` is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if the`Policy` were set at this resource. The following examples demonstrate the different possible layerings: Example 1 (nearest `Constraint` wins): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has no `Policy` set. The constraint at `projects/bar` and `organizations/foo` will not be enforced. Example 2 (enforcement gets replaced): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has a `Policy` with: {enforced: true} The constraint at `organizations/foo` is not enforced. The constraint at `projects/bar` is enforced. Example 3 (RestoreDefault): `organizations/foo` has a `Policy` with: {enforced: true} `projects/bar` has a `Policy` with: {RestoreDefault: {}} The constraint at `organizations/foo` is enforced. The constraint at `projects/bar` is not enforced, because `constraint_default` for the `Constraint` is `ALLOW`. */ - enforced?: boolean; + enforced?: boolean | null; } /** * Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - “projects/<project-id>”, e.g. “projects/tokyo-rain-123” - “folders/<folder-id>”, e.g. “folders/1234” - “organizations/<organization-id>”, e.g. “organizations/1234” The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset. @@ -287,23 +287,23 @@ export namespace cloudasset_v1 { /** * List of values allowed at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. */ - allowedValues?: string[]; + allowedValues?: string[] | null; /** * The policy all_values state. */ - allValues?: string; + allValues?: string | null; /** * List of values denied at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. */ - deniedValues?: string[]; + deniedValues?: string[] | null; /** * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. */ - inheritFromParent?: boolean; + inheritFromParent?: boolean | null; /** * Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Policy`. If `suggested_value` is not set, it will inherit the value specified higher in the hierarchy, unless `inherit_from_parent` is `false`. */ - suggestedValue?: string; + suggestedValue?: string | null; } /** * Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources. @@ -316,11 +316,11 @@ export namespace cloudasset_v1 { /** * The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`. Immutable after creation. */ - constraint?: string; + constraint?: string | null; /** * An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`. */ - etag?: string; + etag?: string | null; /** * List of values either allowed or disallowed. */ @@ -332,11 +332,11 @@ export namespace cloudasset_v1 { /** * The time stamp the `Policy` was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to `SetOrgPolicy` was made for that `Policy`. Any value set by the client will be ignored. */ - updateTime?: string; + updateTime?: string | null; /** * Version of the `Policy`. Default version is 0; */ - version?: number; + version?: number | null; } /** * Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific `Constraint` at this resource. Suppose that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/serviceuser.services`. Suppose that organization foo.com sets a `Policy` at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a `Policy` with the `policy_type` `restore_default` on several experimental projects, restoring the `constraint_default` enforcement of the `Constraint` for only those projects, allowing those projects to have all services activated. @@ -353,23 +353,23 @@ export namespace cloudasset_v1 { /** * Output only. Time the `AccessLevel` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Description of the `AccessLevel` and its use. Does not affect behavior. */ - description?: string; + description?: string | null; /** * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` */ - name?: string; + name?: string | null; /** * Human readable title. Must be unique within the Policy. */ - title?: string; + title?: string | null; /** * Output only. Time the `AccessLevel` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. @@ -378,23 +378,23 @@ export namespace cloudasset_v1 { /** * Output only. Time the `AccessPolicy` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` */ - name?: string; + name?: string | null; /** * Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` */ - parent?: string; + parent?: string | null; /** * Required. Human readable title. Does not affect behavior. */ - title?: string; + title?: string | null; /** * Output only. Time the `AccessPolicy` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `BasicLevel` is an `AccessLevel` using a set of recommended features. @@ -403,7 +403,7 @@ export namespace cloudasset_v1 { /** * How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND. */ - combiningFunction?: string; + combiningFunction?: string | null; /** * Required. A list of requirements for the `AccessLevel` to be granted. */ @@ -420,23 +420,23 @@ export namespace cloudasset_v1 { /** * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed. */ - ipSubnetworks?: string[]; + ipSubnetworks?: string[] | null; /** * The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user. */ - members?: string[]; + members?: string[] | null; /** * Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false. */ - negate?: boolean; + negate?: boolean | null; /** * The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. */ - regions?: string[]; + regions?: string[] | null; /** * A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` */ - requiredAccessLevels?: string[]; + requiredAccessLevels?: string[] | null; } /** * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. @@ -445,11 +445,11 @@ export namespace cloudasset_v1 { /** * Allowed device management levels, an empty list allows all management levels. */ - allowedDeviceManagementLevels?: string[]; + allowedDeviceManagementLevels?: string[] | null; /** * Allowed encryptions statuses, an empty list allows all statuses. */ - allowedEncryptionStatuses?: string[]; + allowedEncryptionStatuses?: string[] | null; /** * Allowed OS versions, an empty list allows all types and all versions. */ @@ -457,15 +457,15 @@ export namespace cloudasset_v1 { /** * Whether the device needs to be approved by the customer admin. */ - requireAdminApproval?: boolean; + requireAdminApproval?: boolean | null; /** * Whether the device needs to be corp owned. */ - requireCorpOwned?: boolean; + requireCorpOwned?: boolean | null; /** * Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. */ - requireScreenlock?: boolean; + requireScreenlock?: boolean | null; } /** * A restriction on the OS type and version of devices making requests. @@ -474,15 +474,15 @@ export namespace cloudasset_v1 { /** * The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. */ - minimumVersion?: string; + minimumVersion?: string | null; /** * Required. The allowed OS type. */ - osType?: string; + osType?: string | null; /** * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. */ - requireVerifiedChromeOs?: boolean; + requireVerifiedChromeOs?: boolean | null; } /** * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. @@ -491,19 +491,19 @@ export namespace cloudasset_v1 { /** * Output only. Time the `ServicePerimeter` was created in UTC. */ - createTime?: string; + createTime?: string | null; /** * Description of the `ServicePerimeter` and its use. Does not affect behavior. */ - description?: string; + description?: string | null; /** * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` */ - name?: string; + name?: string | null; /** * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. */ - perimeterType?: string; + perimeterType?: string | null; /** * Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. */ @@ -511,11 +511,11 @@ export namespace cloudasset_v1 { /** * Human readable title. Must be unique within the Policy. */ - title?: string; + title?: string | null; /** * Output only. Time the `ServicePerimeter` was updated in UTC. */ - updateTime?: string; + updateTime?: string | null; } /** * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. @@ -524,15 +524,15 @@ export namespace cloudasset_v1 { /** * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ - accessLevels?: string[]; + accessLevels?: string[] | null; /** * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ - resources?: string[]; + resources?: string[] | null; /** * GCP services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ - restrictedServices?: string[]; + restrictedServices?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -541,7 +541,7 @@ export namespace cloudasset_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -549,15 +549,15 @@ export namespace cloudasset_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Output configuration for export assets destination. @@ -587,11 +587,11 @@ export namespace cloudasset_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Representation of a cloud resource. @@ -600,27 +600,27 @@ export namespace cloudasset_v1 { /** * The content of the resource, in which some sensitive fields are scrubbed away and may not be present. */ - data?: {[key: string]: any}; + data?: {[key: string]: any} | null; /** * The URL of the discovery document containing the resource's JSON schema. For example: `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. It will be left unspecified for resources without a discovery-based API, such as Cloud Bigtable. */ - discoveryDocumentUri?: string; + discoveryDocumentUri?: string | null; /** * The JSON schema name listed in the discovery document. Example: "Project". It will be left unspecified for resources (such as Cloud Bigtable) without a discovery-based API. */ - discoveryName?: string; + discoveryName?: string | null; /** * The full name of the immediate parent of this resource. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. For GCP assets, it is the parent resource defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). For example: `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. For third-party assets, it is up to the users to define. */ - parent?: string; + parent?: string | null; /** * The REST URL for accessing the resource. An HTTP GET operation using this URL returns the resource itself. Example: `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. It will be left unspecified for resources without a REST API. */ - resourceUrl?: string; + resourceUrl?: string | null; /** * The API version. Example: "v1". */ - version?: string; + version?: 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). @@ -629,15 +629,15 @@ export namespace cloudasset_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it. @@ -650,7 +650,7 @@ export namespace cloudasset_v1 { /** * If the asset is deleted or not. */ - deleted?: boolean; + deleted?: boolean | null; /** * The time window when the asset data and state was observed. */ @@ -663,11 +663,11 @@ export namespace cloudasset_v1 { /** * End time of the time window (inclusive). Current timestamp if not specified. */ - endTime?: string; + endTime?: string | null; /** * Start time of the time window (exclusive). */ - startTime?: string; + startTime?: string | null; } export class Resource$Operations { diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index 6a1026cc287..f026675deb8 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -128,7 +128,7 @@ export namespace cloudasset_v1beta1 { /** * Type of the asset. Example: "google.compute.Disk". */ - assetType?: string; + assetType?: string | null; /** * Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it. */ @@ -136,7 +136,7 @@ export namespace cloudasset_v1beta1 { /** * The full name of the asset. 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 information. */ - name?: string; + name?: string | null; /** * Representation of the resource. */ @@ -153,7 +153,7 @@ export namespace cloudasset_v1beta1 { /** * 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; + 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. @@ -162,11 +162,11 @@ export namespace cloudasset_v1beta1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Batch get assets history response. @@ -188,11 +188,11 @@ export namespace cloudasset_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Export asset request. @@ -201,11 +201,11 @@ export namespace cloudasset_v1beta1 { /** * A list of asset types of which to take a snapshot for. For example: "google.compute.Disk". If specified, only matching assets will be returned. See [Introduction to Cloud Asset Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) for all supported asset types. */ - assetTypes?: string[]; + assetTypes?: string[] | null; /** * Asset content type. If not specified, no content but the asset name will be returned. */ - contentType?: string; + contentType?: string | null; /** * Required. Output configuration indicating where the results will be output to. All results will be in newline delimited JSON format. */ @@ -213,7 +213,7 @@ export namespace cloudasset_v1beta1 { /** * Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results. */ - readTime?: string; + readTime?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -222,19 +222,19 @@ export namespace cloudasset_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * A Cloud Storage location. @@ -243,11 +243,11 @@ export namespace cloudasset_v1beta1 { /** * The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. */ - uri?: string; + uri?: string | null; /** * The uri prefix of all generated Cloud Storage objects. For example: "gs://bucket_name/object_name_prefix". Each object uri is in format: "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only contains assets for that type. <shard number> starts from 0. For example: "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first shard of output objects containing all google.compute.disk assets. An INVALID_ARGUMENT error will be returned if file with the same name "gs://bucket_name/object_name_prefix" already exists. */ - uriPrefix?: string; + uriPrefix?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -256,7 +256,7 @@ export namespace cloudasset_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -264,15 +264,15 @@ export namespace cloudasset_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Output configuration for export assets destination. @@ -298,11 +298,11 @@ export namespace cloudasset_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Representation of a cloud resource. @@ -311,27 +311,27 @@ export namespace cloudasset_v1beta1 { /** * The content of the resource, in which some sensitive fields are scrubbed away and may not be present. */ - data?: {[key: string]: any}; + data?: {[key: string]: any} | null; /** * The URL of the discovery document containing the resource's JSON schema. For example: `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. It will be left unspecified for resources without a discovery-based API, such as Cloud Bigtable. */ - discoveryDocumentUri?: string; + discoveryDocumentUri?: string | null; /** * The JSON schema name listed in the discovery document. Example: "Project". It will be left unspecified for resources (such as Cloud Bigtable) without a discovery-based API. */ - discoveryName?: string; + discoveryName?: string | null; /** * The full name of the immediate parent of this resource. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. For GCP assets, it is the parent resource defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). For example: `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. For third-party assets, it is up to the users to define. */ - parent?: string; + parent?: string | null; /** * The REST URL for accessing the resource. An HTTP GET operation using this URL returns the resource itself. Example: `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. It will be left unspecified for resources without a REST API. */ - resourceUrl?: string; + resourceUrl?: string | null; /** * The API version. Example: "v1". */ - version?: string; + version?: 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). @@ -340,15 +340,15 @@ export namespace cloudasset_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it. @@ -361,7 +361,7 @@ export namespace cloudasset_v1beta1 { /** * If the asset is deleted or not. */ - deleted?: boolean; + deleted?: boolean | null; /** * The time window when the asset data and state was observed. */ @@ -374,11 +374,11 @@ export namespace cloudasset_v1beta1 { /** * End time of the time window (inclusive). Current timestamp if not specified. */ - endTime?: string; + endTime?: string | null; /** * Start time of the time window (exclusive). */ - startTime?: string; + startTime?: string | null; } export class Resource$Folders { diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index 119730a6ba8..7d1750e1c8a 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -128,9 +128,9 @@ export namespace cloudbilling_v1 { /** * The number of intervals to aggregate over. Example: If aggregation_level is "DAILY" and aggregation_count is 14, aggregation will be over 14 days. */ - aggregationCount?: number; - aggregationInterval?: string; - aggregationLevel?: string; + aggregationCount?: number | null; + aggregationInterval?: string | null; + aggregationLevel?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -143,7 +143,7 @@ export namespace cloudbilling_v1 { /** * 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; + 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. @@ -152,15 +152,15 @@ export namespace cloudbilling_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. */ - ignoreChildExemptions?: boolean; + ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * A billing account in [GCP Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. @@ -169,19 +169,19 @@ export namespace cloudbilling_v1 { /** * The display name given to the billing account, such as `My Billing Account`. This name is displayed in the GCP Console. */ - displayName?: string; + displayName?: string | null; /** * If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the master billing account that it is being resold through. Otherwise this will be empty. */ - masterBillingAccount?: string; + masterBillingAccount?: string | null; /** * The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. */ - name?: string; + 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. */ - open?: boolean; + open?: boolean | null; } /** * Associates `members` with a `role`. @@ -194,11 +194,11 @@ export namespace cloudbilling_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Represents the category hierarchy of a SKU. @@ -207,19 +207,19 @@ export namespace cloudbilling_v1 { /** * The type of product the SKU refers to. Example: "Compute", "Storage", "Network", "ApplicationServices" etc. */ - resourceFamily?: string; + resourceFamily?: string | null; /** * A group classification for related SKUs. Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc. */ - resourceGroup?: string; + resourceGroup?: string | null; /** * The display name of the service this SKU belongs to. */ - serviceDisplayName?: string; + serviceDisplayName?: string | null; /** * Represents how the SKU is consumed. Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc. */ - usageType?: string; + usageType?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -228,19 +228,19 @@ export namespace cloudbilling_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Response message for `ListBillingAccounts`. @@ -253,7 +253,7 @@ export namespace cloudbilling_v1 { /** * A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Request message for `ListProjectBillingInfoResponse`. @@ -262,7 +262,7 @@ export namespace cloudbilling_v1 { /** * A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of `ProjectBillingInfo` resources representing the projects associated with the billing account. */ @@ -275,7 +275,7 @@ export namespace cloudbilling_v1 { /** * A token to retrieve the next page of results. To retrieve the next page, call `ListServices` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of services. */ @@ -288,7 +288,7 @@ export namespace cloudbilling_v1 { /** * A token to retrieve the next page of results. To retrieve the next page, call `ListSkus` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of public SKUs of the given service. */ @@ -301,15 +301,15 @@ export namespace cloudbilling_v1 { /** * The 3-letter currency code defined in ISO 4217. */ - currencyCode?: string; + currencyCode?: string | null; /** * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ - nanos?: number; + nanos?: number | null; /** * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ - units?: string; + units?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -326,11 +326,11 @@ export namespace cloudbilling_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` `tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` `[start_usage_amount: 100, unit_price: $5]` The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage. @@ -339,19 +339,19 @@ export namespace cloudbilling_v1 { /** * The base unit for the SKU which is the unit used in usage exports. Example: "By" */ - baseUnit?: string; + baseUnit?: string | null; /** * Conversion factor for converting from price per usage_unit to price per base_unit, and start_usage_amount to start_usage_amount in base_unit. unit_price / base_unit_conversion_factor = price per base_unit. start_usage_amount * base_unit_conversion_factor = start_usage_amount in base_unit. */ - baseUnitConversionFactor?: number; + baseUnitConversionFactor?: number | null; /** * The base unit in human readable form. Example: "byte". */ - baseUnitDescription?: string; + baseUnitDescription?: string | null; /** * The recommended quantity of units for displaying pricing info. When displaying pricing info it is recommended to display: (unit_price * display_quantity) per display_quantity usage_unit. This field does not affect the pricing formula and is for display purposes only. Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and the display_quantity is "1000" then the recommended way of displaying the pricing info is "0.10 USD per 1000 GB" */ - displayQuantity?: number; + displayQuantity?: number | null; /** * The list of tiered rates for this pricing. The total cost is computed by applying each of the tiered rates on usage. This repeated list is sorted by ascending order of start_usage_amount. */ @@ -359,11 +359,11 @@ export namespace cloudbilling_v1 { /** * The short hand for unit of usage this pricing is specified in. Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte". */ - usageUnit?: string; + usageUnit?: string | null; /** * The unit of usage in human readable form. Example: "gibi byte". */ - usageUnitDescription?: string; + usageUnitDescription?: string | null; } /** * Represents the pricing information for a SKU at a single point of time. @@ -376,11 +376,11 @@ export namespace cloudbilling_v1 { /** * Conversion rate used for currency conversion, from USD to the currency specified in the request. This includes any surcharge collected for billing in non USD currency. If a currency is not specified in the request this defaults to 1.0. Example: USD * currency_conversion_rate = JPY */ - currencyConversionRate?: number; + currencyConversionRate?: number | null; /** * The timestamp from which this pricing was effective within the requested time range. This is guaranteed to be greater than or equal to the start_time field in the request and less than the end_time field in the request. If a time range was not specified in the request this field will be equivalent to a time within the last 12 hours, indicating the latest pricing info. */ - effectiveTime?: string; + effectiveTime?: string | null; /** * Expresses the pricing formula. See `PricingExpression` for an example. */ @@ -388,7 +388,7 @@ export namespace cloudbilling_v1 { /** * An optional human readable summary of the pricing information, has a maximum length of 256 characters. */ - summary?: string; + summary?: string | null; } /** * Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects). @@ -397,19 +397,19 @@ export namespace cloudbilling_v1 { /** * The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`. */ - billingAccountName?: string; + billingAccountName?: string | null; /** * True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only. */ - billingEnabled?: boolean; + billingEnabled?: boolean | null; /** * The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only. */ - name?: string; + name?: string | null; /** * The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only. */ - projectId?: string; + projectId?: string | null; } /** * Encapsulates a single service in Google Cloud Platform. @@ -418,19 +418,19 @@ export namespace cloudbilling_v1 { /** * The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps" */ - businessEntityName?: string; + businessEntityName?: string | null; /** * A human readable display name for this service. */ - displayName?: string; + displayName?: string | null; /** * The resource name for the service. Example: "services/DA34-426B-A397" */ - name?: string; + name?: string | null; /** * The identifier for the service. Example: "DA34-426B-A397" */ - serviceId?: string; + serviceId?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -443,7 +443,7 @@ export namespace cloudbilling_v1 { /** * 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; + updateMask?: string | null; } /** * Encapsulates a single SKU in Google Cloud Platform @@ -456,11 +456,11 @@ export namespace cloudbilling_v1 { /** * A human readable description of the SKU, has a maximum length of 256 characters. */ - description?: string; + description?: string | null; /** * The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" */ - name?: string; + name?: string | null; /** * A timeline of pricing info for this SKU in chronological order. */ @@ -468,15 +468,15 @@ export namespace cloudbilling_v1 { /** * Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform. */ - serviceProviderName?: string; + serviceProviderName?: string | null; /** * List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/ */ - serviceRegions?: string[]; + serviceRegions?: string[] | null; /** * The identifier for the SKU. Example: "AA95-CD31-42FE" */ - skuId?: string; + skuId?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -485,7 +485,7 @@ export namespace cloudbilling_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -494,7 +494,7 @@ export namespace cloudbilling_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The price rate indicating starting usage and its corresponding price. @@ -503,7 +503,7 @@ export namespace cloudbilling_v1 { /** * Usage is priced at this rate only after this amount. Example: start_usage_amount of 10 indicates that the usage will be priced at the unit_price after the first 10 usage_units. */ - startUsageAmount?: number; + startUsageAmount?: number | null; /** * The price per unit of usage. Example: unit_price of amount $10 indicates that each unit will cost $10. */ diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 550bcec594e..579094435c4 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -126,11 +126,11 @@ export namespace cloudbuild_v1 { /** * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. */ - location?: string; + location?: string | null; /** * Path globs used to match files in the build's workspace. */ - paths?: string[]; + paths?: string[] | null; /** * Output only. Stores timing information for pushing all artifact objects. */ @@ -147,7 +147,7 @@ export namespace cloudbuild_v1 { /** * The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`. */ - location?: string; + location?: string | null; } /** * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. @@ -156,7 +156,7 @@ export namespace cloudbuild_v1 { /** * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ - images?: string[]; + images?: string[] | null; /** * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. */ @@ -173,31 +173,31 @@ export namespace cloudbuild_v1 { /** * Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. */ - buildTriggerId?: string; + buildTriggerId?: string | null; /** * Output only. Time at which the request to create the build was received. */ - createTime?: string; + createTime?: string | null; /** * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. */ - finishTime?: string; + finishTime?: string | null; /** * Output only. Unique identifier of the build. */ - id?: string; + id?: string | null; /** * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. */ - images?: string[]; + images?: string[] | null; /** * Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. */ - logsBucket?: string; + logsBucket?: string | null; /** * Output only. URL to logs for this build in Google Cloud Console. */ - logUrl?: string; + logUrl?: string | null; /** * Special options for this build. */ @@ -205,7 +205,7 @@ export namespace cloudbuild_v1 { /** * Output only. ID of the project. */ - projectId?: string; + projectId?: string | null; /** * Output only. Results of the build. */ @@ -225,15 +225,15 @@ export namespace cloudbuild_v1 { /** * Output only. Time at which execution of the build was started. */ - startTime?: string; + startTime?: string | null; /** * Output only. Status of the build. */ - status?: string; + status?: string | null; /** * Output only. Customer-readable message about the current status. */ - statusDetail?: string; + statusDetail?: string | null; /** * Required. The operations to be performed on the workspace. */ @@ -241,19 +241,19 @@ export namespace cloudbuild_v1 { /** * Substitutions data for `Build` resource. */ - substitutions?: {[key: string]: string}; + substitutions?: {[key: string]: string} | null; /** * Tags for annotation of a `Build`. These are not docker tags. */ - tags?: string[]; + tags?: string[] | null; /** * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes. */ - timeout?: string; + timeout?: string | null; /** * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. */ - timing?: {[key: string]: Schema$TimeSpan}; + timing?: {[key: string]: Schema$TimeSpan} | null; } /** * Metadata for build operations. @@ -271,39 +271,39 @@ export namespace cloudbuild_v1 { /** * Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ - env?: string[]; + env?: string[] | null; /** * Option to specify the logging mode, which determines where the logs are stored. */ - logging?: string; + logging?: string | null; /** * Option to define build log streaming behavior to Google Cloud Storage. */ - logStreamingOption?: string; + logStreamingOption?: string | null; /** * Compute Engine machine type on which to run the build. */ - machineType?: string; + machineType?: string | null; /** * Requested verifiability options. */ - requestedVerifyOption?: string; + requestedVerifyOption?: string | null; /** * A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. */ - secretEnv?: string[]; + secretEnv?: string[] | null; /** * Requested hash for SourceProvenance. */ - sourceProvenanceHash?: string[]; + sourceProvenanceHash?: string[] | null; /** * Option to specify behavior when there is an error in the substitution checks. */ - substitutionOption?: string; + substitutionOption?: string | null; /** * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. */ @@ -311,7 +311,7 @@ export namespace cloudbuild_v1 { /** * 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. */ - workerPool?: string; + workerPool?: string | null; } /** * A step in the build pipeline. @@ -320,27 +320,27 @@ export namespace cloudbuild_v1 { /** * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. */ - args?: string[]; + args?: string[] | null; /** * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. */ - dir?: string; + dir?: string | null; /** * Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. */ - entrypoint?: string; + entrypoint?: string | null; /** * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ - env?: string[]; + env?: string[] | null; /** * Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. */ - id?: string; + id?: string | null; /** * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. */ - name?: string; + name?: string | null; /** * Output only. Stores timing information for pulling this build step's builder image only. */ @@ -348,15 +348,15 @@ export namespace cloudbuild_v1 { /** * A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. */ - secretEnv?: string[]; + secretEnv?: string[] | null; /** * Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. */ - status?: string; + status?: string | null; /** * Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. */ - timeout?: string; + timeout?: string | null; /** * Output only. Stores timing information for executing this build step. */ @@ -368,7 +368,7 @@ export namespace cloudbuild_v1 { /** * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. */ - waitFor?: string[]; + waitFor?: string[] | null; } /** * Configuration for an automated build in response to source repository changes. @@ -381,19 +381,19 @@ export namespace cloudbuild_v1 { /** * Output only. Time when the trigger was created. */ - createTime?: string; + createTime?: string | null; /** * Human-readable description of this trigger. */ - description?: string; + description?: string | null; /** * If true, the trigger will never result in a build. */ - disabled?: boolean; + disabled?: boolean | null; /** * Path, from the source root, to a file whose contents is used for the template. */ - filename?: string; + filename?: string | null; /** * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. */ @@ -401,27 +401,27 @@ export namespace cloudbuild_v1 { /** * Output only. Unique identifier of the trigger. */ - id?: string; + id?: string | null; /** * ignored_files and included_files are file glob matches using http://godoc/pkg/path/filepath#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. */ - ignoredFiles?: string[]; + ignoredFiles?: string[] | null; /** * If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. */ - includedFiles?: string[]; + includedFiles?: string[] | null; /** * User assigned name of the trigger. Must be unique within the project. */ - name?: string; + name?: string | null; /** * Substitutions data for Build resource. */ - substitutions?: {[key: string]: string}; + substitutions?: {[key: string]: string} | null; /** * Tags for annotation of a `BuildTrigger` */ - tags?: string[]; + tags?: string[] | null; /** * Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. */ @@ -434,11 +434,11 @@ export namespace cloudbuild_v1 { /** * Docker Registry 2.0 digest. */ - digest?: string; + digest?: string | null; /** * Name used to push the container image to Google Container Registry, as presented to `docker push`. */ - name?: string; + name?: string | null; /** * Output only. Stores timing information for pushing the specified image. */ @@ -472,15 +472,15 @@ export namespace cloudbuild_v1 { /** * The installationID that emits the GitHub event. */ - installationId?: string; + installationId?: string | null; /** * Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". */ - name?: string; + name?: string | null; /** * Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". */ - owner?: string; + owner?: string | null; /** * filter to match changes in pull requests. */ @@ -497,11 +497,11 @@ export namespace cloudbuild_v1 { /** * The type of hash that was performed. */ - type?: string; + type?: string | null; /** * The hash value. */ - value?: string; + value?: string | null; } /** * Response including listed builds. @@ -514,7 +514,7 @@ export namespace cloudbuild_v1 { /** * Token to receive the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response containing existing `BuildTriggers`. @@ -523,7 +523,7 @@ export namespace cloudbuild_v1 { /** * Token to receive the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * `BuildTriggers` for the project, sorted by `create_time` descending. */ @@ -536,7 +536,7 @@ export namespace cloudbuild_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -549,7 +549,7 @@ export namespace cloudbuild_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -557,15 +557,15 @@ export namespace cloudbuild_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * PullRequestFilter contains filter properties for matching GitHub Pull Requests. @@ -574,11 +574,11 @@ export namespace cloudbuild_v1 { /** * Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ - branch?: string; + branch?: string | null; /** * Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator. */ - commentControl?: string; + commentControl?: string | null; } /** * Push contains filter properties for matching GitHub git pushes. @@ -587,11 +587,11 @@ export namespace cloudbuild_v1 { /** * Regexes matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ - branch?: string; + branch?: string | null; /** * Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ - tag?: string; + tag?: string | null; } /** * Location of the source in a Google Cloud Source Repository. @@ -600,27 +600,27 @@ export namespace cloudbuild_v1 { /** * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ - branchName?: string; + branchName?: string | null; /** * Explicit commit SHA to build. */ - commitSha?: string; + commitSha?: string | null; /** * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. */ - dir?: string; + dir?: string | null; /** * ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. */ - projectId?: string; + projectId?: string | null; /** * Name of the Cloud Source Repository. If omitted, the name "default" is assumed. */ - repoName?: string; + repoName?: string | null; /** * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ - tagName?: string; + tagName?: string | null; } /** * Artifacts created by the build pipeline. @@ -629,7 +629,7 @@ export namespace cloudbuild_v1 { /** * Path to the artifact manifest. Only populated when artifacts are uploaded. */ - artifactManifest?: string; + artifactManifest?: string | null; /** * Time to push all non-container artifacts. */ @@ -637,11 +637,11 @@ export namespace cloudbuild_v1 { /** * List of build step digests, in the order corresponding to build step indices. */ - buildStepImages?: string[]; + buildStepImages?: string[] | null; /** * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. */ - buildStepOutputs?: string[]; + buildStepOutputs?: string[] | null; /** * Container images that were built as a part of the build. */ @@ -649,7 +649,7 @@ export namespace cloudbuild_v1 { /** * Number of artifacts uploaded. Only populated when artifacts are uploaded. */ - numArtifacts?: string; + numArtifacts?: string | null; } /** * Specifies a build to retry. @@ -662,11 +662,11 @@ export namespace cloudbuild_v1 { /** * Cloud KMS key name to use to decrypt these envs. */ - kmsKeyName?: string; + kmsKeyName?: string | null; /** * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. */ - secretEnv?: {[key: string]: string}; + secretEnv?: {[key: string]: string} | null; } /** * Location of the source in a supported storage service. @@ -688,7 +688,7 @@ export namespace cloudbuild_v1 { /** * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ - fileHashes?: {[key: string]: Schema$FileHashes}; + fileHashes?: {[key: string]: Schema$FileHashes} | null; /** * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. */ @@ -705,15 +705,15 @@ export namespace cloudbuild_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Location of the source in an archive file in Google Cloud Storage. @@ -722,15 +722,15 @@ export namespace cloudbuild_v1 { /** * Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ - bucket?: string; + bucket?: string | null; /** * Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. */ - generation?: string; + generation?: string | null; /** * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. */ - object?: string; + object?: string | null; } /** * Start and end times for a build execution phase. @@ -739,11 +739,11 @@ export namespace cloudbuild_v1 { /** * End of time span. */ - endTime?: string; + endTime?: string | null; /** * Start of time span. */ - startTime?: string; + startTime?: string | null; } /** * Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. @@ -752,11 +752,11 @@ export namespace cloudbuild_v1 { /** * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */ - name?: string; + name?: string | null; /** * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */ - path?: string; + path?: string | null; } export class Resource$Operations { diff --git a/src/apis/cloudbuild/v1alpha1.ts b/src/apis/cloudbuild/v1alpha1.ts index 8f41ff7b152..02cb09fcbce 100644 --- a/src/apis/cloudbuild/v1alpha1.ts +++ b/src/apis/cloudbuild/v1alpha1.ts @@ -124,11 +124,11 @@ export namespace cloudbuild_v1alpha1 { /** * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. */ - location?: string; + location?: string | null; /** * Path globs used to match files in the build's workspace. */ - paths?: string[]; + paths?: string[] | null; /** * Output only. Stores timing information for pushing all artifact objects. */ @@ -145,7 +145,7 @@ export namespace cloudbuild_v1alpha1 { /** * The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`. */ - location?: string; + location?: string | null; } /** * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. @@ -154,7 +154,7 @@ export namespace cloudbuild_v1alpha1 { /** * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ - images?: string[]; + images?: string[] | null; /** * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. */ @@ -171,31 +171,31 @@ export namespace cloudbuild_v1alpha1 { /** * Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. */ - buildTriggerId?: string; + buildTriggerId?: string | null; /** * Output only. Time at which the request to create the build was received. */ - createTime?: string; + createTime?: string | null; /** * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. */ - finishTime?: string; + finishTime?: string | null; /** * Output only. Unique identifier of the build. */ - id?: string; + id?: string | null; /** * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. */ - images?: string[]; + images?: string[] | null; /** * Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. */ - logsBucket?: string; + logsBucket?: string | null; /** * Output only. URL to logs for this build in Google Cloud Console. */ - logUrl?: string; + logUrl?: string | null; /** * Special options for this build. */ @@ -203,7 +203,7 @@ export namespace cloudbuild_v1alpha1 { /** * Output only. ID of the project. */ - projectId?: string; + projectId?: string | null; /** * Output only. Results of the build. */ @@ -223,15 +223,15 @@ export namespace cloudbuild_v1alpha1 { /** * Output only. Time at which execution of the build was started. */ - startTime?: string; + startTime?: string | null; /** * Output only. Status of the build. */ - status?: string; + status?: string | null; /** * Output only. Customer-readable message about the current status. */ - statusDetail?: string; + statusDetail?: string | null; /** * Required. The operations to be performed on the workspace. */ @@ -239,19 +239,19 @@ export namespace cloudbuild_v1alpha1 { /** * Substitutions data for `Build` resource. */ - substitutions?: {[key: string]: string}; + substitutions?: {[key: string]: string} | null; /** * Tags for annotation of a `Build`. These are not docker tags. */ - tags?: string[]; + tags?: string[] | null; /** * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes. */ - timeout?: string; + timeout?: string | null; /** * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. */ - timing?: {[key: string]: Schema$TimeSpan}; + timing?: {[key: string]: Schema$TimeSpan} | null; } /** * Metadata for build operations. @@ -269,39 +269,39 @@ export namespace cloudbuild_v1alpha1 { /** * Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ - env?: string[]; + env?: string[] | null; /** * Option to specify the logging mode, which determines where the logs are stored. */ - logging?: string; + logging?: string | null; /** * Option to define build log streaming behavior to Google Cloud Storage. */ - logStreamingOption?: string; + logStreamingOption?: string | null; /** * Compute Engine machine type on which to run the build. */ - machineType?: string; + machineType?: string | null; /** * Requested verifiability options. */ - requestedVerifyOption?: string; + requestedVerifyOption?: string | null; /** * A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. */ - secretEnv?: string[]; + secretEnv?: string[] | null; /** * Requested hash for SourceProvenance. */ - sourceProvenanceHash?: string[]; + sourceProvenanceHash?: string[] | null; /** * Option to specify behavior when there is an error in the substitution checks. */ - substitutionOption?: string; + substitutionOption?: string | null; /** * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. */ @@ -309,7 +309,7 @@ export namespace cloudbuild_v1alpha1 { /** * 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. */ - workerPool?: string; + workerPool?: string | null; } /** * A step in the build pipeline. @@ -318,27 +318,27 @@ export namespace cloudbuild_v1alpha1 { /** * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. */ - args?: string[]; + args?: string[] | null; /** * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. */ - dir?: string; + dir?: string | null; /** * Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. */ - entrypoint?: string; + entrypoint?: string | null; /** * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ - env?: string[]; + env?: string[] | null; /** * Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. */ - id?: string; + id?: string | null; /** * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. */ - name?: string; + name?: string | null; /** * Output only. Stores timing information for pulling this build step's builder image only. */ @@ -346,15 +346,15 @@ export namespace cloudbuild_v1alpha1 { /** * A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. */ - secretEnv?: string[]; + secretEnv?: string[] | null; /** * Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. */ - status?: string; + status?: string | null; /** * Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. */ - timeout?: string; + timeout?: string | null; /** * Output only. Stores timing information for executing this build step. */ @@ -366,7 +366,7 @@ export namespace cloudbuild_v1alpha1 { /** * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. */ - waitFor?: string[]; + waitFor?: string[] | null; } /** * An image built by the pipeline. @@ -375,11 +375,11 @@ export namespace cloudbuild_v1alpha1 { /** * Docker Registry 2.0 digest. */ - digest?: string; + digest?: string | null; /** * Name used to push the container image to Google Container Registry, as presented to `docker push`. */ - name?: string; + name?: string | null; /** * Output only. Stores timing information for pushing the specified image. */ @@ -405,11 +405,11 @@ export namespace cloudbuild_v1alpha1 { /** * The type of hash that was performed. */ - type?: string; + type?: string | null; /** * The hash value. */ - value?: string; + value?: string | null; } /** * Response containing existing `WorkerPools`. @@ -427,15 +427,15 @@ export namespace cloudbuild_v1alpha1 { /** * Network on which the workers are created. "default" network is used if empty. */ - network?: string; + network?: string | null; /** * Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. */ - projectId?: string; + projectId?: string | null; /** * Subnetwork on which the workers are created. "default" subnetwork is used if empty. */ - subnetwork?: string; + subnetwork?: string | null; } /** * Location of the source in a Google Cloud Source Repository. @@ -444,27 +444,27 @@ export namespace cloudbuild_v1alpha1 { /** * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ - branchName?: string; + branchName?: string | null; /** * Explicit commit SHA to build. */ - commitSha?: string; + commitSha?: string | null; /** * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. */ - dir?: string; + dir?: string | null; /** * ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. */ - projectId?: string; + projectId?: string | null; /** * Name of the Cloud Source Repository. If omitted, the name "default" is assumed. */ - repoName?: string; + repoName?: string | null; /** * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ - tagName?: string; + tagName?: string | null; } /** * Artifacts created by the build pipeline. @@ -473,7 +473,7 @@ export namespace cloudbuild_v1alpha1 { /** * Path to the artifact manifest. Only populated when artifacts are uploaded. */ - artifactManifest?: string; + artifactManifest?: string | null; /** * Time to push all non-container artifacts. */ @@ -481,11 +481,11 @@ export namespace cloudbuild_v1alpha1 { /** * List of build step digests, in the order corresponding to build step indices. */ - buildStepImages?: string[]; + buildStepImages?: string[] | null; /** * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. */ - buildStepOutputs?: string[]; + buildStepOutputs?: string[] | null; /** * Container images that were built as a part of the build. */ @@ -493,7 +493,7 @@ export namespace cloudbuild_v1alpha1 { /** * Number of artifacts uploaded. Only populated when artifacts are uploaded. */ - numArtifacts?: string; + numArtifacts?: string | null; } /** * Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. @@ -502,11 +502,11 @@ export namespace cloudbuild_v1alpha1 { /** * Cloud KMS key name to use to decrypt these envs. */ - kmsKeyName?: string; + kmsKeyName?: string | null; /** * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. */ - secretEnv?: {[key: string]: string}; + secretEnv?: {[key: string]: string} | null; } /** * Location of the source in a supported storage service. @@ -528,7 +528,7 @@ export namespace cloudbuild_v1alpha1 { /** * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ - fileHashes?: {[key: string]: Schema$FileHashes}; + fileHashes?: {[key: string]: Schema$FileHashes} | null; /** * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. */ @@ -545,15 +545,15 @@ export namespace cloudbuild_v1alpha1 { /** * Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ - bucket?: string; + bucket?: string | null; /** * Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. */ - generation?: string; + generation?: string | null; /** * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. */ - object?: string; + object?: string | null; } /** * Start and end times for a build execution phase. @@ -562,11 +562,11 @@ export namespace cloudbuild_v1alpha1 { /** * End of time span. */ - endTime?: string; + endTime?: string | null; /** * Start of time span. */ - startTime?: string; + startTime?: string | null; } /** * Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. @@ -575,11 +575,11 @@ export namespace cloudbuild_v1alpha1 { /** * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */ - name?: string; + name?: string | null; /** * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */ - path?: string; + path?: string | null; } /** * WorkerConfig defines the configuration to be used for a creating workers in the pool. @@ -588,11 +588,11 @@ export namespace cloudbuild_v1alpha1 { /** * Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes */ - machineType?: string; + machineType?: string | null; /** * The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. */ @@ -600,7 +600,7 @@ export namespace cloudbuild_v1alpha1 { /** * The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. */ - tag?: string; + tag?: string | null; } /** * Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool. @@ -609,35 +609,35 @@ export namespace cloudbuild_v1alpha1 { /** * Output only. Time at which the request to create the `WorkerPool` was received. */ - createTime?: string; + createTime?: string | null; /** * Output only. Time at which the request to delete the `WorkerPool` was received. */ - deleteTime?: string; + deleteTime?: string | null; /** * User-defined name of the `WorkerPool`. */ - name?: string; + name?: string | null; /** * The project ID of the GCP project for which the `WorkerPool` is created. */ - projectId?: string; + projectId?: string | null; /** * List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region. */ - regions?: string[]; + regions?: string[] | null; /** * Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; /** * Output only. WorkerPool Status. */ - status?: string; + status?: string | null; /** * Output only. Time at which the request to update the `WorkerPool` was received. */ - updateTime?: string; + updateTime?: string | null; /** * Configuration to be used for a creating workers in the `WorkerPool`. */ @@ -645,7 +645,7 @@ export namespace cloudbuild_v1alpha1 { /** * Total number of workers to be created across all requested regions. */ - workerCount?: string; + workerCount?: string | null; } export class Resource$Projects { diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index a4ba6ee9c67..5f944c4a3ed 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -126,11 +126,11 @@ export namespace clouddebugger_v2 { /** * The alias kind. */ - kind?: string; + kind?: string | null; /** * The alias name. */ - name?: string; + name?: string | null; } /** * Represents the breakpoint specification, status and results. @@ -139,15 +139,15 @@ export namespace clouddebugger_v2 { /** * Action that the agent should perform when the code at the breakpoint location is hit. */ - action?: string; + action?: string | null; /** * Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. */ - condition?: string; + condition?: string | null; /** * Time this breakpoint was created by the server in seconds resolution. */ - createTime?: string; + createTime?: string | null; /** * Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text. */ @@ -155,23 +155,23 @@ export namespace clouddebugger_v2 { /** * List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements. */ - expressions?: string[]; + expressions?: string[] | null; /** * Time this breakpoint was finalized as seen by the server in seconds resolution. */ - finalTime?: string; + finalTime?: string | null; /** * Breakpoint identifier, unique in the scope of the debuggee. */ - id?: string; + id?: string | null; /** * When true, indicates that this is a final result and the breakpoint state will not change from here on. */ - isFinalState?: boolean; + isFinalState?: boolean | null; /** * A set of custom breakpoint properties, populated by the agent, to be displayed to the user. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Breakpoint source location. */ @@ -179,11 +179,11 @@ export namespace clouddebugger_v2 { /** * Indicates the severity of the log. Only relevant when action is `LOG`. */ - logLevel?: string; + logLevel?: string | null; /** * Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`. */ - logMessageFormat?: string; + logMessageFormat?: string | null; /** * The stack at breakpoint time, where stack_frames[0] represents the most recently entered function. */ @@ -195,7 +195,7 @@ export namespace clouddebugger_v2 { /** * E-mail address of the user that created this breakpoint */ - userEmail?: string; + userEmail?: string | null; /** * The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable. */ @@ -212,7 +212,7 @@ export namespace clouddebugger_v2 { /** * The name of an alias (branch, tag, etc.). */ - aliasName?: string; + aliasName?: string | null; /** * The ID of the repo. */ @@ -220,7 +220,7 @@ export namespace clouddebugger_v2 { /** * A revision ID. */ - revisionId?: string; + revisionId?: string | null; } /** * A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. @@ -229,7 +229,7 @@ export namespace clouddebugger_v2 { /** * The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. */ - name?: string; + name?: string | null; /** * The ID of the repo containing the workspace. */ @@ -242,7 +242,7 @@ export namespace clouddebugger_v2 { /** * The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. */ - snapshotId?: string; + snapshotId?: string | null; /** * The ID of the workspace. */ @@ -255,11 +255,11 @@ export namespace clouddebugger_v2 { /** * Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`). */ - agentVersion?: string; + agentVersion?: string | null; /** * Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. */ - description?: string; + description?: string | null; /** * References to the locations and revisions of the source code used in the deployed application. */ @@ -267,23 +267,23 @@ export namespace clouddebugger_v2 { /** * Unique identifier for the debuggee generated by the controller service. */ - id?: string; + id?: string | null; /** * If set to `true`, indicates that the agent should disable itself and detach from the debuggee. */ - isDisabled?: boolean; + isDisabled?: boolean | null; /** * If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. */ - isInactive?: boolean; + isInactive?: boolean | null; /** * A set of custom debuggee properties, populated by the agent, to be displayed to the user. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project. */ - project?: string; + project?: string | null; /** * References to the locations and revisions of the source code used in the deployed application. */ @@ -295,7 +295,7 @@ export namespace clouddebugger_v2 { /** * Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment. */ - uniquifier?: string; + uniquifier?: 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 `{}`. @@ -312,7 +312,7 @@ export namespace clouddebugger_v2 { /** * Labels with user defined metadata. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } /** * Represents a message with parameters. @@ -321,11 +321,11 @@ export namespace clouddebugger_v2 { /** * Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` */ - format?: string; + format?: string | null; /** * Optional parameters to be embedded into the message. */ - parameters?: string[]; + parameters?: string[] | null; } /** * A SourceContext referring to a Gerrit project. @@ -338,19 +338,19 @@ export namespace clouddebugger_v2 { /** * The name of an alias (branch, tag, etc.). */ - aliasName?: string; + aliasName?: string | null; /** * The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. */ - gerritProject?: string; + gerritProject?: string | null; /** * The URI of a running Gerrit instance. */ - hostUri?: string; + hostUri?: string | null; /** * A revision (commit) ID. */ - revisionId?: string; + revisionId?: string | null; } /** * Response for getting breakpoint information. @@ -368,11 +368,11 @@ export namespace clouddebugger_v2 { /** * Git commit hash. required. */ - revisionId?: string; + revisionId?: string | null; /** * Git repository URL. */ - url?: string; + url?: string | null; } /** * Response for listing active breakpoints. @@ -385,11 +385,11 @@ export namespace clouddebugger_v2 { /** * A token that can be used in the next method call to block until the list of breakpoints changes. */ - nextWaitToken?: string; + nextWaitToken?: string | null; /** * If set to `true`, indicates that there is no change to the list of active breakpoints and the server-selected timeout has expired. The `breakpoints` field would be empty and should be ignored. */ - waitExpired?: boolean; + waitExpired?: boolean | null; } /** * Response for listing breakpoints. @@ -402,7 +402,7 @@ export namespace clouddebugger_v2 { /** * A wait token that can be used in the next call to `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakpoints has changes. */ - nextWaitToken?: string; + nextWaitToken?: string | null; } /** * Response for listing debuggees. @@ -420,11 +420,11 @@ export namespace clouddebugger_v2 { /** * The ID of the project. */ - projectId?: string; + projectId?: string | null; /** * The name of the repo. Leave empty for the default repo. */ - repoName?: string; + repoName?: string | null; } /** * Request to register a debuggee. @@ -455,7 +455,7 @@ export namespace clouddebugger_v2 { /** * A server-assigned, globally unique identifier. */ - uid?: string; + uid?: string | null; } /** * Response for setting a breakpoint. @@ -494,15 +494,15 @@ export namespace clouddebugger_v2 { /** * Column within a line. The first column in a line as the value `1`. Agents that do not support setting breakpoints on specific columns ignore this field. */ - column?: number; + column?: number | null; /** * Line inside the file. The first line in the file has the value `1`. */ - line?: number; + line?: number | null; /** * Path to the source file within the source context of the target binary. */ - path?: string; + path?: string | null; } /** * Represents a stack frame context. @@ -515,7 +515,7 @@ export namespace clouddebugger_v2 { /** * Demangled function name at the call site. */ - function?: string; + function?: string | null; /** * Set of local variables at the stack frame location. Note that this might not be populated for all stack frames. */ @@ -536,11 +536,11 @@ export namespace clouddebugger_v2 { /** * Distinguishes errors from informational messages. */ - isError?: boolean; + isError?: boolean | null; /** * Reference to which the message applies. */ - refersTo?: string; + refersTo?: string | null; } /** * Request to update an active breakpoint. @@ -566,7 +566,7 @@ export namespace clouddebugger_v2 { /** * Name of the variable, if any. */ - name?: string; + name?: string | null; /** * Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` */ @@ -574,15 +574,15 @@ export namespace clouddebugger_v2 { /** * Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. */ - type?: string; + type?: string | null; /** * Simple value of the variable. */ - value?: string; + value?: string | null; /** * Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. */ - varTableIndex?: number; + varTableIndex?: number | null; } export class Resource$Controller { diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index b4b45b8c161..ede6e1dad94 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -140,7 +140,7 @@ export namespace clouderrorreporting_v1beta1 { /** * The user who caused or was affected by the crash. This can be a user ID, an email address, or an arbitrary token that uniquely identifies the user. When sending an error report, leave this field empty if the user was not logged in. In this case the Error Reporting system will use other data, such as remote IP address, to distinguish affected users. See `affected_users_count` in `ErrorGroupStats`. */ - user?: string; + user?: string | null; } /** * An error event which is returned by the Error Reporting system. @@ -153,11 +153,11 @@ export namespace clouderrorreporting_v1beta1 { /** * Time when the event occurred as provided in the error report. If the report did not contain a timestamp, the time the error was received by the Error Reporting system is used. */ - eventTime?: string; + eventTime?: string | null; /** * The stack trace that was reported or logged by the service. */ - message?: string; + message?: string | null; /** * The `ServiceContext` for which this error was reported. */ @@ -170,11 +170,11 @@ export namespace clouderrorreporting_v1beta1 { /** * Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID. */ - groupId?: string; + groupId?: string | null; /** * The group resource name. Example: <code>projects/my-project-123/groups/my-groupid</code> */ - name?: string; + name?: string | null; /** * Associated tracking issues. */ @@ -191,15 +191,15 @@ export namespace clouderrorreporting_v1beta1 { /** * Approximate number of affected users in the given group that match the filter criteria. Users are distinguished by data in the `ErrorContext` of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here. */ - affectedUsersCount?: string; + affectedUsersCount?: string | null; /** * Approximate total number of events in the given group that match the filter criteria. */ - count?: string; + count?: string | null; /** * Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. */ - firstSeenTime?: string; + firstSeenTime?: string | null; /** * Group data that is independent of the filter criteria. */ @@ -207,11 +207,11 @@ export namespace clouderrorreporting_v1beta1 { /** * Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. */ - lastSeenTime?: string; + lastSeenTime?: string | null; /** * The total number of services with a non-zero error count for the given filter criteria. */ - numAffectedServices?: number; + numAffectedServices?: number | null; /** * An arbitrary event that is chosen as representative for the whole group. The representative event is intended to be used as a quick preview for the whole group. Events in the group are usually sufficiently similar to each other such that showing an arbitrary representative provides insight into the characteristics of the group as a whole. */ @@ -228,27 +228,27 @@ export namespace clouderrorreporting_v1beta1 { /** * The type of HTTP request, such as `GET`, `POST`, etc. */ - method?: string; + method?: string | null; /** * The referrer information that is provided with the request. */ - referrer?: string; + referrer?: string | null; /** * The IP address from which the request originated. This can be IPv4, IPv6, or a token which is derived from the IP address, depending on the data that has been provided in the error report. */ - remoteIp?: string; + remoteIp?: string | null; /** * The HTTP response status code for the request. */ - responseStatusCode?: number; + responseStatusCode?: number | null; /** * The URL of the request. */ - url?: string; + url?: string | null; /** * The user agent information that is provided with the request. */ - userAgent?: string; + userAgent?: string | null; } /** * Contains a set of requested error events. @@ -261,11 +261,11 @@ export namespace clouderrorreporting_v1beta1 { /** * If non-empty, more results are available. Pass this token, along with the same query parameters as the first request, to view the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The timestamp specifies the start time to which the request was restricted. */ - timeRangeBegin?: string; + timeRangeBegin?: string | null; } /** * Contains a set of requested error group stats. @@ -278,11 +278,11 @@ export namespace clouderrorreporting_v1beta1 { /** * If non-empty, more results are available. Pass this token, along with the same query parameters as the first request, to view the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The timestamp specifies the start time to which the request was restricted. The start time is set based on the requested time range. It may be adjusted to a later time if a project has exceeded the storage quota and older data has been deleted. */ - timeRangeBegin?: string; + timeRangeBegin?: string | null; } /** * An error event which is reported to the Error Reporting system. @@ -295,11 +295,11 @@ export namespace clouderrorreporting_v1beta1 { /** * [Optional] Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system will be used. */ - eventTime?: string; + eventTime?: string | null; /** * [Required] The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` and contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). */ - message?: string; + message?: string | null; /** * [Required] The service context in which this error has occurred. */ @@ -316,15 +316,15 @@ export namespace clouderrorreporting_v1beta1 { /** * Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors. */ - resourceType?: string; + resourceType?: string | null; /** * An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to `version`, which can be changed whenever new code is deployed. Contains the service name for error reports extracted from Google App Engine logs or `default` if the App Engine default service is used. */ - service?: string; + service?: string | null; /** * Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app. */ - version?: string; + version?: string | null; } /** * Indicates a location in the source code of the service for which errors are reported. `functionName` must be provided by the application when reporting an error, unless the error report contains a `message` with a supported exception stack trace. All fields are optional for the later case. @@ -333,15 +333,15 @@ export namespace clouderrorreporting_v1beta1 { /** * The source code filename, which can include a truncated relative path, or a full path from a production machine. */ - filePath?: string; + filePath?: string | null; /** * Human-readable name of a function or method. The value can include optional context like the class or package name. For example, `my.package.MyClass.method` in case of Java. */ - functionName?: string; + functionName?: string | null; /** * 1-based. 0 indicates that the line number is unknown. */ - lineNumber?: number; + lineNumber?: number | null; } /** * A reference to a particular snapshot of the source tree used to build and deploy an application. @@ -350,11 +350,11 @@ export namespace clouderrorreporting_v1beta1 { /** * Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" */ - repository?: string; + repository?: string | null; /** * The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" */ - revisionId?: string; + revisionId?: string | null; } /** * The number of errors in a given time period. All numbers are approximate since the error events are sampled before counting them. @@ -363,15 +363,15 @@ export namespace clouderrorreporting_v1beta1 { /** * Approximate number of occurrences in the given time period. */ - count?: string; + count?: string | null; /** * End of the time period to which `count` refers (excluded). */ - endTime?: string; + endTime?: string | null; /** * Start of the time period to which `count` refers (included). */ - startTime?: string; + startTime?: string | null; } /** * Information related to tracking the progress on resolving the error. @@ -380,7 +380,7 @@ export namespace clouderrorreporting_v1beta1 { /** * A URL pointing to a related entry in an issue tracking system. Example: https://github.com/user/project/issues/4 */ - url?: string; + url?: string | null; } export class Resource$Projects { diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 68cac8cccb5..f990168d1cb 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -130,7 +130,7 @@ export namespace cloudfunctions_v1 { /** * 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; + 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. @@ -139,11 +139,11 @@ export namespace cloudfunctions_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -156,11 +156,11 @@ export namespace cloudfunctions_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Request for the `CallFunction` method. @@ -169,7 +169,7 @@ export namespace cloudfunctions_v1 { /** * Input to be passed to the function. */ - data?: string; + data?: string | null; } /** * Response of `CallFunction` method. @@ -178,15 +178,15 @@ export namespace cloudfunctions_v1 { /** * Either system or user-function generated error. Set if execution was not successful. */ - error?: string; + error?: string | null; /** * Execution id of function invocation. */ - executionId?: string; + executionId?: string | null; /** * Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context. */ - result?: string; + result?: string | null; } /** * Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. @@ -195,19 +195,19 @@ export namespace cloudfunctions_v1 { /** * The amount of memory in MB available for a function. Defaults to 256MB. */ - availableMemoryMb?: number; + availableMemoryMb?: number | null; /** * User-provided description of a function. */ - description?: string; + description?: string | null; /** * The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`. */ - entryPoint?: string; + entryPoint?: string | null; /** * Environment variables that shall be available during function execution. */ - environmentVariables?: {[key: string]: string}; + environmentVariables?: {[key: string]: string} | null; /** * A source that fires events in response to a condition in another service. */ @@ -219,31 +219,31 @@ export namespace cloudfunctions_v1 { /** * Labels associated with this Cloud Function. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The limit on the maximum number of function instances that may coexist at a given time. */ - maxInstances?: number; + maxInstances?: number | null; /** * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x */ - name?: string; + name?: string | null; /** * The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ - network?: string; + network?: string | null; /** * The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](/sdk/gcloud/reference/functions/deploy#--runtime). */ - runtime?: string; + runtime?: string | null; /** * The email of the function's service account. If empty, defaults to `{project_id}@appspot.gserviceaccount.com`. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; /** * The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. */ - sourceArchiveUrl?: string; + sourceArchiveUrl?: string | null; /** * **Beta Feature** The source repository where a function is hosted. */ @@ -251,27 +251,27 @@ export namespace cloudfunctions_v1 { /** * The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl */ - sourceUploadUrl?: string; + sourceUploadUrl?: string | null; /** * Output only. Status of the function deployment. */ - status?: string; + status?: string | null; /** * The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. */ - timeout?: string; + timeout?: string | null; /** * Output only. The last update timestamp of a Cloud Function. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. */ - versionId?: string; + versionId?: string | null; /** * The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/x/locations/x/connectors/x This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ - vpcConnector?: string; + vpcConnector?: string | null; } /** * Describes EventTrigger, used to request events be sent from another service. @@ -280,7 +280,7 @@ export namespace cloudfunctions_v1 { /** * Required. The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`. Event types match pattern `providers/x/eventTypes/*.*`. The pattern contains: 1. namespace: For example, `cloud.storage` and `google.firebase.analytics`. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type `object`. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. */ - eventType?: string; + eventType?: string | null; /** * Specifies policy for failed executions. */ @@ -288,11 +288,11 @@ export namespace cloudfunctions_v1 { /** * Required. The resource(s) from which to observe events, for example, `projects/_/buckets/myBucket`. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the `CloudFunction`. 2. The resource type must match the pattern expected for an `event_type`. For example, an `EventTrigger` that has an `event_type` of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an `EventTrigger`. These will always be returned in the normalized "long" format. See each *service's* documentation for supported formats. */ - resource?: string; + resource?: string | null; /** * The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, `storage.googleapis.com` is the default for all event types in the `google.storage` namespace. */ - service?: string; + service?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -301,19 +301,19 @@ export namespace cloudfunctions_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them). @@ -331,7 +331,7 @@ export namespace cloudfunctions_v1 { /** * The optional version of function. If not set, default, current version is used. */ - versionId?: string; + versionId?: string | null; } /** * Response of `GenerateDownloadUrl` method. @@ -340,7 +340,7 @@ export namespace cloudfunctions_v1 { /** * The generated Google Cloud Storage signed URL that should be used for function source code download. */ - downloadUrl?: string; + downloadUrl?: string | null; } /** * Request of `GenerateSourceUploadUrl` method. @@ -353,7 +353,7 @@ export namespace cloudfunctions_v1 { /** * The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function. */ - uploadUrl?: string; + uploadUrl?: string | null; } /** * Describes HttpsTrigger, could be used to connect web hooks to function. @@ -362,7 +362,7 @@ export namespace cloudfunctions_v1 { /** * Output only. The deployed url for the function. */ - url?: string; + url?: string | null; } /** * Response for the `ListFunctions` method. @@ -375,7 +375,7 @@ export namespace cloudfunctions_v1 { /** * If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1.ListFunctionsRequest to get more functions. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -388,7 +388,7 @@ export namespace cloudfunctions_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -397,7 +397,7 @@ export namespace cloudfunctions_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -410,23 +410,23 @@ export namespace cloudfunctions_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -435,7 +435,7 @@ export namespace cloudfunctions_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -443,15 +443,15 @@ export namespace cloudfunctions_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Metadata describing an Operation @@ -460,23 +460,23 @@ export namespace cloudfunctions_v1 { /** * The original request that started the operation. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ - target?: string; + target?: string | null; /** * Type of operation. */ - type?: string; + type?: string | null; /** * The last update timestamp of the operation. */ - updateTime?: string; + updateTime?: string | null; /** * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ - versionId?: string; + versionId?: string | null; } /** * Metadata describing an Operation @@ -485,23 +485,23 @@ export namespace cloudfunctions_v1 { /** * The original request that started the operation. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ - target?: string; + target?: string | null; /** * Type of operation. */ - type?: string; + type?: string | null; /** * The last update timestamp of the operation. */ - updateTime?: string; + updateTime?: string | null; /** * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ - versionId?: string; + versionId?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -518,11 +518,11 @@ export namespace cloudfunctions_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution. @@ -539,7 +539,7 @@ export namespace cloudfunctions_v1 { /** * 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; + updateMask?: string | null; } /** * Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. @@ -548,11 +548,11 @@ export namespace cloudfunctions_v1 { /** * Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. */ - deployedUrl?: string; + deployedUrl?: string | null; /** * The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x To refer to a moveable alias (branch): `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x You may omit `paths/x if you want to use the main directory. */ - url?: string; + url?: 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). @@ -561,15 +561,15 @@ export namespace cloudfunctions_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -578,7 +578,7 @@ export namespace cloudfunctions_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -587,7 +587,7 @@ export namespace cloudfunctions_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$Operations { diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index 083c2c83cf1..36f5db37b97 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -126,7 +126,7 @@ export namespace cloudfunctions_v1beta2 { /** * Input to be passed to the function. */ - data?: string; + data?: string | null; } /** * Response of `CallFunction` method. @@ -135,15 +135,15 @@ export namespace cloudfunctions_v1beta2 { /** * Either system or user-function generated error. Set if execution was not successful. */ - error?: string; + error?: string | null; /** * Execution id of function invocation. */ - executionId?: string; + executionId?: string | null; /** * Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context. */ - result?: string; + result?: string | null; } /** * Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. @@ -152,15 +152,15 @@ export namespace cloudfunctions_v1beta2 { /** * The amount of memory in MB available for a function. Defaults to 256MB. */ - availableMemoryMb?: number; + availableMemoryMb?: number | null; /** * The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`. */ - entryPoint?: string; + entryPoint?: string | null; /** * Environment variables that shall be available during function execution. */ - environmentVariables?: {[key: string]: string}; + environmentVariables?: {[key: string]: string} | null; /** * A source that fires events in response to a condition in another service. */ @@ -172,35 +172,35 @@ export namespace cloudfunctions_v1beta2 { /** * Labels associated with this Cloud Function. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. Name of the most recent operation modifying the function. If the function status is `DEPLOYING` or `DELETING`, then it points to the active operation. */ - latestOperation?: string; + latestOperation?: string | null; /** * The limit on the maximum number of function instances that may coexist at a given time. */ - maxInstances?: number; + maxInstances?: number | null; /** * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x */ - name?: string; + name?: string | null; /** * The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ - network?: string; + network?: string | null; /** * The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](/sdk/gcloud/reference/functions/deploy#--runtime). */ - runtime?: string; + runtime?: string | null; /** * The email of the function's service account. If empty, defaults to `{project_id}@appspot.gserviceaccount.com`. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. */ - sourceArchiveUrl?: string; + sourceArchiveUrl?: string | null; /** * The hosted repository where the function is defined. */ @@ -208,31 +208,31 @@ export namespace cloudfunctions_v1beta2 { /** * The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x To refer to a moveable alias (branch): `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x You may omit `paths/x if you want to use the main directory. */ - sourceRepositoryUrl?: string; + sourceRepositoryUrl?: string | null; /** * The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1beta2.GenerateUploadUrl */ - sourceUploadUrl?: string; + sourceUploadUrl?: string | null; /** * Output only. Status of the function deployment. */ - status?: string; + status?: string | null; /** * The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. */ - timeout?: string; + timeout?: string | null; /** * Output only. The last update timestamp of a Cloud Function. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. */ - versionId?: string; + versionId?: string | null; /** * The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/x/locations/x/connectors/x This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ - vpcConnector?: string; + vpcConnector?: string | null; } /** * Describes EventTrigger, used to request events be sent from another service. @@ -241,7 +241,7 @@ export namespace cloudfunctions_v1beta2 { /** * `event_type` names contain the service that is sending an event and the kind of event that was fired. Must be of the form `providers/x/eventTypes/x e.g. Directly handle a Message published to Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. Handle an object changing in Google Cloud Storage: `providers/cloud.storage/eventTypes/object.change` Handle a write to the Firebase Realtime Database: `providers/google.firebase.database/eventTypes/ref.write` */ - eventType?: string; + eventType?: string | null; /** * Specifies policy for failed executions. */ @@ -249,11 +249,11 @@ export namespace cloudfunctions_v1beta2 { /** * Which instance of the source's service should send events. E.g. for Pub/Sub this would be a Pub/Sub topic at `projects/x/topics/x. For Google Cloud Storage this would be a bucket at `projects/x/buckets/x. For any source that only supports one instance per-project, this should be the name of the project (`projects/x) */ - resource?: string; + resource?: string | null; /** * The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, `storage.googleapis.com` is the default for all event types in the `google.storage` namespace. */ - service?: string; + service?: string | null; } /** * Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them). @@ -271,7 +271,7 @@ export namespace cloudfunctions_v1beta2 { /** * The optional version of function. */ - versionId?: string; + versionId?: string | null; } /** * Response of `GenerateDownloadUrl` method. @@ -280,7 +280,7 @@ export namespace cloudfunctions_v1beta2 { /** * The generated Google Cloud Storage signed URL that should be used for function source code download. */ - downloadUrl?: string; + downloadUrl?: string | null; } /** * Request of `GenerateUploadUrl` method. @@ -293,7 +293,7 @@ export namespace cloudfunctions_v1beta2 { /** * The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function. */ - uploadUrl?: string; + uploadUrl?: string | null; } /** * Describes HTTPSTrigger, could be used to connect web hooks to function. @@ -302,7 +302,7 @@ export namespace cloudfunctions_v1beta2 { /** * Output only. The deployed url for the function. */ - url?: string; + url?: string | null; } /** * Response for the `ListFunctions` method. @@ -315,7 +315,7 @@ export namespace cloudfunctions_v1beta2 { /** * If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1beta2.ListFunctionsRequest to get more functions. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -328,7 +328,7 @@ export namespace cloudfunctions_v1beta2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -337,7 +337,7 @@ export namespace cloudfunctions_v1beta2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -350,23 +350,23 @@ export namespace cloudfunctions_v1beta2 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -375,7 +375,7 @@ export namespace cloudfunctions_v1beta2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -383,15 +383,15 @@ export namespace cloudfunctions_v1beta2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Metadata describing an Operation @@ -400,23 +400,23 @@ export namespace cloudfunctions_v1beta2 { /** * The original request that started the operation. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ - target?: string; + target?: string | null; /** * Type of operation. */ - type?: string; + type?: string | null; /** * The last update timestamp of the operation. */ - updateTime?: string; + updateTime?: string | null; /** * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ - versionId?: string; + versionId?: string | null; } /** * Metadata describing an Operation @@ -425,23 +425,23 @@ export namespace cloudfunctions_v1beta2 { /** * The original request that started the operation. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ - target?: string; + target?: string | null; /** * Type of operation. */ - type?: string; + type?: string | null; /** * The last update timestamp of the operation. */ - updateTime?: string; + updateTime?: string | null; /** * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ - versionId?: string; + versionId?: string | null; } /** * Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution. @@ -454,27 +454,27 @@ export namespace cloudfunctions_v1beta2 { /** * The name of the branch from which the function should be fetched. */ - branch?: string; + branch?: string | null; /** * Output only. The id of the revision that was resolved at the moment of function creation or update. For example when a user deployed from a branch, it will be the revision id of the latest change on this branch at that time. If user deployed from revision then this value will be always equal to the revision specified by the user. */ - deployedRevision?: string; + deployedRevision?: string | null; /** * URL to the hosted repository where the function is defined. Only paths in https://source.developers.google.com domain are supported. The path should contain the name of the repository. */ - repositoryUrl?: string; + repositoryUrl?: string | null; /** * The id of the revision that captures the state of the repository from which the function should be fetched. */ - revision?: string; + revision?: string | null; /** * The path within the repository where the function is defined. The path should point to the directory where Cloud Functions files are located. Use "/" if the function is defined directly in the root directory of a repository. */ - sourcePath?: string; + sourcePath?: string | null; /** * The name of the tag that captures the state of the repository from which the function should be fetched. */ - tag?: string; + tag?: 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). @@ -483,15 +483,15 @@ export namespace cloudfunctions_v1beta2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Operations { diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 6e4c0bbfb81..2db1f957774 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -124,11 +124,11 @@ export namespace cloudidentity_v1 { /** * The ID of the entity within the given namespace. The ID must be unique within its namespace. */ - id?: string; + id?: string | null; /** * Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. */ - namespace?: string; + namespace?: string | null; } /** * Resource representing a Group. @@ -137,15 +137,15 @@ export namespace cloudidentity_v1 { /** * The time when the Group was created. Output only. */ - createTime?: string; + 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. */ - description?: string; + description?: string | null; /** * The Group's display name. */ - displayName?: string; + displayName?: string | null; /** * EntityKey of the Group. Must be set when creating a Group, read-only afterwards. */ @@ -153,19 +153,19 @@ export namespace cloudidentity_v1 { /** * `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group. */ - name?: string; + name?: string | null; /** * The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`. */ - parent?: string; + parent?: string | null; /** * The time when the Group was last updated. Output only. */ - updateTime?: string; + updateTime?: string | null; } /** * Response message for ListGroups operation. @@ -178,7 +178,7 @@ export namespace cloudidentity_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results available for listing. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListMembershipsResponse { /** @@ -188,19 +188,19 @@ export namespace cloudidentity_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results available for listing. */ - nextPageToken?: string; + nextPageToken?: string | null; } 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. */ - name?: string; + name?: string | null; } 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. */ - name?: string; + name?: string | null; } /** * Resource representing a Membership within a Group @@ -209,11 +209,11 @@ export namespace cloudidentity_v1 { /** * Creation timestamp of the Membership. Output only. */ - createTime?: string; + createTime?: string | null; /** * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership. */ - name?: string; + name?: string | null; /** * EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. */ @@ -225,7 +225,7 @@ export namespace cloudidentity_v1 { /** * Last updated timestamp of the Membership. Output only. */ - updateTime?: string; + updateTime?: string | null; } /** * Resource representing a role within a Membership. @@ -234,7 +234,7 @@ export namespace cloudidentity_v1 { /** * MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER"`. */ - name?: string; + name?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -243,7 +243,7 @@ export namespace cloudidentity_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -251,15 +251,15 @@ export namespace cloudidentity_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } export interface Schema$SearchGroupsResponse { /** @@ -269,7 +269,7 @@ export namespace cloudidentity_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results available for specified query. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -278,15 +278,15 @@ export namespace cloudidentity_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Groups { diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 507638f91fa..b99dc9bd4fc 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -124,11 +124,11 @@ export namespace cloudidentity_v1beta1 { /** * The id of the entity within the given namespace. The id must be unique within its namespace. */ - id?: string; + 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`. */ - namespace?: string; + namespace?: string | null; } /** * Resource representing a Group @@ -141,15 +141,15 @@ export namespace cloudidentity_v1beta1 { /** * The time when the Group was created. Output only */ - createTime?: string; + 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. */ - description?: string; + description?: string | null; /** * The Group's display name. */ - displayName?: string; + displayName?: string | null; /** * EntityKey of the Group. Must be set when creating a Group, read-only afterwards. */ @@ -157,19 +157,19 @@ export namespace cloudidentity_v1beta1 { /** * Labels for Group resource. Required. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group */ - name?: string; + name?: string | null; /** * The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: 'identitysources'. */ - parent?: string; + parent?: string | null; /** * The time when the Group was last updated. Output only */ - updateTime?: string; + updateTime?: string | null; } export interface Schema$ListMembershipsResponse { /** @@ -179,19 +179,19 @@ export namespace cloudidentity_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results available for listing. */ - nextPageToken?: string; + nextPageToken?: string | null; } 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. */ - name?: string; + name?: string | null; } 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. */ - name?: string; + name?: string | null; } /** * Resource representing a Membership within a Group @@ -200,7 +200,7 @@ export namespace cloudidentity_v1beta1 { /** * Creation timestamp of the Membership. */ - createTime?: string; + createTime?: string | null; /** * EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. */ @@ -208,7 +208,7 @@ export namespace cloudidentity_v1beta1 { /** * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique id assigned to the member Must be left blank while creating a Membership. */ - name?: string; + name?: string | null; /** * Roles for a member within the Group. Currently supported MembershipRoles: `"MEMBER"`. */ @@ -216,7 +216,7 @@ export namespace cloudidentity_v1beta1 { /** * Last updated timestamp of the Membership. */ - updateTime?: string; + updateTime?: string | null; } /** * Resource representing a role within a Membership. @@ -225,7 +225,7 @@ export namespace cloudidentity_v1beta1 { /** * MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER"`. */ - name?: string; + name?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -234,7 +234,7 @@ export namespace cloudidentity_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -242,15 +242,15 @@ export namespace cloudidentity_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } export interface Schema$SearchGroupsResponse { /** @@ -260,7 +260,7 @@ export namespace cloudidentity_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results available for specified query. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -269,15 +269,15 @@ export namespace cloudidentity_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Groups { diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index 88b098048e5..47ad32d4d16 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -124,11 +124,11 @@ export namespace cloudiot_v1 { /** * The device to associate with the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. */ - deviceId?: string; + deviceId?: string | null; /** * The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. */ - gatewayId?: string; + gatewayId?: string | null; } /** * Response for `BindDeviceToGateway`. @@ -145,11 +145,11 @@ export namespace cloudiot_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * The device resource. @@ -158,7 +158,7 @@ export namespace cloudiot_v1 { /** * If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance. */ - blocked?: boolean; + blocked?: boolean | null; /** * The most recent device configuration, which is eventually sent from Cloud IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and version value of `1`. To update this field after creation, use the `DeviceManager.ModifyCloudToDeviceConfig` method. */ @@ -174,15 +174,15 @@ export namespace cloudiot_v1 { /** * The user-defined device identifier. The device ID must be unique within a device registry. */ - id?: string; + id?: string | null; /** * [Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT. */ - lastConfigAckTime?: string; + lastConfigAckTime?: string | null; /** * [Output only] The last time a cloud-to-device config version was sent to the device. */ - lastConfigSendTime?: string; + lastConfigSendTime?: string | null; /** * [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK. */ @@ -190,35 +190,35 @@ export namespace cloudiot_v1 { /** * [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'. */ - lastErrorTime?: string; + lastErrorTime?: string | null; /** * [Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. */ - lastEventTime?: string; + lastEventTime?: string | null; /** * [Output only] The last time an MQTT `PINGREQ` was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send `PINGREQ` messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. */ - lastHeartbeatTime?: string; + lastHeartbeatTime?: string | null; /** * [Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. */ - lastStateTime?: string; + lastStateTime?: string | null; /** * **Beta Feature** The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used. */ - logLevel?: string; + logLevel?: string | null; /** * The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression a-zA-Z+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. */ - name?: string; + name?: string | null; /** * [Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique. */ - numId?: string; + numId?: string | null; /** * [Output only] The state most recently received from the device. If no state has been reported, this field is not present. */ @@ -231,19 +231,19 @@ export namespace cloudiot_v1 { /** * The device configuration data. */ - binaryData?: string; + binaryData?: string | null; /** * [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server. */ - cloudUpdateTime?: string; + cloudUpdateTime?: string | null; /** * [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core. */ - deviceAckTime?: string; + deviceAckTime?: string | null; /** * [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the `CreateDevice` request if a `config` is specified; the response of `CreateDevice` will always have a value of 1. */ - version?: string; + version?: string | null; } /** * A server-stored device credential used for authentication. @@ -252,7 +252,7 @@ export namespace cloudiot_v1 { /** * [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted. */ - expirationTime?: string; + expirationTime?: string | null; /** * A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate. */ @@ -277,11 +277,11 @@ export namespace cloudiot_v1 { /** * The identifier of this device registry. For example, `myRegistry`. */ - id?: string; + id?: string | null; /** * **Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level. */ - logLevel?: string; + logLevel?: string | null; /** * The MQTT configuration for this device registry. */ @@ -289,7 +289,7 @@ export namespace cloudiot_v1 { /** * The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ - name?: string; + name?: string | null; /** * The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core. */ @@ -302,11 +302,11 @@ export namespace cloudiot_v1 { /** * The device state data. */ - binaryData?: string; + binaryData?: string | null; /** * [Output only] The time at which this state version was updated in Cloud IoT Core. */ - updateTime?: string; + updateTime?: 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 `{}`. @@ -319,11 +319,11 @@ export namespace cloudiot_v1 { /** * A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. */ - pubsubTopicName?: string; + pubsubTopicName?: string | null; /** * If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes. */ - subfolderMatches?: string; + subfolderMatches?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -332,19 +332,19 @@ export namespace cloudiot_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Gateway-related configuration and state. @@ -353,19 +353,19 @@ export namespace cloudiot_v1 { /** * Indicates how to authorize and/or authenticate devices to access the gateway. */ - gatewayAuthMethod?: string; + gatewayAuthMethod?: string | null; /** * Indicates whether the device is a gateway. */ - gatewayType?: string; + gatewayType?: string | null; /** * [Output only] The ID of the gateway the device accessed most recently. */ - lastAccessedGatewayId?: string; + lastAccessedGatewayId?: string | null; /** * [Output only] The most recent time at which the device accessed the gateway specified in `last_accessed_gateway`. */ - lastAccessedGatewayTime?: string; + lastAccessedGatewayTime?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -383,7 +383,7 @@ export namespace cloudiot_v1 { /** * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * The configuration of the HTTP bridge for a device registry. @@ -392,7 +392,7 @@ export namespace cloudiot_v1 { /** * If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. */ - httpEnabledState?: string; + httpEnabledState?: string | null; } /** * Response for `ListDeviceConfigVersions`. @@ -414,7 +414,7 @@ export namespace cloudiot_v1 { /** * If not empty, indicates that there may be more registries that match the request; this value should be passed in a new `ListDeviceRegistriesRequest`. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for `ListDevices`. @@ -427,7 +427,7 @@ export namespace cloudiot_v1 { /** * If not empty, indicates that there may be more devices that match the request; this value should be passed in a new `ListDevicesRequest`. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for `ListDeviceStates`. @@ -445,11 +445,11 @@ export namespace cloudiot_v1 { /** * The configuration data for the device. */ - binaryData?: string; + binaryData?: string | null; /** * The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data. */ - versionToUpdate?: string; + versionToUpdate?: string | null; } /** * The configuration of MQTT for a device registry. @@ -458,7 +458,7 @@ export namespace cloudiot_v1 { /** * If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. */ - mqttEnabledState?: string; + mqttEnabledState?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -471,11 +471,11 @@ export namespace cloudiot_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * A public key certificate format and data. @@ -484,11 +484,11 @@ export namespace cloudiot_v1 { /** * The certificate data. */ - certificate?: string; + certificate?: string | null; /** * The certificate format. */ - format?: string; + format?: string | null; /** * [Output only] The certificate details. Used only for X.509 certificates. */ @@ -501,11 +501,11 @@ export namespace cloudiot_v1 { /** * The format of the key. */ - format?: string; + format?: string | null; /** * The key data. */ - key?: string; + key?: string | null; } /** * A server-stored registry credential used to validate device credentials. @@ -523,11 +523,11 @@ export namespace cloudiot_v1 { /** * The command data to send to the device. */ - binaryData?: string; + binaryData?: string | null; /** * Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. */ - subfolder?: string; + subfolder?: string | null; } /** * Response for `SendCommandToDevice`. @@ -549,7 +549,7 @@ export namespace cloudiot_v1 { /** * A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. */ - pubsubTopicName?: string; + pubsubTopicName?: 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). @@ -558,15 +558,15 @@ export namespace cloudiot_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -575,7 +575,7 @@ export namespace cloudiot_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -584,7 +584,7 @@ export namespace cloudiot_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Request for `UnbindDeviceFromGateway`. @@ -593,11 +593,11 @@ export namespace cloudiot_v1 { /** * The device to disassociate from the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. */ - deviceId?: string; + deviceId?: string | null; /** * The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. */ - gatewayId?: string; + gatewayId?: string | null; } /** * Response for `UnbindDeviceFromGateway`. @@ -610,27 +610,27 @@ export namespace cloudiot_v1 { /** * The time the certificate becomes invalid. */ - expiryTime?: string; + expiryTime?: string | null; /** * The entity that signed the certificate. */ - issuer?: string; + issuer?: string | null; /** * The type of public key in the certificate. */ - publicKeyType?: string; + publicKeyType?: string | null; /** * The algorithm used to sign the certificate. */ - signatureAlgorithm?: string; + signatureAlgorithm?: string | null; /** * The time the certificate becomes valid. */ - startTime?: string; + startTime?: string | null; /** * The entity the certificate and public key belong to. */ - subject?: string; + subject?: string | null; } export class Resource$Projects { diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index df782cedc2b..63a17277d72 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -124,7 +124,7 @@ export namespace cloudkms_v1 { /** * Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP. */ - ciphertext?: string; + ciphertext?: string | null; } /** * Response message for KeyManagementService.AsymmetricDecrypt. @@ -133,7 +133,7 @@ export namespace cloudkms_v1 { /** * The decrypted data originally encrypted with the matching public key. */ - plaintext?: string; + plaintext?: string | null; } /** * Request message for KeyManagementService.AsymmetricSign. @@ -151,7 +151,7 @@ export namespace cloudkms_v1 { /** * The created signature. */ - signature?: string; + signature?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -164,7 +164,7 @@ export namespace cloudkms_v1 { /** * 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; + 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. @@ -173,11 +173,11 @@ export namespace cloudkms_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -190,11 +190,11 @@ export namespace cloudkms_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of one or more versions, which represent the actual key material used in cryptographic operations. @@ -203,19 +203,19 @@ export namespace cloudkms_v1 { /** * Output only. The time at which this CryptoKey was created. */ - createTime?: string; + createTime?: string | null; /** * Labels with user-defined metadata. For more information, see [Labeling Keys](/kms/docs/labeling-keys). */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The resource name for this CryptoKey in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x. */ - name?: string; + name?: string | null; /** * At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. */ - nextRotationTime?: string; + nextRotationTime?: string | null; /** * Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. All keys with purpose ENCRYPT_DECRYPT have a primary. For other keys, this field will be omitted. */ @@ -223,11 +223,11 @@ export namespace cloudkms_v1 { /** * The immutable purpose of this CryptoKey. */ - purpose?: string; + purpose?: string | null; /** * next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. */ - rotationPeriod?: string; + rotationPeriod?: string | null; /** * A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template. */ @@ -240,7 +240,7 @@ export namespace cloudkms_v1 { /** * Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. */ - algorithm?: string; + algorithm?: string | null; /** * Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM. */ @@ -248,43 +248,43 @@ export namespace cloudkms_v1 { /** * Output only. The time at which this CryptoKeyVersion was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. */ - destroyEventTime?: string; + destroyEventTime?: string | null; /** * Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. */ - destroyTime?: string; + destroyTime?: string | null; /** * Output only. The time this CryptoKeyVersion's key material was generated. */ - generateTime?: string; + generateTime?: string | null; /** * Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED. */ - importFailureReason?: string; + importFailureReason?: string | null; /** * Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported. */ - importJob?: string; + importJob?: string | null; /** * Output only. The time at which this CryptoKeyVersion's key material was imported. */ - importTime?: string; + importTime?: string | null; /** * Output only. The resource name for this CryptoKeyVersion in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x. */ - name?: string; + name?: string | null; /** * Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. */ - protectionLevel?: string; + protectionLevel?: string | null; /** * The current state of the CryptoKeyVersion. */ - state?: string; + state?: string | null; } /** * A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. @@ -293,11 +293,11 @@ export namespace cloudkms_v1 { /** * Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT. */ - algorithm?: string; + algorithm?: string | null; /** * ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE. */ - protectionLevel?: string; + protectionLevel?: string | null; } /** * Request message for KeyManagementService.Decrypt. @@ -306,11 +306,11 @@ export namespace cloudkms_v1 { /** * Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data. */ - additionalAuthenticatedData?: string; + additionalAuthenticatedData?: string | null; /** * Required. The encrypted data originally returned in EncryptResponse.ciphertext. */ - ciphertext?: string; + ciphertext?: string | null; } /** * Response message for KeyManagementService.Decrypt. @@ -319,7 +319,7 @@ export namespace cloudkms_v1 { /** * The decrypted data originally supplied in EncryptRequest.plaintext. */ - plaintext?: string; + plaintext?: string | null; } /** * Request message for KeyManagementService.DestroyCryptoKeyVersion. @@ -332,15 +332,15 @@ export namespace cloudkms_v1 { /** * A message digest produced with the SHA-256 algorithm. */ - sha256?: string; + sha256?: string | null; /** * A message digest produced with the SHA-384 algorithm. */ - sha384?: string; + sha384?: string | null; /** * A message digest produced with the SHA-512 algorithm. */ - sha512?: string; + sha512?: string | null; } /** * Request message for KeyManagementService.Encrypt. @@ -349,11 +349,11 @@ export namespace cloudkms_v1 { /** * Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. */ - additionalAuthenticatedData?: string; + additionalAuthenticatedData?: string | null; /** * Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. */ - plaintext?: string; + plaintext?: string | null; } /** * Response message for KeyManagementService.Encrypt. @@ -362,11 +362,11 @@ export namespace cloudkms_v1 { /** * The encrypted data. */ - ciphertext?: string; + ciphertext?: string | null; /** * The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption. */ - name?: string; + name?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -375,19 +375,19 @@ export namespace cloudkms_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Request message for KeyManagementService.ImportCryptoKeyVersion. @@ -396,15 +396,15 @@ export namespace cloudkms_v1 { /** * Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into. */ - algorithm?: string; + algorithm?: string | null; /** * Required. The name of the ImportJob that was used to wrap this key material. */ - importJob?: string; + importJob?: string | null; /** * Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: <ol> <li>An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. </li> <li>The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). </li> </ol> This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. */ - rsaAesWrappedKey?: string; + rsaAesWrappedKey?: string | null; } /** * An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS. When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material. Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key. An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key. For more information, see [Importing a key](https://cloud.google.com/kms/docs/importing-a-key). @@ -417,31 +417,31 @@ export namespace cloudkms_v1 { /** * Output only. The time at which this ImportJob was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The time this ImportJob expired. Only present if state is EXPIRED. */ - expireEventTime?: string; + expireEventTime?: string | null; /** * Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material. */ - expireTime?: string; + expireTime?: string | null; /** * Output only. The time this ImportJob's key material was generated. */ - generateTime?: string; + generateTime?: string | null; /** * Required and immutable. The wrapping method to be used for incoming key material. */ - importMethod?: string; + importMethod?: string | null; /** * Output only. The resource name for this ImportJob in the format `projects/x/locations/x/keyRings/x/importJobs/x. */ - name?: string; + name?: string | null; /** * Required and immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. */ - protectionLevel?: string; + protectionLevel?: string | null; /** * Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. */ @@ -449,7 +449,7 @@ export namespace cloudkms_v1 { /** * Output only. The current state of the ImportJob, indicating if it can be used. */ - state?: string; + state?: string | null; } /** * Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). @@ -458,11 +458,11 @@ export namespace cloudkms_v1 { /** * Output only. The attestation data provided by the HSM when the key operation was performed. */ - content?: string; + content?: string | null; /** * Output only. The format of the attestation data. */ - format?: string; + format?: string | null; } /** * A KeyRing is a toplevel logical grouping of CryptoKeys. @@ -471,11 +471,11 @@ export namespace cloudkms_v1 { /** * Output only. The time at which this KeyRing was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The resource name for the KeyRing in the format `projects/x/locations/x/keyRings/x. */ - name?: string; + name?: string | null; } /** * Response message for KeyManagementService.ListCryptoKeys. @@ -488,11 +488,11 @@ export namespace cloudkms_v1 { /** * A token to retrieve next page of results. Pass this value in ListCryptoKeysRequest.page_token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of CryptoKeys that matched the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Response message for KeyManagementService.ListCryptoKeyVersions. @@ -505,11 +505,11 @@ export namespace cloudkms_v1 { /** * A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of CryptoKeyVersions that matched the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Response message for KeyManagementService.ListImportJobs. @@ -522,11 +522,11 @@ export namespace cloudkms_v1 { /** * A token to retrieve next page of results. Pass this value in ListImportJobsRequest.page_token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of ImportJobs that matched the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Response message for KeyManagementService.ListKeyRings. @@ -539,11 +539,11 @@ export namespace cloudkms_v1 { /** * A token to retrieve next page of results. Pass this value in ListKeyRingsRequest.page_token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of KeyRings that matched the query. */ - totalSize?: number; + totalSize?: number | null; } /** * The response message for Locations.ListLocations. @@ -556,7 +556,7 @@ export namespace cloudkms_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -565,23 +565,23 @@ export namespace cloudkms_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Cloud KMS metadata for the given google.cloud.location.Location. @@ -590,7 +590,7 @@ export namespace cloudkms_v1 { /** * Indicates whether CryptoKeys with protection_level HSM can be created in this location. */ - hsmAvailable?: boolean; + hsmAvailable?: boolean | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -607,11 +607,11 @@ export namespace cloudkms_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * The public key for a given CryptoKeyVersion. Obtained via GetPublicKey. @@ -620,11 +620,11 @@ export namespace cloudkms_v1 { /** * The Algorithm associated with this key. */ - algorithm?: string; + algorithm?: string | null; /** * The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). */ - pem?: string; + pem?: string | null; } /** * Request message for KeyManagementService.RestoreCryptoKeyVersion. @@ -641,7 +641,7 @@ export namespace cloudkms_v1 { /** * 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; + updateMask?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -650,7 +650,7 @@ export namespace cloudkms_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -659,7 +659,7 @@ export namespace cloudkms_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion. @@ -668,7 +668,7 @@ export namespace cloudkms_v1 { /** * The id of the child CryptoKeyVersion to use as primary. */ - cryptoKeyVersionId?: string; + cryptoKeyVersionId?: string | null; } /** * The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. @@ -677,7 +677,7 @@ export namespace cloudkms_v1 { /** * The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). */ - pem?: string; + pem?: string | null; } export class Resource$Projects { diff --git a/src/apis/cloudprivatecatalog/v1beta1.ts b/src/apis/cloudprivatecatalog/v1beta1.ts index c4afb558942..61abebce484 100644 --- a/src/apis/cloudprivatecatalog/v1beta1.ts +++ b/src/apis/cloudprivatecatalog/v1beta1.ts @@ -128,23 +128,23 @@ export namespace cloudprivatecatalog_v1beta1 { /** * Output only. The time when the catalog was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The description of the catalog. */ - description?: string; + description?: string | null; /** * Output only. The descriptive name of the catalog as it appears in UIs. */ - displayName?: string; + displayName?: string | null; /** * Output only. The resource name of the target catalog, in the format of `catalogs/{catalog_id}'. */ - name?: string; + name?: string | null; /** * Output only. The time when the catalog was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The readonly representation of a product computed with a given resource context. @@ -153,27 +153,27 @@ export namespace cloudprivatecatalog_v1beta1 { /** * Output only. The type of the product asset. It can be one of the following values: * `google.deploymentmanager.Template` * `google.cloudprivatecatalog.ListingOnly` */ - assetType?: string; + assetType?: string | null; /** * Output only. The time when the product was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The display metadata to describe the product. The JSON schema of the metadata differs by Product.asset_type. When the type is `google.deploymentmanager.Template`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 required: - name - description additionalProperties: false ``` When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 signup_url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" required: - name - description - signup_url additionalProperties: false ``` */ - displayMetadata?: {[key: string]: any}; + displayMetadata?: {[key: string]: any} | null; /** * Output only. The icon URI of the product. */ - iconUri?: string; + iconUri?: string | null; /** * Output only. The resource name of the target product, in the format of `products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog. */ - name?: string; + name?: string | null; /** * Output only. The time when the product was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * Response message for PrivateCatalog.SearchCatalogs. @@ -186,7 +186,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * A pagination token returned from a previous call to SearchCatalogs that indicates from where listing should continue. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for PrivateCatalog.SearchProducts. @@ -195,7 +195,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * A pagination token returned from a previous call to SearchProducts that indicates from where listing should continue. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The `Product` resources computed from the resource context. */ @@ -208,7 +208,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * A pagination token returned from a previous call to SearchVersions that indicates from where the listing should continue. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The `Version` resources computed from the resource context. */ @@ -221,23 +221,23 @@ export namespace cloudprivatecatalog_v1beta1 { /** * Output only. The asset which has been validated and is ready to be provisioned. See google.cloud.privatecatalogproducer.v1beta.Version.asset for details. */ - asset?: {[key: string]: any}; + asset?: {[key: string]: any} | null; /** * Output only. The time when the version was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The user-supplied description of the version. Maximum of 256 characters. */ - description?: string; + description?: string | null; /** * Output only. The resource name of the version, in the format `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A unique identifier for the version under a product. */ - name?: string; + name?: string | null; /** * Output only. The time when the version was last updated. */ - updateTime?: string; + updateTime?: string | null; } export class Resource$Folders { diff --git a/src/apis/cloudprivatecatalogproducer/v1beta1.ts b/src/apis/cloudprivatecatalogproducer/v1beta1.ts index 4b75a6a6b28..3b686b479d4 100644 --- a/src/apis/cloudprivatecatalogproducer/v1beta1.ts +++ b/src/apis/cloudprivatecatalogproducer/v1beta1.ts @@ -126,15 +126,15 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * The creation time of the association. */ - createTime?: string; + createTime?: string | null; /** * Output only. The resource name of the catalog association, in the format `catalogs/{catalog_id}/associations/{association_id}'. A unique identifier for the catalog association, which is generated by catalog service. */ - name?: string; + name?: string | null; /** * Required. The user-supplied fully qualified name of the `Resource` associated to the `Catalog`. It supports `Organization`, `Folder`, and `Project`. Values are of the form * `//cloudresourcemanager.googleapis.com/projects/{product_number}` * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}` */ - resource?: string; + resource?: string | null; } /** * The producer representation of a catalog which is a curated collection of solutions that can be managed, controlled, and shared by cloud admins. @@ -143,33 +143,33 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * Output only. The time when the catalog was created. */ - createTime?: string; + createTime?: string | null; /** * Required. The user-supplied description of the catalog. Maximum of 512 characters. */ - description?: string; + description?: string | null; /** * Required. The user-supplied descriptive name of the catalog as it appears in UIs. Maximum 256 characters in length. */ - displayName?: string; + displayName?: string | null; /** * Output only. The resource name of the catalog, in the format `catalogs/{catalog_id}'. A unique identifier for the catalog, which is generated by catalog service. */ - name?: string; + name?: string | null; /** * Required. The parent resource name of the catalog, which can't be changed after a catalog is created. It can only be an organization. Values are of the form `//cloudresourcemanager.googleapis.com/organizations/<id>`. Maximum 256 characters in length. */ - parent?: string; + parent?: string | null; /** * Output only. The time when the catalog was last updated. */ - updateTime?: string; + updateTime?: string | null; } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest { /** * The resource name of the destination product that is copied to. */ - destinationProductName?: string; + destinationProductName?: string | null; } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest { /** @@ -185,7 +185,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * A pagination token returned from a previous call to `ListAssociations` that indicates where the listing should continue from. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse { /** @@ -195,13 +195,13 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * A pagination token returned from a previous call to ListCatalogs that indicates where the listing should continue from. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse { /** * A pagination token returned from a previous call to ListProducts that indicates where the listing should continue from. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The `Product` returned from the list call. */ @@ -211,7 +211,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * A pagination token returned from a previous call to ListProducts that indicates where the listing should continue from. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The `VersiVersionon` returned from the list call. */ @@ -224,34 +224,34 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * Required. The type of the product asset, which cannot be changed after the product is created. It supports the values `google.deploymentmanager.Template` and `google.cloudprivatecatalog.ListingOnly`. Other values will be rejected by the server. Read only after creation. The following fields or resource types have different validation rules under each `asset_type` values: * Product.display_metadata has different validation schema for each asset type value. See its comment for details. * Version resource isn't allowed to be added under the `google.cloudprivatecatalog.ListingOnly` type. */ - assetType?: string; + assetType?: string | null; /** * Output only. The time when the product was created. */ - createTime?: string; + createTime?: string | null; /** * The user-supplied display metadata to describe the product. The JSON schema of the metadata differs by Product.asset_type. When the type is `google.deploymentmanager.Template`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 required: - name - description additionalProperties: false ``` When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 signup_url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" required: - name - description - signup_url additionalProperties: false ``` */ - displayMetadata?: {[key: string]: any}; + displayMetadata?: {[key: string]: any} | null; /** * Output only. The public accessible URI of the icon uploaded by PrivateCatalogProducer.UploadIcon. If no icon is uploaded, it will be the default icon's URI. */ - iconUri?: string; + iconUri?: string | null; /** * Required. The resource name of the product in the format `catalogs/{catalog_id}/products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog, which cannot be changed after the product is created. The final segment of the name must between 1 and 256 characters in length. */ - name?: string; + name?: string | null; /** * Output only. The time when the product was last updated. */ - updateTime?: string; + updateTime?: string | null; } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest {} export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest { /** * The raw icon bytes user-supplied to be uploaded to the product. The format of the icon can only be PNG or JPEG. The minimum allowed dimensions are 130x130 pixels and the maximum dimensions are 10000x10000 pixels. Required. */ - icon?: string; + icon?: string | null; } /** * The producer representation of a version, which is a child resource under a `Product` with asset data. @@ -260,27 +260,27 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * Output only. The asset which has been validated and is ready to be provisioned. See Version.original_asset for the schema. */ - asset?: {[key: string]: any}; + asset?: {[key: string]: any} | null; /** * Output only. The time when the version was created. */ - createTime?: string; + createTime?: string | null; /** * The user-supplied description of the version. Maximum of 256 characters. */ - description?: string; + description?: string | null; /** * Required. The resource name of the version, in the format `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A unique identifier for the version under a product, which can't be changed after the version is created. The final segment of the name must between 1 and 63 characters in length. */ - name?: string; + name?: string | null; /** * The user-supplied asset payload. The maximum size of the payload is 2MB. The JSON schema of the payload is defined as: ``` type: object properties: mainTemplate: type: string description: The file name of the main template and name prefix of schema file. The content of the main template should be set in the imports list. The schema file name is expected to be <mainTemplate>.schema in the imports list. required: true imports: type: array description: Import template and schema file contents. Required to have both <mainTemplate> and <mainTemplate>.schema files. required: true minItems: 2 items: type: object properties: name: type: string content: type: string ``` */ - originalAsset?: {[key: string]: any}; + originalAsset?: {[key: string]: any} | null; /** * Output only. The time when the version was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -293,7 +293,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * 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; + 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. @@ -302,11 +302,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -319,11 +319,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -340,11 +340,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -357,7 +357,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * 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; + updateMask?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -366,7 +366,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -375,7 +375,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The request message for Operations.CancelOperation. @@ -388,7 +388,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -401,7 +401,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -409,15 +409,15 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -430,15 +430,15 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -447,19 +447,19 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } export class Resource$Catalogs { @@ -751,7 +751,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1341,7 +1341,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/cloudprofiler/v2.ts b/src/apis/cloudprofiler/v2.ts index 12a13f91bb5..0534c8272ed 100644 --- a/src/apis/cloudprofiler/v2.ts +++ b/src/apis/cloudprofiler/v2.ts @@ -128,7 +128,7 @@ export namespace cloudprofiler_v2 { /** * One or more profile types that the agent is capable of providing. */ - profileType?: string[]; + profileType?: string[] | null; } /** * Deployment contains the deployment identification information. @@ -137,15 +137,15 @@ export namespace cloudprofiler_v2 { /** * Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named "language" can be used to record the programming language of the profiled deployment. The standard choices for the value include "java", "go", "python", "ruby", "nodejs", "php", "dotnet". For deployments running on Google Cloud Platform, "zone" or "region" label should be present describing the deployment location. An example of a zone is "us-central1-a", an example of a region is "us-central1" or "us-central". */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`. */ - projectId?: string; + projectId?: string | null; /** * Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`. */ - target?: string; + target?: string | null; } /** * Profile resource. @@ -158,23 +158,23 @@ export namespace cloudprofiler_v2 { /** * Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously). */ - duration?: string; + duration?: string | null; /** * Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. Opaque, server-assigned, unique ID for this profile. */ - name?: string; + name?: string | null; /** * Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto. */ - profileBytes?: string; + profileBytes?: string | null; /** * Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server. */ - profileType?: string; + profileType?: string | null; } export class Resource$Projects { diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 979970cb9c7..1235696233e 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -145,7 +145,7 @@ export namespace cloudresourcemanager_v1 { /** * 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; + 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. @@ -154,11 +154,11 @@ export namespace cloudresourcemanager_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -171,11 +171,11 @@ export namespace cloudresourcemanager_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A `Constraint` that is either enforced or not. For example a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance. @@ -188,7 +188,7 @@ export namespace cloudresourcemanager_v1 { /** * If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable. Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess` with `constraint_default` set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following behavior: - If the `Policy` at this resource has enforced set to `false`, serial port connection attempts will be allowed. - If the `Policy` at this resource has enforced set to `true`, serial port connection attempts will be refused. - If the `Policy` at this resource is `RestoreDefault`, serial port connection attempts will be allowed. - If no `Policy` is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed. - If no `Policy` is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if the`Policy` were set at this resource. The following examples demonstrate the different possible layerings: Example 1 (nearest `Constraint` wins): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has no `Policy` set. The constraint at `projects/bar` and `organizations/foo` will not be enforced. Example 2 (enforcement gets replaced): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has a `Policy` with: {enforced: true} The constraint at `organizations/foo` is not enforced. The constraint at `projects/bar` is enforced. Example 3 (RestoreDefault): `organizations/foo` has a `Policy` with: {enforced: true} `projects/bar` has a `Policy` with: {RestoreDefault: {}} The constraint at `organizations/foo` is enforced. The constraint at `projects/bar` is not enforced, because `constraint_default` for the `Constraint` is `ALLOW`. */ - enforced?: boolean; + enforced?: boolean | null; } /** * The request sent to the ClearOrgPolicy method. @@ -197,11 +197,11 @@ export namespace cloudresourcemanager_v1 { /** * Name of the `Constraint` of the `Policy` to clear. */ - constraint?: string; + constraint?: string | null; /** * The current version, for concurrency control. Not sending an `etag` will cause the `Policy` to be cleared blindly. */ - etag?: string; + etag?: string | null; } /** * A `Constraint` describes a way in which a resource's configuration can be restricted. For example, it controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. `Constraints` can be configured by the organization's policy adminstrator to fit the needs of the organzation by setting Policies for `Constraints` at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about Policies. `Constraints` have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a `Policy` being defined or inherited for the resource in question. @@ -214,15 +214,15 @@ export namespace cloudresourcemanager_v1 { /** * The evaluation behavior of this constraint in the absense of 'Policy'. */ - constraintDefault?: string; + constraintDefault?: string | null; /** * Detailed description of what this `Constraint` controls as well as how and where it is enforced. Mutable. */ - description?: string; + description?: string | null; /** * The human readable name. Mutable. */ - displayName?: string; + displayName?: string | null; /** * Defines this constraint as being a ListConstraint. */ @@ -230,11 +230,11 @@ export namespace cloudresourcemanager_v1 { /** * Immutable value, required to globally be unique. For example, `constraints/serviceuser.services` */ - name?: string; + name?: string | null; /** * Version of the `Constraint`. Default version is 0; */ - version?: number; + version?: number | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -247,19 +247,19 @@ export namespace cloudresourcemanager_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Metadata describing a long running folder operation @@ -268,19 +268,19 @@ export namespace cloudresourcemanager_v1 { /** * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ - destinationParent?: string; + destinationParent?: string | null; /** * The display name of the folder. */ - displayName?: string; + displayName?: string | null; /** * The type of this operation. */ - operationType?: string; + operationType?: string | null; /** * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ - sourceParent?: string; + sourceParent?: string | null; } /** * A classification of the Folder Operation error. @@ -289,7 +289,7 @@ export namespace cloudresourcemanager_v1 { /** * The type of operation error experienced. */ - errorMessageId?: string; + errorMessageId?: string | null; } /** * The request sent to the GetAncestry method. @@ -311,7 +311,7 @@ export namespace cloudresourcemanager_v1 { /** * The name of the `Constraint` to compute the effective `Policy`. */ - constraint?: string; + constraint?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -329,7 +329,7 @@ export namespace cloudresourcemanager_v1 { /** * Name of the `Constraint` to get the `Policy`. */ - constraint?: string; + constraint?: string | null; } /** * Encapsulates settings provided to GetIamPolicy. @@ -338,7 +338,7 @@ export namespace cloudresourcemanager_v1 { /** * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * A Lien represents an encumbrance on the actions that can be performed on a resource. @@ -347,27 +347,27 @@ export namespace cloudresourcemanager_v1 { /** * The creation time of this Lien. */ - createTime?: string; + createTime?: string | null; /** * A system-generated unique identifier for this Lien. Example: `liens/1234abcd` */ - name?: string; + name?: string | null; /** * A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com' */ - origin?: string; + origin?: string | null; /** * A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234` */ - parent?: string; + parent?: string | null; /** * Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key' */ - reason?: string; + reason?: string | null; /** * The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete'] */ - restrictions?: string[]; + restrictions?: string[] | null; } /** * The request sent to the [ListAvailableOrgPolicyConstraints] google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method. @@ -376,11 +376,11 @@ export namespace cloudresourcemanager_v1 { /** * Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size. */ - pageSize?: number; + pageSize?: number | null; /** * Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field. */ - pageToken?: string; + pageToken?: string | null; } /** * The response returned from the ListAvailableOrgPolicyConstraints method. Returns all `Constraints` that could be set at this level of the hierarchy (contrast with the response from `ListPolicies`, which returns all policies which are set). @@ -393,7 +393,7 @@ export namespace cloudresourcemanager_v1 { /** * Page token used to retrieve the next page. This is currently not used. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A `Constraint` that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a `Policy`. @@ -402,11 +402,11 @@ export namespace cloudresourcemanager_v1 { /** * Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Constraint`. */ - suggestedValue?: string; + suggestedValue?: string | null; /** * Indicates whether subtrees of Cloud Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder. */ - supportsUnder?: boolean; + supportsUnder?: boolean | null; } /** * The response message for Liens.ListLiens. @@ -419,7 +419,7 @@ export namespace cloudresourcemanager_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The request sent to the ListOrgPolicies method. @@ -428,11 +428,11 @@ export namespace cloudresourcemanager_v1 { /** * Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size. */ - pageSize?: number; + pageSize?: number | null; /** * Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field. */ - pageToken?: string; + pageToken?: string | null; } /** * The response returned from the ListOrgPolicies method. It will be empty if no `Policies` are set on the resource. @@ -441,7 +441,7 @@ export namespace cloudresourcemanager_v1 { /** * Page token used to retrieve the next page. This is currently not used, but the server may at any point start supplying a valid token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The `Policies` that are set on the resource. It will be empty if no `Policies` are set. */ @@ -454,23 +454,23 @@ export namespace cloudresourcemanager_v1 { /** * List of values allowed at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. */ - allowedValues?: string[]; + allowedValues?: string[] | null; /** * The policy all_values state. */ - allValues?: string; + allValues?: string | null; /** * List of values denied at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. */ - deniedValues?: string[]; + deniedValues?: string[] | null; /** * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. */ - inheritFromParent?: boolean; + inheritFromParent?: boolean | null; /** * Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Policy`. If `suggested_value` is not set, it will inherit the value specified higher in the hierarchy, unless `inherit_from_parent` is `false`. */ - suggestedValue?: string; + suggestedValue?: string | null; } /** * A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page. @@ -479,7 +479,7 @@ export namespace cloudresourcemanager_v1 { /** * Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of Projects that matched the list filter. This list can be paginated. */ @@ -492,7 +492,7 @@ export namespace cloudresourcemanager_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -500,15 +500,15 @@ export namespace cloudresourcemanager_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong. @@ -517,19 +517,19 @@ export namespace cloudresourcemanager_v1 { /** * Timestamp when the Organization was created. Assigned by the server. */ - creationTime?: string; + creationTime?: string | null; /** * A human-readable string that refers to the Organization in the GCP Console UI. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the G Suite customer that owns the organization. */ - displayName?: string; + displayName?: string | null; /** * The organization's current lifecycle state. Assigned by the server. */ - lifecycleState?: string; + lifecycleState?: string | null; /** * Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". */ - name?: string; + name?: string | null; /** * The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required. */ @@ -542,7 +542,7 @@ export namespace cloudresourcemanager_v1 { /** * The G Suite customer id used in the Directory API. */ - directoryCustomerId?: string; + directoryCustomerId?: string | null; } /** * Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources. @@ -555,11 +555,11 @@ export namespace cloudresourcemanager_v1 { /** * The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`. Immutable after creation. */ - constraint?: string; + constraint?: string | null; /** * An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`. */ - etag?: string; + etag?: string | null; /** * List of values either allowed or disallowed. */ @@ -571,11 +571,11 @@ export namespace cloudresourcemanager_v1 { /** * The time stamp the `Policy` was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to `SetOrgPolicy` was made for that `Policy`. Any value set by the client will be ignored. */ - updateTime?: string; + updateTime?: string | null; /** * Version of the `Policy`. Default version is 0; */ - version?: number; + version?: number | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -592,11 +592,11 @@ export namespace cloudresourcemanager_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. @@ -605,19 +605,19 @@ export namespace cloudresourcemanager_v1 { /** * Creation time. Read-only. */ - createTime?: string; + createTime?: string | null; /** * The labels associated with this Project. 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\])?)?. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: <code>"environment" : "dev"</code> Read-write. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The Project lifecycle state. Read-only. */ - lifecycleState?: string; + lifecycleState?: string | null; /** * The optional user-assigned display name of the Project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: <code>My Project</code> Read-write. */ - name?: string; + name?: string | null; /** * An optional reference to a parent Resource. Supported parent types include "organization" and "folder". Once set, the parent cannot be cleared. The `parent` can be set on creation or using the `UpdateProject` method; the end user must have the `resourcemanager.projects.create` permission on the parent. Read-write. */ @@ -625,11 +625,11 @@ export namespace cloudresourcemanager_v1 { /** * The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: <code>tokyo-rain-123</code> Read-only after creation. */ - projectId?: string; + projectId?: string | null; /** * The number uniquely identifying the project. Example: <code>415104041262</code> Read-only. */ - projectNumber?: string; + projectNumber?: string | null; } /** * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. @@ -638,15 +638,15 @@ export namespace cloudresourcemanager_v1 { /** * Creation time of the project creation workflow. */ - createTime?: string; + createTime?: string | null; /** * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ - gettable?: boolean; + gettable?: boolean | null; /** * True if the project creation process is complete. */ - ready?: boolean; + ready?: boolean | null; } /** * A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on. @@ -655,11 +655,11 @@ export namespace cloudresourcemanager_v1 { /** * Required field for the type-specific id. This should correspond to the id used in the type-specific API's. */ - id?: string; + id?: string | null; /** * Required field representing the resource type this id is for. At present, the valid types are: "organization" and "folder". */ - type?: string; + type?: string | null; } /** * Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific `Constraint` at this resource. Suppose that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/serviceuser.services`. Suppose that organization foo.com sets a `Policy` at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a `Policy` with the `policy_type` `restore_default` on several experimental projects, restoring the `constraint_default` enforcement of the `Constraint` for only those projects, allowing those projects to have all services activated. @@ -672,15 +672,15 @@ export namespace cloudresourcemanager_v1 { /** * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. */ - filter?: string; + filter?: string | null; /** * The maximum number of Organizations to return in the response. This field is optional. */ - pageSize?: number; + pageSize?: number | null; /** * A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue. This field is optional. */ - pageToken?: string; + pageToken?: string | null; } /** * The response returned from the `SearchOrganizations` method. @@ -689,7 +689,7 @@ export namespace cloudresourcemanager_v1 { /** * A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of Organizations that matched the search query, possibly paginated. */ @@ -706,7 +706,7 @@ export namespace cloudresourcemanager_v1 { /** * 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; + updateMask?: string | null; } /** * The request sent to the SetOrgPolicyRequest method. @@ -724,15 +724,15 @@ export namespace cloudresourcemanager_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -741,7 +741,7 @@ export namespace cloudresourcemanager_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -750,7 +750,7 @@ export namespace cloudresourcemanager_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The request sent to the UndeleteProject method. diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 377a505fa21..4ad1a0dd639 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -139,7 +139,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * 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; + 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. @@ -148,11 +148,11 @@ export namespace cloudresourcemanager_v1beta1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -165,11 +165,11 @@ export namespace cloudresourcemanager_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -182,19 +182,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Metadata describing a long running folder operation @@ -203,19 +203,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ - destinationParent?: string; + destinationParent?: string | null; /** * The display name of the folder. */ - displayName?: string; + displayName?: string | null; /** * The type of this operation. */ - operationType?: string; + operationType?: string | null; /** * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ - sourceParent?: string; + sourceParent?: string | null; } /** * A classification of the Folder Operation error. @@ -224,7 +224,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * The type of operation error experienced. */ - errorMessageId?: string; + errorMessageId?: string | null; } /** * The request sent to the GetAncestry method. @@ -255,7 +255,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * The response returned from the `ListOrganizations` method. @@ -264,7 +264,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of Organizations that matched the list query, possibly paginated. */ @@ -277,7 +277,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of Projects that matched the list filter. This list can be paginated. */ @@ -290,23 +290,23 @@ export namespace cloudresourcemanager_v1beta1 { /** * Timestamp when the Organization was created. Assigned by the server. */ - creationTime?: string; + creationTime?: string | null; /** * A human-readable string that refers to the Organization in the GCP Console UI. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the G Suite customer that owns the organization. */ - displayName?: string; + displayName?: string | null; /** * The organization's current lifecycle state. Assigned by the server. */ - lifecycleState?: string; + lifecycleState?: string | null; /** * Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". */ - name?: string; + name?: string | null; /** * An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. */ - organizationId?: string; + organizationId?: string | null; /** * The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required. */ @@ -319,7 +319,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * The G Suite customer id used in the Directory API. */ - directoryCustomerId?: string; + directoryCustomerId?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -336,11 +336,11 @@ export namespace cloudresourcemanager_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. @@ -349,19 +349,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * Creation time. Read-only. */ - createTime?: string; + createTime?: string | null; /** * The labels associated with this Project. 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\])?)?. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: <code>"environment" : "dev"</code> Read-write. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The Project lifecycle state. Read-only. */ - lifecycleState?: string; + lifecycleState?: string | null; /** * The optional user-assigned display name of the Project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: <code>My Project</code> Read-write. */ - name?: string; + name?: string | null; /** * An optional reference to a parent Resource. Supported parent types include "organization" and "folder". Once set, the parent cannot be cleared. The `parent` can be set on creation or using the `UpdateProject` method; the end user must have the `resourcemanager.projects.create` permission on the parent. Read-write. */ @@ -369,11 +369,11 @@ export namespace cloudresourcemanager_v1beta1 { /** * The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: <code>tokyo-rain-123</code> Read-only after creation. */ - projectId?: string; + projectId?: string | null; /** * The number uniquely identifying the project. Example: <code>415104041262</code> Read-only. */ - projectNumber?: string; + projectNumber?: string | null; } /** * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. @@ -382,15 +382,15 @@ export namespace cloudresourcemanager_v1beta1 { /** * Creation time of the project creation workflow. */ - createTime?: string; + createTime?: string | null; /** * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ - gettable?: boolean; + gettable?: boolean | null; /** * True if the project creation process is complete. */ - ready?: boolean; + ready?: boolean | null; } /** * A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on. @@ -399,11 +399,11 @@ export namespace cloudresourcemanager_v1beta1 { /** * Required field for the type-specific id. This should correspond to the id used in the type-specific API's. */ - id?: string; + id?: string | null; /** * Required field representing the resource type this id is for. At present, the valid types are "project", "folder", and "organization". */ - type?: string; + type?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -416,7 +416,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * 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; + updateMask?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -425,7 +425,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -434,7 +434,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The request sent to the UndeleteProject method. diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index d4007df0db3..af24caac7a8 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -130,7 +130,7 @@ export namespace cloudresourcemanager_v2 { /** * 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; + 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. @@ -139,11 +139,11 @@ export namespace cloudresourcemanager_v2 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -156,11 +156,11 @@ export namespace cloudresourcemanager_v2 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -169,19 +169,19 @@ export namespace cloudresourcemanager_v2 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * A Folder in an Organization's resource hierarchy, used to organize that Organization's resources. @@ -190,23 +190,23 @@ export namespace cloudresourcemanager_v2 { /** * Output only. Timestamp when the Folder was created. Assigned by the server. */ - createTime?: string; + createTime?: string | null; /** * The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. */ - displayName?: string; + displayName?: string | null; /** * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ - lifecycleState?: string; + lifecycleState?: string | null; /** * Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */ - name?: string; + name?: string | null; /** * The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ - parent?: string; + parent?: string | null; } /** * Metadata describing a long running folder operation @@ -215,19 +215,19 @@ export namespace cloudresourcemanager_v2 { /** * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ - destinationParent?: string; + destinationParent?: string | null; /** * The display name of the folder. */ - displayName?: string; + displayName?: string | null; /** * The type of this operation. */ - operationType?: string; + operationType?: string | null; /** * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ - sourceParent?: string; + sourceParent?: string | null; } /** * A classification of the Folder Operation error. @@ -236,7 +236,7 @@ export namespace cloudresourcemanager_v2 { /** * The type of operation error experienced. */ - errorMessageId?: string; + errorMessageId?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -252,9 +252,9 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * The ListFolders response message. @@ -267,7 +267,7 @@ export namespace cloudresourcemanager_v2 { /** * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The MoveFolder request message. @@ -276,7 +276,7 @@ export namespace cloudresourcemanager_v2 { /** * The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ - destinationParent?: string; + destinationParent?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -285,7 +285,7 @@ export namespace cloudresourcemanager_v2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -293,15 +293,15 @@ export namespace cloudresourcemanager_v2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -318,11 +318,11 @@ export namespace cloudresourcemanager_v2 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. @@ -331,15 +331,15 @@ export namespace cloudresourcemanager_v2 { /** * Creation time of the project creation workflow. */ - createTime?: string; + createTime?: string | null; /** * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ - gettable?: boolean; + gettable?: boolean | null; /** * True if the project creation process is complete. */ - ready?: boolean; + ready?: boolean | null; } /** * The request message for searching folders. @@ -348,15 +348,15 @@ export namespace cloudresourcemanager_v2 { /** * The maximum number of folders to return in the response. This field is optional. */ - pageSize?: number; + pageSize?: number | null; /** * A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. This field is optional. */ - pageToken?: string; + pageToken?: string | null; /** * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with "Test". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder resources with display names that include both "Test" and "String". */ - query?: string; + query?: string | null; } /** * The response message for searching folders. @@ -369,7 +369,7 @@ export namespace cloudresourcemanager_v2 { /** * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -382,7 +382,7 @@ export namespace cloudresourcemanager_v2 { /** * 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; + updateMask?: 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). @@ -391,15 +391,15 @@ export namespace cloudresourcemanager_v2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -408,7 +408,7 @@ export namespace cloudresourcemanager_v2 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -417,7 +417,7 @@ export namespace cloudresourcemanager_v2 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The UndeleteFolder request message. diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 8c91e90f001..110cbedbbad 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -130,7 +130,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * 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; + 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. @@ -139,11 +139,11 @@ export namespace cloudresourcemanager_v2beta1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -156,11 +156,11 @@ export namespace cloudresourcemanager_v2beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -169,19 +169,19 @@ export namespace cloudresourcemanager_v2beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * A Folder in an Organization's resource hierarchy, used to organize that Organization's resources. @@ -190,23 +190,23 @@ export namespace cloudresourcemanager_v2beta1 { /** * Output only. Timestamp when the Folder was created. Assigned by the server. */ - createTime?: string; + createTime?: string | null; /** * The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. */ - displayName?: string; + displayName?: string | null; /** * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ - lifecycleState?: string; + lifecycleState?: string | null; /** * Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */ - name?: string; + name?: string | null; /** * The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ - parent?: string; + parent?: string | null; } /** * Metadata describing a long running folder operation @@ -215,19 +215,19 @@ export namespace cloudresourcemanager_v2beta1 { /** * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ - destinationParent?: string; + destinationParent?: string | null; /** * The display name of the folder. */ - displayName?: string; + displayName?: string | null; /** * The type of this operation. */ - operationType?: string; + operationType?: string | null; /** * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ - sourceParent?: string; + sourceParent?: string | null; } /** * A classification of the Folder Operation error. @@ -236,7 +236,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * The type of operation error experienced. */ - errorMessageId?: string; + errorMessageId?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -252,9 +252,9 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * The ListFolders response message. @@ -267,7 +267,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The MoveFolder request message. @@ -276,7 +276,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ - destinationParent?: string; + destinationParent?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -285,7 +285,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -293,15 +293,15 @@ export namespace cloudresourcemanager_v2beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -318,11 +318,11 @@ export namespace cloudresourcemanager_v2beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. @@ -331,15 +331,15 @@ export namespace cloudresourcemanager_v2beta1 { /** * Creation time of the project creation workflow. */ - createTime?: string; + createTime?: string | null; /** * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ - gettable?: boolean; + gettable?: boolean | null; /** * True if the project creation process is complete. */ - ready?: boolean; + ready?: boolean | null; } /** * The request message for searching folders. @@ -348,15 +348,15 @@ export namespace cloudresourcemanager_v2beta1 { /** * The maximum number of folders to return in the response. This field is optional. */ - pageSize?: number; + pageSize?: number | null; /** * A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. This field is optional. */ - pageToken?: string; + pageToken?: string | null; /** * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with "Test". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder resources with display names that include both "Test" and "String". */ - query?: string; + query?: string | null; } /** * The response message for searching folders. @@ -369,7 +369,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. This field is optional. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -382,7 +382,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * 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; + updateMask?: 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). @@ -391,15 +391,15 @@ export namespace cloudresourcemanager_v2beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -408,7 +408,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -417,7 +417,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The UndeleteFolder request message. diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index 02df4d02404..0c148080b4e 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -128,19 +128,19 @@ export namespace cloudscheduler_v1 { /** * Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. */ - body?: string; + body?: string | null; /** * HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The HTTP method to use for the request. PATCH and OPTIONS are not permitted. */ - httpMethod?: string; + httpMethod?: string | null; /** * The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ - relativeUri?: string; + relativeUri?: string | null; } /** * App Engine Routing. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). @@ -149,19 +149,19 @@ export namespace cloudscheduler_v1 { /** * Output only. The host that the job is sent to. For more information about how App Engine requests are routed, see [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]`</br> `| [service] + '.' + [application_domain_name]`</br> `| [version] + '.' + [application_domain_name]`</br> `| [version_dot_service]+ '.' + [application_domain_name]`</br> `| [instance] + '.' + [application_domain_name]`</br> `| [instance_dot_service] + '.' + [application_domain_name]`</br> `| [instance_dot_version] + '.' + [application_domain_name]`</br> `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example <app-id>.appspot.com, which is associated with the job's project ID. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. */ - host?: string; + host?: string | null; /** * App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ - instance?: string; + instance?: string | null; /** * App service. By default, the job is sent to the service which is the default service when the job is attempted. */ - service?: string; + service?: string | null; /** * App version. By default, the job is sent to the version which is the default version when the job is attempted. */ - version?: string; + version?: 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 `{}`. @@ -174,15 +174,15 @@ export namespace cloudscheduler_v1 { /** * HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. */ - body?: string; + body?: string | null; /** * The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * Which HTTP method to use for the request. */ - httpMethod?: string; + httpMethod?: string | null; /** * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */ @@ -194,7 +194,7 @@ export namespace cloudscheduler_v1 { /** * Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. */ - uri?: string; + uri?: string | null; } /** * Configuration for a job. The maximum allowed size for a job is 100KB. @@ -207,11 +207,11 @@ export namespace cloudscheduler_v1 { /** * The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. */ - attemptDeadline?: string; + attemptDeadline?: string | null; /** * Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters. */ - description?: string; + description?: string | null; /** * HTTP target. */ @@ -219,11 +219,11 @@ export namespace cloudscheduler_v1 { /** * Output only. The time the last job attempt started. */ - lastAttemptTime?: string; + lastAttemptTime?: string | null; /** * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ - name?: string; + name?: string | null; /** * Pub/Sub target. */ @@ -235,15 +235,15 @@ export namespace cloudscheduler_v1 { /** * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. */ - schedule?: string; + schedule?: string | null; /** * Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. */ - scheduleTime?: string; + scheduleTime?: string | null; /** * Output only. State of the job. */ - state?: string; + state?: string | null; /** * Output only. The response from the target for the last attempted execution. */ @@ -251,11 +251,11 @@ export namespace cloudscheduler_v1 { /** * Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). */ - timeZone?: string; + timeZone?: string | null; /** * Output only. The creation time of the job. */ - userUpdateTime?: string; + userUpdateTime?: string | null; } /** * Response message for listing jobs using ListJobs. @@ -268,7 +268,7 @@ export namespace cloudscheduler_v1 { /** * A token to retrieve next page of results. Pass this value in the page_token field in the subsequent call to ListJobs to retrieve the next page of results. If this is empty it indicates that there are no more results through which to paginate. The page token is valid for only 2 hours. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -281,7 +281,7 @@ export namespace cloudscheduler_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -290,23 +290,23 @@ export namespace cloudscheduler_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. @@ -315,11 +315,11 @@ export namespace cloudscheduler_v1 { /** * OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. */ - scope?: string; + scope?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. @@ -328,11 +328,11 @@ export namespace cloudscheduler_v1 { /** * Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. */ - audience?: string; + audience?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Request message for PauseJob. @@ -345,19 +345,19 @@ export namespace cloudscheduler_v1 { /** * Optional attributes for this message. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * The message data field. If this field is empty, the message must contain at least one attribute. */ - data?: string; + data?: string | null; /** * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ - messageId?: string; + messageId?: string | null; /** * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ - publishTime?: string; + publishTime?: string | null; } /** * Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. @@ -366,15 +366,15 @@ export namespace cloudscheduler_v1 { /** * Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ - data?: string; + data?: string | null; /** * Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job. */ - topicName?: string; + topicName?: string | null; } /** * Request message for ResumeJob. @@ -387,23 +387,23 @@ export namespace cloudscheduler_v1 { /** * The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. */ - maxBackoffDuration?: string; + maxBackoffDuration?: string | null; /** * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the a job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. */ - maxDoublings?: number; + maxDoublings?: number | null; /** * The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. */ - maxRetryDuration?: string; + maxRetryDuration?: string | null; /** * The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. */ - minBackoffDuration?: string; + minBackoffDuration?: string | null; /** * The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. */ - retryCount?: number; + retryCount?: number | null; } /** * Request message for forcing a job to run now using RunJob. @@ -416,15 +416,15 @@ export namespace cloudscheduler_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index 15d39c228e6..f469dac0a50 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -128,19 +128,19 @@ export namespace cloudscheduler_v1beta1 { /** * Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. */ - body?: string; + body?: string | null; /** * HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The HTTP method to use for the request. PATCH and OPTIONS are not permitted. */ - httpMethod?: string; + httpMethod?: string | null; /** * The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ - relativeUri?: string; + relativeUri?: string | null; } /** * App Engine Routing. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). @@ -149,19 +149,19 @@ export namespace cloudscheduler_v1beta1 { /** * Output only. The host that the job is sent to. For more information about how App Engine requests are routed, see [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]`</br> `| [service] + '.' + [application_domain_name]`</br> `| [version] + '.' + [application_domain_name]`</br> `| [version_dot_service]+ '.' + [application_domain_name]`</br> `| [instance] + '.' + [application_domain_name]`</br> `| [instance_dot_service] + '.' + [application_domain_name]`</br> `| [instance_dot_version] + '.' + [application_domain_name]`</br> `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example <app-id>.appspot.com, which is associated with the job's project ID. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. */ - host?: string; + host?: string | null; /** * App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ - instance?: string; + instance?: string | null; /** * App service. By default, the job is sent to the service which is the default service when the job is attempted. */ - service?: string; + service?: string | null; /** * App version. By default, the job is sent to the version which is the default version when the job is attempted. */ - version?: string; + version?: 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 `{}`. @@ -174,15 +174,15 @@ export namespace cloudscheduler_v1beta1 { /** * HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. */ - body?: string; + body?: string | null; /** * The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * Which HTTP method to use for the request. */ - httpMethod?: string; + httpMethod?: string | null; /** * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */ @@ -194,7 +194,7 @@ export namespace cloudscheduler_v1beta1 { /** * Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. */ - uri?: string; + uri?: string | null; } /** * Configuration for a job. The maximum allowed size for a job is 100KB. @@ -207,11 +207,11 @@ export namespace cloudscheduler_v1beta1 { /** * The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * For PubSub targets, this field is ignored. */ - attemptDeadline?: string; + attemptDeadline?: string | null; /** * Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters. */ - description?: string; + description?: string | null; /** * HTTP target. */ @@ -219,11 +219,11 @@ export namespace cloudscheduler_v1beta1 { /** * Output only. The time the last job attempt started. */ - lastAttemptTime?: string; + lastAttemptTime?: string | null; /** * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ - name?: string; + name?: string | null; /** * Pub/Sub target. */ @@ -235,15 +235,15 @@ export namespace cloudscheduler_v1beta1 { /** * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. */ - schedule?: string; + schedule?: string | null; /** * Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. */ - scheduleTime?: string; + scheduleTime?: string | null; /** * Output only. State of the job. */ - state?: string; + state?: string | null; /** * Output only. The response from the target for the last attempted execution. */ @@ -251,11 +251,11 @@ export namespace cloudscheduler_v1beta1 { /** * Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). */ - timeZone?: string; + timeZone?: string | null; /** * Output only. The creation time of the job. */ - userUpdateTime?: string; + userUpdateTime?: string | null; } /** * Response message for listing jobs using ListJobs. @@ -268,7 +268,7 @@ export namespace cloudscheduler_v1beta1 { /** * A token to retrieve next page of results. Pass this value in the page_token field in the subsequent call to ListJobs to retrieve the next page of results. If this is empty it indicates that there are no more results through which to paginate. The page token is valid for only 2 hours. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -281,7 +281,7 @@ export namespace cloudscheduler_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -290,23 +290,23 @@ export namespace cloudscheduler_v1beta1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. @@ -315,11 +315,11 @@ export namespace cloudscheduler_v1beta1 { /** * OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. */ - scope?: string; + scope?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. @@ -328,11 +328,11 @@ export namespace cloudscheduler_v1beta1 { /** * Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. */ - audience?: string; + audience?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Request message for PauseJob. @@ -345,19 +345,19 @@ export namespace cloudscheduler_v1beta1 { /** * Optional attributes for this message. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * The message data field. If this field is empty, the message must contain at least one attribute. */ - data?: string; + data?: string | null; /** * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ - messageId?: string; + messageId?: string | null; /** * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ - publishTime?: string; + publishTime?: string | null; } /** * Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. @@ -366,15 +366,15 @@ export namespace cloudscheduler_v1beta1 { /** * Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ - data?: string; + data?: string | null; /** * Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job. */ - topicName?: string; + topicName?: string | null; } /** * Request message for ResumeJob. @@ -387,23 +387,23 @@ export namespace cloudscheduler_v1beta1 { /** * The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. */ - maxBackoffDuration?: string; + maxBackoffDuration?: string | null; /** * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the a job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. */ - maxDoublings?: number; + maxDoublings?: number | null; /** * The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. */ - maxRetryDuration?: string; + maxRetryDuration?: string | null; /** * The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. */ - minBackoffDuration?: string; + minBackoffDuration?: string | null; /** * The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. */ - retryCount?: number; + retryCount?: number | null; } /** * Request message for forcing a job to run now using RunJob. @@ -416,15 +416,15 @@ export namespace cloudscheduler_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 941f2ff2c4d..fbf524a1cd3 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -136,7 +136,7 @@ export namespace cloudsearch_v1 { /** * Indicates the operator name required in the query in order to isolate the boolean property. For example, if operatorName is *closed* and the property's name is *isClosed*, then queries like *closed:&lt;value&gt;* will show results only where the value of the property named *isClosed* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for boolean properties. @@ -151,13 +151,13 @@ export namespace cloudsearch_v1 { /** * Returns true if principal has access. Returns false otherwise. */ - hasAccess?: boolean; + hasAccess?: boolean | null; } export interface Schema$CompositeFilter { /** * The logic operator of the sub filter. */ - logicOperator?: string; + logicOperator?: string | null; /** * Sub filters. */ @@ -183,19 +183,19 @@ export namespace cloudsearch_v1 { /** * If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data. */ - disableModifications?: boolean; + disableModifications?: boolean | null; /** * Disable serving any search or assist results. */ - disableServing?: boolean; + disableServing?: boolean | null; /** * Required. Display name of the datasource The maximum length is 300 characters. */ - displayName?: string; + displayName?: string | null; /** * List of service accounts that have indexing access. */ - indexingServiceAccounts?: string[]; + 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. */ @@ -203,15 +203,15 @@ export namespace cloudsearch_v1 { /** * Name of the datasource resource. Format: datasources/{source_id}. <br />The name is ignored when creating a datasource. */ - name?: string; + name?: string | null; /** * IDs of the Long Running Operations (LROs) currently running for this schema. */ - operationIds?: string[]; + operationIds?: string[] | null; /** * A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. */ - shortName?: string; + shortName?: string | null; } /** * Aggregation of items by status code as of the specified date. @@ -246,15 +246,15 @@ export namespace cloudsearch_v1 { /** * Day of month. Must be from 1 to 31 and valid for the year and month. */ - day?: number; + day?: number | null; /** * Month of date. Must be from 1 to 12. */ - month?: number; + month?: number | null; /** * Year of date. Must be from 1 to 9999. */ - year?: number; + year?: number | null; } /** * Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched. @@ -263,15 +263,15 @@ export namespace cloudsearch_v1 { /** * Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:&lt;value&gt;* will show results only where the value of the property named *closeDate* is later than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - greaterThanOperatorName?: string; + greaterThanOperatorName?: string | null; /** * Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:&lt;value&gt;* will show results only where the value of the property named *closeDate* is earlier than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - lessThanOperatorName?: string; + lessThanOperatorName?: string | null; /** * Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:&lt;value&gt;* will show results only where the value of the *closeDate* property matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for date properties. @@ -295,13 +295,13 @@ export namespace cloudsearch_v1 { /** * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ - enableDebugging?: boolean; + enableDebugging?: boolean | null; } export interface Schema$DeleteQueueItemsRequest { /** * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ - connectorName?: string; + connectorName?: string | null; /** * Common debug options. */ @@ -309,7 +309,7 @@ export namespace cloudsearch_v1 { /** * Name of a queue to delete items from. */ - queue?: string; + queue?: string | null; } /** * A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties will be displayed in the search results along with the dislpay label for that property if one is specified. If a display label is not specified, only the values will be shown. @@ -318,7 +318,7 @@ export namespace cloudsearch_v1 { /** * The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error will be given when attempting to update the schema. */ - propertyName?: string; + propertyName?: string | null; } /** * Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. @@ -327,7 +327,7 @@ export namespace cloudsearch_v1 { /** * Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for double properties. @@ -342,31 +342,31 @@ export namespace cloudsearch_v1 { * List of double values. */ export interface Schema$DoubleValues { - values?: number[]; + values?: number[] | null; } /** * Drive follow-up search restricts (e.g. "followup:suggestions"). */ export interface Schema$DriveFollowUpRestrict { - type?: string; + type?: string | null; } /** * Drive location search restricts (e.g. "is:starred"). */ export interface Schema$DriveLocationRestrict { - type?: string; + type?: string | null; } /** * Drive mime-type search restricts (e.g. "type:pdf"). */ export interface Schema$DriveMimeTypeRestrict { - type?: string; + type?: string | null; } /** * The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12"). */ export interface Schema$DriveTimeSpanRestrict { - type?: string; + type?: string | null; } /** * A person's email address. @@ -375,7 +375,7 @@ export namespace cloudsearch_v1 { /** * The email address. */ - emailAddress?: string; + emailAddress?: string | null; } /** * Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* will return items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*. @@ -384,7 +384,7 @@ export namespace cloudsearch_v1 { /** * Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:&lt;value&gt;* will show results only where the value of the property named *priorityVal* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*. @@ -397,7 +397,7 @@ export namespace cloudsearch_v1 { /** * Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false. */ - orderedRanking?: string; + orderedRanking?: string | null; /** * The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100. */ @@ -410,11 +410,11 @@ export namespace cloudsearch_v1 { /** * The integer value of the EnumValuePair which must be non-negative. Optional. */ - integerValue?: number; + integerValue?: number | null; /** * The string value of the EnumValuePair. The maximum length is 32 characters. */ - stringValue?: string; + stringValue?: string | null; } /** * List of enum values. @@ -423,7 +423,7 @@ export namespace cloudsearch_v1 { /** * The maximum allowable length for string values is 32 characters. */ - values?: string[]; + values?: string[] | null; } /** * Error information about the response. @@ -435,7 +435,7 @@ export namespace cloudsearch_v1 { * Error message per source response. */ export interface Schema$ErrorMessage { - errorMessage?: string; + errorMessage?: string | null; source?: Schema$Source; } /** @@ -445,11 +445,11 @@ export namespace cloudsearch_v1 { /** * Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty. */ - count?: number; + count?: number | null; /** * Percent of results that match the bucket value. This value is between (0-100]. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts. */ - percentage?: number; + percentage?: number | null; value?: Schema$Value; } /** @@ -459,19 +459,19 @@ export namespace cloudsearch_v1 { /** * Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100. */ - numFacetBuckets?: number; + numFacetBuckets?: number | null; /** * If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets. */ - objectType?: string; + objectType?: string | null; /** * Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions */ - operatorName?: string; + operatorName?: string | null; /** * Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used. */ - sourceName?: string; + sourceName?: string | null; } /** * Source specific facet response @@ -484,25 +484,25 @@ export namespace cloudsearch_v1 { /** * Object type for which facet results are returned. Can be empty. */ - objectType?: string; + objectType?: string | null; /** * Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions */ - operatorName?: string; + operatorName?: string | null; /** * Source name for which facet results are returned. Will not be empty. */ - sourceName?: string; + sourceName?: string | null; } export interface Schema$FieldViolation { /** * Description of the error. */ - description?: string; + description?: string | null; /** * Path of field with violation. */ - field?: string; + field?: string | null; } /** * A generic way of expressing filters in a query, which supports two approaches: <br/><br/> **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. <br/> **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. @@ -522,7 +522,7 @@ export namespace cloudsearch_v1 { /** * If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters. */ - objectType?: string; + objectType?: string | null; } /** * Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly. @@ -531,11 +531,11 @@ export namespace cloudsearch_v1 { /** * The duration after which an object should be considered stale. The default value is 180 days (in seconds). */ - freshnessDuration?: string; + freshnessDuration?: string | null; /** * This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate fresheness, the value defaults to 2 years from the current time. */ - freshnessProperty?: string; + freshnessProperty?: string | null; } export interface Schema$GetCustomerIndexStatsResponse { /** @@ -553,45 +553,45 @@ export namespace cloudsearch_v1 { * Gmail Action restricts (i.e. read/replied/snoozed). */ export interface Schema$GmailActionRestrict { - type?: string; + type?: string | null; } /** * Gmail Attachment restricts (i.e. has:attachment, has:drive, filename:pdf). */ export interface Schema$GmailAttachmentRestrict { - type?: string; + type?: string | null; } /** * Gmail Folder restricts (i.e. in Drafts/Sent/Chats/User Generated Labels). */ export interface Schema$GmailFolderRestrict { - type?: string; + type?: string | null; } /** * Gmail Intelligent restricts (i.e. smartlabels, important). */ export interface Schema$GmailIntelligentRestrict { - type?: string; + type?: string | null; } /** * Gmail Time restricts (i.e. received today, this week). */ export interface Schema$GmailTimeRestrict { - type?: string; + type?: string | null; } export interface Schema$GSuitePrincipal { /** * This principal represents all users of the G Suite domain of the customer. */ - gsuiteDomain?: boolean; + gsuiteDomain?: boolean | null; /** * This principal references a G Suite group account */ - gsuiteGroupEmail?: string; + gsuiteGroupEmail?: string | null; /** * This principal references a G Suite user account */ - gsuiteUserEmail?: string; + gsuiteUserEmail?: string | null; } /** * Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. @@ -600,7 +600,7 @@ export namespace cloudsearch_v1 { /** * Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:&lt;value&gt;* will show results only where the value of the property named *subjectLine* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for html properties. @@ -622,19 +622,19 @@ export namespace cloudsearch_v1 { /** * The maximum allowable length for html values is 2048 characters. */ - values?: string[]; + values?: string[] | null; } export interface Schema$IndexItemOptions { /** * Specifies if the index request should allow gsuite principals that do not exist or are deleted in the index request. */ - allowUnknownGsuitePrincipals?: boolean; + allowUnknownGsuitePrincipals?: boolean | null; } export interface Schema$IndexItemRequest { /** * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ - connectorName?: string; + connectorName?: string | null; /** * Common debug options. */ @@ -647,7 +647,7 @@ export namespace cloudsearch_v1 { /** * Required. The RequestMode for this request. */ - mode?: string; + mode?: string | null; } /** * Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. @@ -656,15 +656,15 @@ export namespace cloudsearch_v1 { /** * Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:&lt;value&gt;* will show results only where the value of the property named *priorityVal* is greater than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - greaterThanOperatorName?: string; + greaterThanOperatorName?: string | null; /** * Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:&lt;value&gt;* will show results only where the value of the property named *priorityVal* is less than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - lessThanOperatorName?: string; + lessThanOperatorName?: string | null; /** * Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:&lt;value&gt;* will show results only where the value of the property named *priorityVal* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for integer properties. @@ -673,11 +673,11 @@ export namespace cloudsearch_v1 { /** * The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value. */ - maximumValue?: string; + maximumValue?: string | null; /** * The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value. */ - minimumValue?: string; + minimumValue?: string | null; /** * If set, describes how the integer should be used as a search operator. */ @@ -685,13 +685,13 @@ export namespace cloudsearch_v1 { /** * Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false. */ - orderedRanking?: string; + orderedRanking?: string | null; } /** * List of integer values. */ export interface Schema$IntegerValues { - values?: string[]; + values?: string[] | null; } /** * Represents an interaction between a user and an item. @@ -700,12 +700,12 @@ export namespace cloudsearch_v1 { /** * The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded. */ - interactionTime?: string; + interactionTime?: string | null; /** * The user that acted on the item. */ principal?: Schema$Principal; - type?: string; + type?: string | null; } /** * Represents a single object that is an item in the search index, such as a file, folder, or a database record. @@ -722,7 +722,7 @@ export namespace cloudsearch_v1 { /** * Type for this item. */ - itemType?: string; + itemType?: string | null; /** * Metadata information. */ @@ -730,15 +730,15 @@ export namespace cloudsearch_v1 { /** * Name of the Item. Format: datasources/{source_id}/items/{item_id} <br />This is a required field. The maximum length is 1536 characters. */ - name?: string; + name?: string | null; /** * Additional state connector can store for this item. The maximum length is 10000 bytes. */ - payload?: string; + payload?: string | null; /** * Queue this item belongs to. The maximum length is 100 characters. */ - queue?: string; + queue?: string | null; /** * Status of the item. Output only field. */ @@ -750,7 +750,7 @@ export namespace cloudsearch_v1 { /** * Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. <br /><br /> Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. */ - version?: string; + version?: string | null; } /** * Access control list information for the item. For more information see https://developers.google.com/cloud-search/docs/guides/index-your-data#acls @@ -759,7 +759,7 @@ export namespace cloudsearch_v1 { /** * Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. */ - aclInheritanceType?: string; + aclInheritanceType?: string | null; /** * List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. */ @@ -767,7 +767,7 @@ export namespace cloudsearch_v1 { /** * Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters. */ - inheritAclFrom?: string; + inheritAclFrom?: string | null; /** * Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5. */ @@ -785,25 +785,25 @@ export namespace cloudsearch_v1 { * Upload reference ID of a previously uploaded content via write method. */ contentDataRef?: Schema$UploadItemRef; - contentFormat?: string; + contentFormat?: string | null; /** * Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ - hash?: string; + hash?: string | null; /** * Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB). */ - inlineContent?: string; + inlineContent?: string | null; } export interface Schema$ItemCountByStatus { /** * Number of items matching the status code. */ - count?: string; + count?: string | null; /** * Status of the items. */ - statusCode?: string; + statusCode?: string | null; } /** * Available metadata fields for the item. @@ -812,19 +812,19 @@ export namespace cloudsearch_v1 { /** * The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. */ - containerName?: string; + containerName?: string | null; /** * The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * The time when the item was created in the source repository. */ - createTime?: string; + createTime?: string | null; /** * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ - hash?: string; + hash?: string | null; /** * A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. */ @@ -832,15 +832,15 @@ export namespace cloudsearch_v1 { /** * Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters. */ - keywords?: string[]; + keywords?: string[] | null; /** * The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters. */ - mimeType?: string; + mimeType?: string | null; /** * The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters. */ - objectType?: string; + objectType?: string | null; /** * Additional search quality metadata of the item */ @@ -848,15 +848,15 @@ export namespace cloudsearch_v1 { /** * Link to the source repository serving the data. &#83;earch results apply this link to the title. The maximum length is 2048 characters. */ - sourceRepositoryUrl?: string; + sourceRepositoryUrl?: string | null; /** * The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters. */ - title?: string; + title?: string | null; /** * The time when the item was last modified in the source repository. */ - updateTime?: string; + updateTime?: string | null; } /** * This contains item's status and any errors. @@ -865,7 +865,7 @@ export namespace cloudsearch_v1 { /** * Status code. */ - code?: string; + code?: string | null; /** * Error details in case the item is in ERROR state. */ @@ -882,7 +882,7 @@ export namespace cloudsearch_v1 { /** * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ - hash?: string; + hash?: string | null; /** * The structured data object that should conform to a registered object definition in the schema for the data source. */ @@ -892,42 +892,42 @@ export namespace cloudsearch_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; sources?: Schema$DataSource[]; } export interface Schema$ListItemNamesForUnmappedIdentityResponse { - itemNames?: string[]; + itemNames?: string[] | null; /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListItemsResponse { items?: Schema$Item[]; /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * List sources response. */ export interface Schema$ListQuerySourcesResponse { - nextPageToken?: string; + nextPageToken?: string | null; sources?: Schema$QuerySource[]; } export interface Schema$ListSearchApplicationsResponse { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; searchApplications?: Schema$SearchApplication[]; } export interface Schema$ListUnmappedIdentitiesResponse { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; unmappedIdentities?: Schema$UnmappedIdentity[]; } /** @@ -937,11 +937,11 @@ export namespace cloudsearch_v1 { /** * End of the match in the snippet. */ - end?: number; + end?: number | null; /** * Starting position of the match in the snippet. */ - start?: number; + start?: number | null; } /** * Media resource. @@ -950,7 +950,7 @@ export namespace cloudsearch_v1 { /** * Name of the media resource. */ - resourceName?: string; + resourceName?: string | null; } /** * Metadata of a matched search result. @@ -959,7 +959,7 @@ export namespace cloudsearch_v1 { /** * The creation time for this document or object in the search result. */ - createTime?: string; + createTime?: string | null; /** * Options that specify how to display a structured data search result. */ @@ -971,11 +971,11 @@ export namespace cloudsearch_v1 { /** * Mime type of the search result. */ - mimeType?: string; + mimeType?: string | null; /** * Object type of the search result. */ - objectType?: string; + objectType?: string | null; /** * Owner (usually creator) of the document or object of the search result. */ @@ -987,7 +987,7 @@ export namespace cloudsearch_v1 { /** * The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time. */ - updateTime?: string; + updateTime?: string | null; } /** * A metaline is a list of properties that are displayed along with the search result to provide context. @@ -1005,13 +1005,13 @@ export namespace cloudsearch_v1 { /** * The read-only display name formatted according to the locale specified by the viewer's account or the <code>Accept-Language</code> HTTP header. */ - displayName?: string; + displayName?: string | null; } /** * A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`. */ export interface Schema$NamedProperty { - booleanValue?: boolean; + booleanValue?: boolean | null; dateValues?: Schema$DateValues; doubleValues?: Schema$DoubleValues; enumValues?: Schema$EnumValues; @@ -1020,7 +1020,7 @@ export namespace cloudsearch_v1 { /** * The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters. */ - name?: string; + name?: string | null; objectValues?: Schema$ObjectValues; textValues?: Schema$TextValues; timestampValues?: Schema$TimestampValues; @@ -1032,7 +1032,7 @@ export namespace cloudsearch_v1 { /** * Name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. */ - name?: string; + name?: string | null; /** * The optional object-specific options. */ @@ -1053,7 +1053,7 @@ export namespace cloudsearch_v1 { /** * The user friendly label to display in the search result to inidicate the type of the item. This is OPTIONAL; if not given, an object label will not be displayed on the context line of the search results. The maximum length is 32 characters. */ - objectDisplayLabel?: string; + objectDisplayLabel?: string | null; } /** * The options for an object. @@ -1090,7 +1090,7 @@ export namespace cloudsearch_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1098,15 +1098,15 @@ export namespace cloudsearch_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * This field contains information about the person being suggested. @@ -1128,11 +1128,11 @@ export namespace cloudsearch_v1 { /** * The resource name of the person to provide information about. See <a href="https://developers.google.com/people/api/rest/v1/people/get"> People.get</a> from Google People API. */ - name?: string; + name?: string | null; /** * Obfuscated ID of a person. */ - obfuscatedId?: string; + obfuscatedId?: string | null; /** * The person's name */ @@ -1149,13 +1149,13 @@ export namespace cloudsearch_v1 { /** * The URL of the photo. */ - url?: string; + url?: string | null; } export interface Schema$PollItemsRequest { /** * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ - connectorName?: string; + connectorName?: string | null; /** * Common debug options. */ @@ -1163,15 +1163,15 @@ export namespace cloudsearch_v1 { /** * Maximum number of items to return. <br />The maximum and the default value is 1000 */ - limit?: number; + limit?: number | null; /** * Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters. */ - queue?: string; + queue?: string | null; /** * Limit the items polled to the ones with these statuses. */ - statusCodes?: string[]; + statusCodes?: string[] | null; } export interface Schema$PollItemsResponse { /** @@ -1186,7 +1186,7 @@ export namespace cloudsearch_v1 { /** * This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID} */ - groupResourceName?: string; + groupResourceName?: string | null; /** * This principal is a GSuite user, group or domain. */ @@ -1194,17 +1194,17 @@ export namespace cloudsearch_v1 { /** * This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID} */ - userResourceName?: string; + userResourceName?: string | null; } export interface Schema$ProcessingError { /** * Error code indicating the nature of the error. */ - code?: string; + code?: string | null; /** * Description of the error. */ - errorMessage?: string; + errorMessage?: string | null; /** * In case the item fields are invalid, this field contains the details about the validation errors. */ @@ -1227,31 +1227,31 @@ export namespace cloudsearch_v1 { /** * Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for Boolean, Enum, and Text properties. */ - isFacetable?: boolean; + isFacetable?: boolean | null; /** * Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value will cause the indexing request for that item to be rejected. */ - isRepeatable?: boolean; + isRepeatable?: boolean | null; /** * Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object. */ - isReturnable?: boolean; + isReturnable?: boolean | null; /** * Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object or user identifier. IsReturnable must be true to set this option. Only supported for Boolean, Date, Double, Integer, and Timestamp properties. */ - isSortable?: boolean; + isSortable?: boolean | null; /** * Indicates that the property can be used for generating query suggestions. */ - isSuggestable?: boolean; + isSuggestable?: boolean | null; /** * Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. Note: This is an alpha feature and is enabled for whitelisted users only. */ - isWildcardSearchable?: boolean; + isWildcardSearchable?: boolean | null; /** * The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. */ - name?: string; + name?: string | null; objectPropertyOptions?: Schema$ObjectPropertyOptions; textPropertyOptions?: Schema$TextPropertyOptions; timestampPropertyOptions?: Schema$TimestampPropertyOptions; @@ -1263,7 +1263,7 @@ export namespace cloudsearch_v1 { /** * The user friendly label for the property that will be used if the property is specified to be displayed in ObjectDisplayOptions. If given, the display label will be shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user will see 'priority : 1' in the search results which provides clear conext to search users. This is OPTIONAL; if not given, only the property values will be displayed. The maximum length is 32 characters. */ - displayLabel?: string; + displayLabel?: string | null; } /** * Represents an item to be pushed to the indexing queue. @@ -1272,19 +1272,19 @@ export namespace cloudsearch_v1 { /** * Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. */ - contentHash?: string; + contentHash?: string | null; /** * Metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. */ - metadataHash?: string; + metadataHash?: string | null; /** * Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes. */ - payload?: string; + payload?: string | null; /** * Queue to which this item belongs to. The <code>default</code> queue is chosen if this field is not specified. The maximum length is 512 characters. */ - queue?: string; + queue?: string | null; /** * Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR. */ @@ -1292,17 +1292,17 @@ export namespace cloudsearch_v1 { /** * Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. */ - structuredDataHash?: string; + structuredDataHash?: string | null; /** * The type of the push operation that defines the push behavior. */ - type?: string; + type?: string | null; } export interface Schema$PushItemRequest { /** * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ - connectorName?: string; + connectorName?: string | null; /** * Common debug options. */ @@ -1313,11 +1313,11 @@ export namespace cloudsearch_v1 { item?: Schema$PushItem; } export interface Schema$QueryInterpretation { - interpretationType?: string; + interpretationType?: string | null; /** * The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NO_RESULTS_FOUND_FOR_USER_QUERY. */ - interpretedQuery?: string; + interpretedQuery?: string | null; } /** * Options to interpret user query. @@ -1326,7 +1326,7 @@ export namespace cloudsearch_v1 { /** * Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources. */ - disableNlInterpretation?: boolean; + disableNlInterpretation?: boolean | null; } /** * Information relevant only to a query entry. @@ -1335,7 +1335,7 @@ export namespace cloudsearch_v1 { /** * True if the text was generated by means other than a previous user search. */ - isSynthetic?: boolean; + isSynthetic?: boolean | null; } /** * The definition of a operator that can be used in a Search/Suggest request. @@ -1344,47 +1344,47 @@ export namespace cloudsearch_v1 { /** * Display name of the operator */ - displayName?: string; + displayName?: string | null; /** * Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator. */ - enumValues?: string[]; + enumValues?: string[] | null; /** * Indicates the operator name that can be used to isolate the property using the greater-than operator. */ - greaterThanOperatorName?: string; + greaterThanOperatorName?: string | null; /** * Can this operator be used to get facets. */ - isFacetable?: boolean; + isFacetable?: boolean | null; /** * Indicates if multiple values can be set for this property. */ - isRepeatable?: boolean; + isRepeatable?: boolean | null; /** * Will the property associated with this facet be returned as part of search results. */ - isReturnable?: boolean; + isReturnable?: boolean | null; /** * Can this operator be used to sort results. */ - isSortable?: boolean; + isSortable?: boolean | null; /** * Can get suggestions for this field. */ - isSuggestable?: boolean; + isSuggestable?: boolean | null; /** * Indicates the operator name that can be used to isolate the property using the less-than operator. */ - lessThanOperatorName?: string; + lessThanOperatorName?: string | null; /** * The name of the operator. */ - operatorName?: string; + operatorName?: string | null; /** * Type of the operator. */ - type?: string; + type?: string | null; } /** * List of sources that the user can search using the query API. @@ -1393,7 +1393,7 @@ export namespace cloudsearch_v1 { /** * Display name of the data source. */ - displayName?: string; + displayName?: string | null; /** * List of all operators applicable for this source. */ @@ -1401,7 +1401,7 @@ export namespace cloudsearch_v1 { /** * A short name or alias for the source. This value can be used with the 'source' operator. */ - shortName?: string; + shortName?: string | null; /** * Name of the source */ @@ -1418,15 +1418,15 @@ export namespace cloudsearch_v1 { /** * Message that describes the error. The maximum allowable length of the message is 8192 characters. */ - errorMessage?: string; + errorMessage?: string | null; /** * Error codes. Matches the definition of HTTP status codes. */ - httpStatusCode?: number; + httpStatusCode?: number | null; /** * Type of error. */ - type?: string; + type?: string | null; } /** * Shared request options for all RPC methods. @@ -1439,15 +1439,15 @@ export namespace cloudsearch_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. */ - languageCode?: string; + languageCode?: string | null; /** * Id of the application created using SearchApplicationsService. */ - searchApplicationId?: string; + searchApplicationId?: string | null; /** - * Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + * Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. */ - timeZone?: string; + timeZone?: string | null; } export interface Schema$ResetSearchApplicationRequest { /** @@ -1462,7 +1462,7 @@ export namespace cloudsearch_v1 { /** * General debug info formatted for display. */ - formattedDebugInfo?: string; + formattedDebugInfo?: string | null; } /** * Information relevant only to a restrict entry. NextId: 12 @@ -1489,7 +1489,7 @@ export namespace cloudsearch_v1 { /** * The search restrict (e.g. "after:2017-09-11 before:2017-09-12"). */ - searchOperator?: string; + searchOperator?: string | null; } /** * Result count information @@ -1507,7 +1507,7 @@ export namespace cloudsearch_v1 { /** * General debug info formatted for display. */ - formattedDebugInfo?: string; + formattedDebugInfo?: string | null; } /** * Display Fields for Search Results @@ -1516,11 +1516,11 @@ export namespace cloudsearch_v1 { /** * The display label for the property. */ - label?: string; + label?: string | null; /** * The operator name of the property. */ - operatorName?: string; + operatorName?: string | null; /** * The name value pair for the property. */ @@ -1540,13 +1540,13 @@ export namespace cloudsearch_v1 { /** * The display label for the object. */ - objectTypeLabel?: string; + objectTypeLabel?: string | null; } export interface Schema$RetrievalImportance { /** * Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed. */ - importance?: string; + importance?: string | null; } /** * The schema definition for a data source. @@ -1559,7 +1559,7 @@ export namespace cloudsearch_v1 { /** * IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content. */ - operationIds?: string[]; + operationIds?: string[] | null; } /** * Scoring configurations for a source while processing a Search or Suggest request. @@ -1568,11 +1568,11 @@ export namespace cloudsearch_v1 { /** * Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI. */ - disableFreshness?: boolean; + disableFreshness?: boolean | null; /** * Whether to personalize the results. By default, personal signals will be used to boost results. */ - disablePersonalization?: boolean; + disablePersonalization?: boolean | null; } /** * SearchApplication @@ -1593,15 +1593,15 @@ export namespace cloudsearch_v1 { /** * Display name of the Search Application. The maximum length is 300 characters. */ - displayName?: string; + displayName?: string | null; /** * Name of the Search Application. <br />Format: searchapplications/{application_id}. */ - name?: string; + name?: string | null; /** * IDs of the Long Running Operations (LROs) currently running for this schema. Output only field. */ - operationIds?: string[]; + operationIds?: string[] | null; /** * Configuration for ranking results. */ @@ -1619,18 +1619,18 @@ export namespace cloudsearch_v1 { /** * The next_page_token value returned from a previous request, if any. */ - pageToken?: string; + pageToken?: string | null; /** * Specify the full view URL to find the corresponding item. The maximum length is 2048 characters. */ - viewUrl?: string; + viewUrl?: string | null; } export interface Schema$SearchItemsByViewUrlResponse { items?: Schema$Item[]; /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Additional search quality metadata of the item. @@ -1639,7 +1639,7 @@ export namespace cloudsearch_v1 { /** * An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0. */ - quality?: number; + quality?: number | null; } /** * The search API request. @@ -1653,11 +1653,11 @@ export namespace cloudsearch_v1 { /** * Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. */ - pageSize?: number; + pageSize?: number | null; /** * The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/) */ - query?: string; + query?: string | null; /** * Options to interpret the user query. */ @@ -1673,7 +1673,7 @@ export namespace cloudsearch_v1 { /** * Starting index of the results. */ - start?: number; + start?: number | null; } /** * The search API response. @@ -1694,7 +1694,7 @@ export namespace cloudsearch_v1 { /** * Whether there are more search results matching the query. */ - hasMoreResults?: boolean; + hasMoreResults?: boolean | null; /** * Query interpretation result for user query. Empty if query interpretation is disabled. */ @@ -1702,11 +1702,11 @@ export namespace cloudsearch_v1 { /** * The estimated result count for this query. */ - resultCountEstimate?: string; + resultCountEstimate?: string | null; /** * The exact result count for this query. */ - resultCountExact?: string; + resultCountExact?: string | null; /** * Expanded result count information. */ @@ -1747,11 +1747,11 @@ export namespace cloudsearch_v1 { /** * Title of the search result. */ - title?: string; + title?: string | null; /** * The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed. */ - url?: string; + url?: string | null; } /** * Snippet of the search result, which summarizes the content of the resulting page. @@ -1764,17 +1764,17 @@ export namespace cloudsearch_v1 { /** * The snippet of the document. The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering. */ - snippet?: string; + snippet?: string | null; } export interface Schema$SortOptions { /** * Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable. */ - operatorName?: string; + operatorName?: string | null; /** * Ascending is the default sort order */ - sortOrder?: string; + sortOrder?: string | null; } /** * Defines sources for the suggest/search APIs. @@ -1783,11 +1783,11 @@ export namespace cloudsearch_v1 { /** * Source name for content indexed by the Indexing API. */ - name?: string; + name?: string | null; /** * Predefined content source for Google Apps. */ - predefinedSource?: string; + predefinedSource?: string | null; } /** * Configurations for a source while processing a Search or Suggest request. @@ -1813,11 +1813,11 @@ export namespace cloudsearch_v1 { /** * Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0. */ - numResults?: number; + numResults?: number | null; /** * Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0. */ - numSuggestions?: number; + numSuggestions?: number | null; } /** * Per source result count information. @@ -1826,15 +1826,15 @@ export namespace cloudsearch_v1 { /** * Whether there are more search results for this source. */ - hasMoreResults?: boolean; + hasMoreResults?: boolean | null; /** * The estimated result count for this source. */ - resultCountEstimate?: string; + resultCountEstimate?: string | null; /** * The exact result count for this source. */ - resultCountExact?: string; + resultCountExact?: string | null; /** * The source the result count information is associated with. */ @@ -1847,13 +1847,13 @@ export namespace cloudsearch_v1 { /** * Importance of the source. */ - sourceImportance?: string; + sourceImportance?: string | null; } export interface Schema$SpellResult { /** * The suggested spelling of the query. */ - suggestedQuery?: string; + suggestedQuery?: string | null; } /** * Start upload file request. @@ -1862,7 +1862,7 @@ export namespace cloudsearch_v1 { /** * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ - connectorName?: string; + connectorName?: string | null; /** * Common debug options. */ @@ -1875,15 +1875,15 @@ export namespace cloudsearch_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A structured data object consisting of named properties. @@ -1914,7 +1914,7 @@ export namespace cloudsearch_v1 { /** * Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", "seagull" and so on. */ - query?: string; + query?: string | null; /** * Request options, such as the search application and user timezone. */ @@ -1948,7 +1948,7 @@ export namespace cloudsearch_v1 { /** * The suggested query that will be used for search, when the user clicks on the suggestion */ - suggestedQuery?: string; + suggestedQuery?: string | null; } /** * Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. @@ -1957,11 +1957,11 @@ export namespace cloudsearch_v1 { /** * If true, the text value will be tokenized as one atomic value in operator searches and facet matches. For example, if the operator name is "genre" and the value is "science-fiction" the query restrictions "genre:science" and "genre:fiction" will not match the item; "genre:science-fiction" will. Value matching is case-sensitive and does not remove special characters. If false, the text will be tokenized. For example, if the value is "science-fiction" the queries "genre:science" and "genre:fiction" will match the item. */ - exactMatchWithOperator?: boolean; + exactMatchWithOperator?: boolean | null; /** * Indicates the operator name required in the query in order to isolate the text property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:&lt;value&gt;* will show results only where the value of the property named *subjectLine* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any text properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for text properties. @@ -1983,7 +1983,7 @@ export namespace cloudsearch_v1 { /** * The maximum allowable length for text values is 2048 characters. */ - values?: string[]; + values?: string[] | null; } /** * Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. @@ -1992,15 +1992,15 @@ export namespace cloudsearch_v1 { /** * Indicates the operator name required in the query in order to isolate the timestamp property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:&lt;value&gt;* will show results only where the value of the property named *closeDate* is later than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - greaterThanOperatorName?: string; + greaterThanOperatorName?: string | null; /** * Indicates the operator name required in the query in order to isolate the timestamp property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:&lt;value&gt;* will show results only where the value of the property named *closeDate* is earlier than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - lessThanOperatorName?: string; + lessThanOperatorName?: string | null; /** * Indicates the operator name required in the query in order to isolate the timestamp property. For example, if operatorName is *closedon* and the property's name is *closeDate*, then queries like *closedon:&lt;value&gt;* will show results only where the value of the property named *closeDate* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ - operatorName?: string; + operatorName?: string | null; } /** * Options for timestamp properties. @@ -2015,7 +2015,7 @@ export namespace cloudsearch_v1 { * List of timestamp values. */ export interface Schema$TimestampValues { - values?: string[]; + values?: string[] | null; } export interface Schema$UnmappedIdentity { /** @@ -2025,13 +2025,13 @@ export namespace cloudsearch_v1 { /** * The resolution status for the external identity. */ - resolutionStatusCode?: string; + resolutionStatusCode?: string | null; } export interface Schema$UnreserveItemsRequest { /** * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ - connectorName?: string; + connectorName?: string | null; /** * Common debug options. */ @@ -2039,7 +2039,7 @@ export namespace cloudsearch_v1 { /** * Name of a queue to unreserve items from. */ - queue?: string; + queue?: string | null; } export interface Schema$UpdateDataSourceRequest { /** @@ -2060,7 +2060,7 @@ export namespace cloudsearch_v1 { /** * If true, the request will be validated without side effects. */ - validateOnly?: boolean; + validateOnly?: boolean | null; } /** * Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. @@ -2069,24 +2069,24 @@ export namespace cloudsearch_v1 { /** * Name of the content reference. The maximum length is 2048 characters. */ - name?: string; + name?: string | null; } /** * Definition of a single value with generic type. */ export interface Schema$Value { - booleanValue?: boolean; + booleanValue?: boolean | null; dateValue?: Schema$Date; - doubleValue?: number; - integerValue?: string; - stringValue?: string; - timestampValue?: string; + doubleValue?: number | null; + integerValue?: string | null; + stringValue?: string | null; + timestampValue?: string | null; } export interface Schema$ValueFilter { /** * The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: <br/><br/> 1. `operator_name`, where the query filters results by the property that matches the value. <br/> 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query. */ - operatorName?: string; + operatorName?: string | null; /** * The value to be compared with. */ @@ -4269,7 +4269,7 @@ export namespace cloudsearch_v1 { * @param {boolean=} params.requestOptions.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string=} params.requestOptions.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. * @param {string=} params.requestOptions.searchApplicationId Id of the application created using SearchApplicationsService. - * @param {string=} params.requestOptions.timeZone Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + * @param {string=} params.requestOptions.timeZone Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4360,7 +4360,7 @@ export namespace cloudsearch_v1 { */ 'requestOptions.searchApplicationId'?: string; /** - * Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + * Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. */ 'requestOptions.timeZone'?: string; } diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index 63b75922a2b..9bd71b6bb66 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -132,15 +132,15 @@ export namespace cloudshell_v1 { /** * Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". */ - dockerImage?: string; + dockerImage?: string | null; /** * Output only. The environment's identifier, which is always "default". */ - id?: string; + id?: string | null; /** * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. */ - name?: string; + name?: string | null; /** * Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods. */ @@ -148,23 +148,23 @@ export namespace cloudshell_v1 { /** * Output only. Host to which clients can connect to initiate SSH sessions with the environment. */ - sshHost?: string; + sshHost?: string | null; /** * Output only. Port to which clients can connect to initiate SSH sessions with the environment. */ - sshPort?: number; + sshPort?: number | null; /** * Output only. Username that clients should use when initiating SSH sessions with the environment. */ - sshUsername?: string; + sshUsername?: string | null; /** * Output only. Current execution state of this environment. */ - state?: string; + state?: string | null; /** * Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. */ - webHost?: string; + webHost?: string | null; } /** * The response message for Operations.ListOperations. @@ -173,7 +173,7 @@ export namespace cloudshell_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -186,7 +186,7 @@ export namespace cloudshell_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -194,15 +194,15 @@ export namespace cloudshell_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A public SSH key, corresponding to a private SSH key held by the client. @@ -211,15 +211,15 @@ export namespace cloudshell_v1 { /** * Required. Format of this key's content. */ - format?: string; + format?: string | null; /** * Required. Content of this key. */ - key?: string; + key?: string | null; /** * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`. */ - name?: string; + name?: string | null; } /** * Message included in the metadata field of operations returned from StartEnvironment. @@ -228,7 +228,7 @@ export namespace cloudshell_v1 { /** * Current state of the environment being started. */ - state?: string; + state?: string | null; } /** * Message included in the response field of operations returned from StartEnvironment once the operation is complete. @@ -246,15 +246,15 @@ export namespace cloudshell_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Operations { diff --git a/src/apis/cloudshell/v1alpha1.ts b/src/apis/cloudshell/v1alpha1.ts index f5b59f3f3c7..23bb90b8b16 100644 --- a/src/apis/cloudshell/v1alpha1.ts +++ b/src/apis/cloudshell/v1alpha1.ts @@ -124,15 +124,15 @@ export namespace cloudshell_v1alpha1 { /** * The OAuth access token that should be sent to the environment. */ - accessToken?: string; + accessToken?: string | null; /** * The time when the credentials expire. If not set, defaults to one hour from when the server received the request. */ - expireTime?: string; + expireTime?: string | null; /** * The OAuth ID token that should be sent to the environment. */ - idToken?: string; + idToken?: string | null; } /** * Request message for CreatePublicKey. @@ -154,15 +154,15 @@ export namespace cloudshell_v1alpha1 { /** * Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". */ - dockerImage?: string; + dockerImage?: string | null; /** * Output only. The environment's identifier, which is always "default". */ - id?: string; + id?: string | null; /** * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. */ - name?: string; + name?: string | null; /** * Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods. */ @@ -170,23 +170,23 @@ export namespace cloudshell_v1alpha1 { /** * Output only. Host to which clients can connect to initiate SSH sessions with the environment. */ - sshHost?: string; + sshHost?: string | null; /** * Output only. Port to which clients can connect to initiate SSH sessions with the environment. */ - sshPort?: number; + sshPort?: number | null; /** * Output only. Username that clients should use when initiating SSH sessions with the environment. */ - sshUsername?: string; + sshUsername?: string | null; /** * Output only. Current execution state of this environment. */ - state?: string; + state?: string | null; /** * Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. */ - webHost?: string; + webHost?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -195,7 +195,7 @@ export namespace cloudshell_v1alpha1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -203,15 +203,15 @@ export namespace cloudshell_v1alpha1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A public SSH key, corresponding to a private SSH key held by the client. @@ -220,15 +220,15 @@ export namespace cloudshell_v1alpha1 { /** * Required. Format of this key's content. */ - format?: string; + format?: string | null; /** * Required. Content of this key. */ - key?: string; + key?: string | null; /** * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`. */ - name?: string; + name?: string | null; } /** * Message included in the metadata field of operations returned from StartEnvironment. @@ -237,7 +237,7 @@ export namespace cloudshell_v1alpha1 { /** * Current state of the environment being started. */ - state?: string; + state?: string | null; } /** * Request message for StartEnvironment. @@ -246,7 +246,7 @@ export namespace cloudshell_v1alpha1 { /** * The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment. */ - accessToken?: string; + accessToken?: string | null; } /** * Message included in the response field of operations returned from StartEnvironment once the operation is complete. @@ -264,15 +264,15 @@ export namespace cloudshell_v1alpha1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Users { diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 2f35458b8a2..19da417b9d6 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -128,19 +128,19 @@ export namespace cloudtasks_v2 { /** * HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod. */ - body?: string; + 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. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). */ - httpMethod?: string; + httpMethod?: string | null; /** * The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ - relativeUri?: string; + relativeUri?: string | null; } /** * App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). Using AppEngineRouting requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` @@ -149,19 +149,19 @@ export namespace cloudtasks_v2 { /** * Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example <app-id>.appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). */ - host?: string; + host?: string | null; /** * App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ - instance?: string; + instance?: string | null; /** * App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ - service?: string; + service?: string | null; /** * App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ - version?: string; + version?: string | null; } /** * The status of a task attempt. @@ -170,7 +170,7 @@ export namespace cloudtasks_v2 { /** * Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. */ - dispatchTime?: string; + dispatchTime?: string | null; /** * Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless. */ @@ -178,11 +178,11 @@ export namespace cloudtasks_v2 { /** * Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. */ - responseTime?: string; + responseTime?: string | null; /** * Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Associates `members` with a `role`. @@ -195,11 +195,11 @@ export namespace cloudtasks_v2 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Request message for CreateTask. @@ -208,7 +208,7 @@ export namespace cloudtasks_v2 { /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; /** * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ @@ -225,19 +225,19 @@ export namespace cloudtasks_v2 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -253,9 +253,9 @@ export namespace cloudtasks_v2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * The response message for Locations.ListLocations. @@ -268,7 +268,7 @@ export namespace cloudtasks_v2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for ListQueues. @@ -277,7 +277,7 @@ export namespace cloudtasks_v2 { /** * A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of queues. */ @@ -290,7 +290,7 @@ export namespace cloudtasks_v2 { /** * A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of tasks. */ @@ -303,23 +303,23 @@ export namespace cloudtasks_v2 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Request message for PauseQueue. @@ -336,11 +336,11 @@ export namespace cloudtasks_v2 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for PurgeQueue. @@ -357,11 +357,11 @@ export namespace cloudtasks_v2 { /** * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ - name?: string; + name?: string | null; /** * Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. */ - purgeTime?: string; + purgeTime?: string | null; /** * Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. */ @@ -373,7 +373,7 @@ export namespace cloudtasks_v2 { /** * Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */ - state?: string; + state?: string | null; } /** * Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. @@ -382,15 +382,15 @@ export namespace cloudtasks_v2 { /** * Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. */ - maxBurstSize?: number; + maxBurstSize?: number | null; /** * The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). */ - maxConcurrentDispatches?: number; + maxConcurrentDispatches?: number | null; /** * The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). */ - maxDispatchesPerSecond?: number; + maxDispatchesPerSecond?: number | null; } /** * Request message for ResumeQueue. @@ -403,23 +403,23 @@ export namespace cloudtasks_v2 { /** * Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxAttempts?: number; + maxAttempts?: number | null; /** * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxBackoff?: string; + maxBackoff?: string | null; /** * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxDoublings?: number; + maxDoublings?: number | null; /** * If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxRetryDuration?: string; + maxRetryDuration?: string | null; /** * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - minBackoff?: string; + minBackoff?: string | null; } /** * Request message for forcing a task to run now using RunTask. @@ -428,7 +428,7 @@ export namespace cloudtasks_v2 { /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -446,15 +446,15 @@ export namespace cloudtasks_v2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A unit of scheduled work. @@ -467,15 +467,15 @@ export namespace cloudtasks_v2 { /** * Output only. The time that the task was created. `create_time` will be truncated to the nearest second. */ - createTime?: string; + createTime?: string | null; /** * Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. */ - dispatchCount?: number; + dispatchCount?: number | null; /** * The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. */ - dispatchDeadline?: string; + dispatchDeadline?: string | null; /** * Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks. */ @@ -487,19 +487,19 @@ export namespace cloudtasks_v2 { /** * Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ - name?: string; + name?: string | null; /** * Output only. The number of attempts which have received a response. */ - responseCount?: number; + responseCount?: number | null; /** * The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. */ - scheduleTime?: string; + scheduleTime?: string | null; /** * Output only. The view specifies which subset of the Task has been returned. */ - view?: string; + view?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -508,7 +508,7 @@ export namespace cloudtasks_v2 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -517,7 +517,7 @@ export namespace cloudtasks_v2 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$Projects { diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 27db82eb170..b733d9f0d7d 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -124,7 +124,7 @@ export namespace cloudtasks_v2beta2 { /** * Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. @@ -137,19 +137,19 @@ export namespace cloudtasks_v2beta2 { /** * 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 payload, 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. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). */ - httpMethod?: string; + httpMethod?: string | null; /** * Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod. */ - payload?: string; + payload?: string | null; /** * The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ - relativeUrl?: string; + relativeUrl?: string | null; } /** * App Engine HTTP target. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed. Using AppEngineHttpTarget requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` @@ -167,19 +167,19 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The host that the task is sent to. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]`</br> `| [service] + '.' + [application_domain_name]`</br> `| [version] + '.' + [application_domain_name]`</br> `| [version_dot_service]+ '.' + [application_domain_name]`</br> `| [instance] + '.' + [application_domain_name]`</br> `| [instance_dot_service] + '.' + [application_domain_name]`</br> `| [instance_dot_version] + '.' + [application_domain_name]`</br> `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example <app-id>.appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. */ - host?: string; + host?: string | null; /** * App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ - instance?: string; + instance?: string | null; /** * App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ - service?: string; + service?: string | null; /** * App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ - version?: string; + version?: string | null; } /** * The status of a task attempt. @@ -188,7 +188,7 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. */ - dispatchTime?: string; + dispatchTime?: string | null; /** * Output only. The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset. */ @@ -196,11 +196,11 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. */ - responseTime?: string; + responseTime?: string | null; /** * Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Associates `members` with a `role`. @@ -213,11 +213,11 @@ export namespace cloudtasks_v2beta2 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Request message for canceling a lease using CancelLease. @@ -226,11 +226,11 @@ export namespace cloudtasks_v2beta2 { /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; /** * Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Request message for CreateTask. @@ -239,7 +239,7 @@ export namespace cloudtasks_v2beta2 { /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; /** * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or completed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or completed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ @@ -256,19 +256,19 @@ export namespace cloudtasks_v2beta2 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -284,9 +284,9 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * Request message for leasing tasks using LeaseTasks. @@ -295,19 +295,19 @@ export namespace cloudtasks_v2beta2 { /** * `filter` can be used to specify a subset of tasks to lease. When `filter` is set to `tag=<my-tag>` then the response will contain only tasks whose tag is equal to `<my-tag>`. `<my-tag>` must be less than 500 characters. When `filter` is set to `tag_function=oldest_tag()`, only tasks which have the same tag as the task with the oldest schedule_time will be returned. Grammar Syntax: * `filter = "tag=" tag | "tag_function=" function` * `tag = string` * `function = "oldest_tag()"` The `oldest_tag()` function returns tasks which have the same tag as the oldest task (ordered by schedule time). SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the filter and the task's tag will be displayed as empty in Cloud Tasks. */ - filter?: string; + filter?: string | null; /** * Required. The duration of the lease. Each task returned in the response will have its schedule_time set to the current time plus the `lease_duration`. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time. After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. */ - leaseDuration?: string; + leaseDuration?: string | null; /** * The maximum number of tasks to lease. The system will make a best effort to return as close to as `max_tasks` as possible. The largest that `max_tasks` can be is 1000. The maximum total size of a lease tasks response is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned. */ - maxTasks?: number; + maxTasks?: number | null; /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; } /** * Response message for leasing tasks using LeaseTasks. @@ -329,7 +329,7 @@ export namespace cloudtasks_v2beta2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for ListQueues. @@ -338,7 +338,7 @@ export namespace cloudtasks_v2beta2 { /** * A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of queues. */ @@ -351,7 +351,7 @@ export namespace cloudtasks_v2beta2 { /** * A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of tasks. */ @@ -364,23 +364,23 @@ export namespace cloudtasks_v2beta2 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Request message for PauseQueue. @@ -397,11 +397,11 @@ export namespace cloudtasks_v2beta2 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. @@ -410,11 +410,11 @@ export namespace cloudtasks_v2beta2 { /** * A data payload consumed by the worker to execute the task. */ - payload?: string; + payload?: string | null; /** * The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. */ - tag?: string; + tag?: string | null; } /** * Pull target. @@ -435,7 +435,7 @@ export namespace cloudtasks_v2beta2 { /** * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ - name?: string; + name?: string | null; /** * Pull target. A pull queue is a queue that has a PullTarget. */ @@ -443,7 +443,7 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. */ - purgeTime?: string; + purgeTime?: string | null; /** * Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts however they control how tasks are attempted in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). */ @@ -455,7 +455,7 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */ - state?: string; + state?: string | null; } /** * Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. @@ -464,15 +464,15 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_tasks_dispatched_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_tasks_dispatched_per_second. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_tasks_dispatched_per_second, regardless of whether max_tasks_dispatched_per_second is updated. */ - maxBurstSize?: number; + maxBurstSize?: number | null; /** * The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). */ - maxConcurrentTasks?: number; + maxConcurrentTasks?: number | null; /** * The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). */ - maxTasksDispatchedPerSecond?: number; + maxTasksDispatchedPerSecond?: number | null; } /** * Request message for renewing a lease using RenewLease. @@ -481,15 +481,15 @@ export namespace cloudtasks_v2beta2 { /** * Required. The desired new lease duration, starting from now. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. */ - leaseDuration?: string; + leaseDuration?: string | null; /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; /** * Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Request message for ResumeQueue. @@ -502,27 +502,27 @@ export namespace cloudtasks_v2beta2 { /** * The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. */ - maxAttempts?: number; + maxAttempts?: number | null; /** * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxBackoff?: string; + maxBackoff?: string | null; /** * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxDoublings?: number; + maxDoublings?: number | null; /** * If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxRetryDuration?: string; + maxRetryDuration?: string | null; /** * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - minBackoff?: string; + minBackoff?: string | null; /** * If true, then the number of attempts is unlimited. */ - unlimitedAttempts?: boolean; + unlimitedAttempts?: boolean | null; } /** * Request message for forcing a task to run now using RunTask. @@ -531,7 +531,7 @@ export namespace cloudtasks_v2beta2 { /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -549,15 +549,15 @@ export namespace cloudtasks_v2beta2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A unit of scheduled work. @@ -570,11 +570,11 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The time that the task was created. `create_time` will be truncated to the nearest second. */ - createTime?: string; + createTime?: string | null; /** * Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ - name?: string; + name?: string | null; /** * LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. */ @@ -582,7 +582,7 @@ export namespace cloudtasks_v2beta2 { /** * The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. */ - scheduleTime?: string; + scheduleTime?: string | null; /** * Output only. The task status. */ @@ -590,7 +590,7 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The view specifies which subset of the Task has been returned. */ - view?: string; + view?: string | null; } /** * Status of the task. @@ -599,11 +599,11 @@ export namespace cloudtasks_v2beta2 { /** * Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. */ - attemptDispatchCount?: number; + attemptDispatchCount?: number | null; /** * Output only. The number of attempts which have received a response. This field is not calculated for pull tasks. */ - attemptResponseCount?: number; + attemptResponseCount?: number | null; /** * Output only. The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks. */ @@ -620,7 +620,7 @@ export namespace cloudtasks_v2beta2 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -629,7 +629,7 @@ export namespace cloudtasks_v2beta2 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$Projects { diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 7973f96c9cc..7edfe84a084 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -137,19 +137,19 @@ export namespace cloudtasks_v2beta3 { /** * HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod. */ - body?: string; + 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. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). */ - httpMethod?: string; + httpMethod?: string | null; /** * The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ - relativeUri?: string; + relativeUri?: string | null; } /** * App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). @@ -158,19 +158,19 @@ export namespace cloudtasks_v2beta3 { /** * Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example <app-id>.appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). */ - host?: string; + host?: string | null; /** * App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ - instance?: string; + instance?: string | null; /** * App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ - service?: string; + service?: string | null; /** * App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ - version?: string; + version?: string | null; } /** * The status of a task attempt. @@ -179,7 +179,7 @@ export namespace cloudtasks_v2beta3 { /** * Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. */ - dispatchTime?: string; + dispatchTime?: string | null; /** * Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless. */ @@ -187,11 +187,11 @@ export namespace cloudtasks_v2beta3 { /** * Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. */ - responseTime?: string; + responseTime?: string | null; /** * Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Associates `members` with a `role`. @@ -204,11 +204,11 @@ export namespace cloudtasks_v2beta3 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Request message for CreateTask. @@ -217,7 +217,7 @@ export namespace cloudtasks_v2beta3 { /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; /** * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ @@ -234,19 +234,19 @@ export namespace cloudtasks_v2beta3 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -262,26 +262,26 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + 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 backoffs 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 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). */ export interface Schema$HttpRequest { /** * HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. */ - body?: string; + body?: string | null; /** * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * X-Google-*: Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The HTTP method to use for the request. The default is POST. */ - httpMethod?: string; + httpMethod?: string | null; /** * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */ @@ -293,7 +293,7 @@ export namespace cloudtasks_v2beta3 { /** * Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. */ - url?: string; + url?: string | null; } /** * The response message for Locations.ListLocations. @@ -306,7 +306,7 @@ export namespace cloudtasks_v2beta3 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for ListQueues. @@ -315,7 +315,7 @@ export namespace cloudtasks_v2beta3 { /** * A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of queues. */ @@ -328,7 +328,7 @@ export namespace cloudtasks_v2beta3 { /** * A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of tasks. */ @@ -341,23 +341,23 @@ export namespace cloudtasks_v2beta3 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. @@ -366,11 +366,11 @@ export namespace cloudtasks_v2beta3 { /** * OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. */ - scope?: string; + scope?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. @@ -379,11 +379,11 @@ export namespace cloudtasks_v2beta3 { /** * Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. */ - audience?: string; + audience?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Request message for PauseQueue. @@ -400,11 +400,11 @@ export namespace cloudtasks_v2beta3 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for PurgeQueue. @@ -421,11 +421,11 @@ export namespace cloudtasks_v2beta3 { /** * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ - name?: string; + name?: string | null; /** * Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. */ - purgeTime?: string; + purgeTime?: string | null; /** * Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. */ @@ -441,7 +441,7 @@ export namespace cloudtasks_v2beta3 { /** * Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */ - state?: string; + state?: string | null; } /** * Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. @@ -450,15 +450,15 @@ export namespace cloudtasks_v2beta3 { /** * Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. */ - maxBurstSize?: number; + maxBurstSize?: number | null; /** * The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). */ - maxConcurrentDispatches?: number; + maxConcurrentDispatches?: number | null; /** * The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). */ - maxDispatchesPerSecond?: number; + maxDispatchesPerSecond?: number | null; } /** * Request message for ResumeQueue. @@ -471,23 +471,23 @@ export namespace cloudtasks_v2beta3 { /** * Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxAttempts?: number; + maxAttempts?: number | null; /** * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxBackoff?: string; + maxBackoff?: string | null; /** * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxDoublings?: number; + maxDoublings?: number | null; /** * If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - maxRetryDuration?: string; + maxRetryDuration?: string | null; /** * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ - minBackoff?: string; + minBackoff?: string | null; } /** * Request message for forcing a task to run now using RunTask. @@ -496,7 +496,7 @@ export namespace cloudtasks_v2beta3 { /** * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ - responseView?: string; + responseView?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -514,7 +514,7 @@ export namespace cloudtasks_v2beta3 { /** * Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. */ - samplingRatio?: number; + samplingRatio?: number | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -523,15 +523,15 @@ export namespace cloudtasks_v2beta3 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A unit of scheduled work. @@ -544,15 +544,15 @@ export namespace cloudtasks_v2beta3 { /** * Output only. The time that the task was created. `create_time` will be truncated to the nearest second. */ - createTime?: string; + createTime?: string | null; /** * Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. */ - dispatchCount?: number; + dispatchCount?: number | null; /** * The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. */ - dispatchDeadline?: string; + dispatchDeadline?: string | null; /** * Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks. */ @@ -568,19 +568,19 @@ export namespace cloudtasks_v2beta3 { /** * Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ - name?: string; + name?: string | null; /** * Output only. The number of attempts which have received a response. */ - responseCount?: number; + responseCount?: number | null; /** * The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. */ - scheduleTime?: string; + scheduleTime?: string | null; /** * Output only. The view specifies which subset of the Task has been returned. */ - view?: string; + view?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -589,7 +589,7 @@ export namespace cloudtasks_v2beta3 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -598,7 +598,7 @@ export namespace cloudtasks_v2beta3 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$Projects { diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index ac79204927d..4887e654cc8 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -128,7 +128,7 @@ export namespace cloudtrace_v1 { /** * If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of trace records as specified by the view parameter. */ @@ -141,7 +141,7 @@ export namespace cloudtrace_v1 { /** * Project ID of the Cloud project where the trace data is stored. */ - projectId?: string; + projectId?: string | null; /** * Collection of spans in the trace. */ @@ -149,7 +149,7 @@ export namespace cloudtrace_v1 { /** * Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. */ - traceId?: string; + traceId?: string | null; } /** * List of new or updated traces. @@ -167,31 +167,31 @@ export namespace cloudtrace_v1 { /** * End time of the span in nanoseconds from the UNIX epoch. */ - endTime?: string; + endTime?: string | null; /** * Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. */ - kind?: string; + kind?: string | null; /** * Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: * `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: * `/agent` * `/component` * `/error/message` * `/error/name` * `/http/client_city` * `/http/client_country` * `/http/client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * `/stacktrace` * `/tid` */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. */ - name?: string; + name?: string | null; /** * ID of the parent span, if any. Optional. */ - parentSpanId?: string; + parentSpanId?: string | null; /** * Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. */ - spanId?: string; + spanId?: string | null; /** * Start time of the span in nanoseconds from the UNIX epoch. */ - startTime?: string; + startTime?: string | null; } export class Resource$Projects { diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 68454994544..6889fffcc6f 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -137,11 +137,11 @@ export namespace cloudtrace_v2 { /** * The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true */ - attributeMap?: {[key: string]: Schema$AttributeValue}; + attributeMap?: {[key: string]: Schema$AttributeValue} | null; /** * The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. */ - droppedAttributesCount?: number; + droppedAttributesCount?: number | null; } /** * The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute. @@ -150,11 +150,11 @@ export namespace cloudtrace_v2 { /** * A Boolean value represented by `true` or `false`. */ - boolValue?: boolean; + boolValue?: boolean | null; /** * A 64-bit signed integer. */ - intValue?: string; + intValue?: string | null; /** * A string up to 256 bytes long. */ @@ -184,15 +184,15 @@ export namespace cloudtrace_v2 { /** * The [SPAN_ID] for a span within a trace. */ - spanId?: string; + spanId?: string | null; /** * The [TRACE_ID] for a trace within a project. */ - traceId?: string; + traceId?: string | null; /** * The relationship of the current span relative to the linked span. */ - type?: string; + type?: string | null; } /** * A collection of links, which are references from this span to a span in the same or different trace. @@ -201,7 +201,7 @@ export namespace cloudtrace_v2 { /** * The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped. */ - droppedLinksCount?: number; + droppedLinksCount?: number | null; /** * A collection of links. */ @@ -214,19 +214,19 @@ export namespace cloudtrace_v2 { /** * The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed. */ - compressedSizeBytes?: string; + compressedSizeBytes?: string | null; /** * An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span. */ - id?: string; + id?: string | null; /** * Type of MessageEvent. Indicates whether the message was sent or received. */ - type?: string; + type?: string | null; /** * The number of uncompressed bytes sent or received. */ - uncompressedSizeBytes?: string; + uncompressedSizeBytes?: string | null; } /** * Binary module. @@ -252,7 +252,7 @@ export namespace cloudtrace_v2 { /** * An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. */ - childSpanCount?: number; + 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. */ @@ -260,7 +260,7 @@ export namespace cloudtrace_v2 { /** * 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; + endTime?: string | null; /** * Links associated with the span. You can have up to 128 links per Span. */ @@ -268,23 +268,23 @@ export namespace cloudtrace_v2 { /** * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ - name?: string; + name?: string | null; /** * The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. */ - parentSpanId?: string; + parentSpanId?: string | null; /** * (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information. */ - sameProcessAsParentSpan?: boolean; + sameProcessAsParentSpan?: boolean | null; /** * The [SPAN_ID] portion of the span's resource name. */ - spanId?: string; + spanId?: string | null; /** * Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call. */ - spanKind?: string; + spanKind?: string | null; /** * Stack trace captured at the start of the span. */ @@ -292,7 +292,7 @@ export namespace cloudtrace_v2 { /** * 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; + startTime?: string | null; /** * An optional final status for this span. */ @@ -309,7 +309,7 @@ export namespace cloudtrace_v2 { /** * The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions. */ - columnNumber?: string; + columnNumber?: string | null; /** * The name of the source file where the function call appears (up to 256 bytes). */ @@ -321,7 +321,7 @@ export namespace cloudtrace_v2 { /** * The line number in `file_name` where the function call appears. */ - lineNumber?: string; + lineNumber?: string | null; /** * The binary module from where the code was loaded. */ @@ -342,7 +342,7 @@ export namespace cloudtrace_v2 { /** * The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped. */ - droppedFramesCount?: number; + droppedFramesCount?: number | null; /** * Stack frames in this call stack. */ @@ -359,7 +359,7 @@ export namespace cloudtrace_v2 { /** * The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`. */ - stackTraceHashId?: string; + stackTraceHashId?: 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). @@ -368,15 +368,15 @@ export namespace cloudtrace_v2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A time-stamped annotation or message event in the Span. @@ -393,7 +393,7 @@ export namespace cloudtrace_v2 { /** * The timestamp indicating the time the event occurred. */ - time?: string; + time?: string | null; } /** * A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. @@ -402,11 +402,11 @@ export namespace cloudtrace_v2 { /** * The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. */ - droppedAnnotationsCount?: number; + droppedAnnotationsCount?: number | null; /** * The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. */ - droppedMessageEventsCount?: number; + droppedMessageEventsCount?: number | null; /** * A collection of `TimeEvent`s. */ @@ -419,11 +419,11 @@ export namespace cloudtrace_v2 { /** * The number of bytes removed from the original string. If this value is 0, then the string was not shortened. */ - truncatedByteCount?: number; + truncatedByteCount?: number | null; /** * The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. */ - value?: string; + value?: string | null; } export class Resource$Projects { diff --git a/src/apis/commentanalyzer/v1alpha1.ts b/src/apis/commentanalyzer/v1alpha1.ts index e693dc1eb60..0b7d60b0eb4 100644 --- a/src/apis/commentanalyzer/v1alpha1.ts +++ b/src/apis/commentanalyzer/v1alpha1.ts @@ -124,7 +124,7 @@ export namespace commentanalyzer_v1alpha1 { /** * Opaque token that is echoed from the request to the response. */ - clientToken?: string; + clientToken?: string | null; /** * The comment to analyze. */ @@ -132,7 +132,7 @@ export namespace commentanalyzer_v1alpha1 { /** * Optional identifier associating this AnalyzeCommentRequest with a particular client's community. Different communities may have different norms and rules. Specifying this value enables us to explore building community-specific models for clients. */ - communityId?: string; + communityId?: string | null; /** * The context of the comment. */ @@ -140,23 +140,23 @@ export namespace commentanalyzer_v1alpha1 { /** * Do not store the comment or context sent in this request. By default, the service may store comments/context for debugging purposes. */ - doNotStore?: boolean; + doNotStore?: boolean | null; /** * The language(s) of the comment and context (if none are specified, the language is automatically detected). If multiple languages are specified, the text is checked in all of them that are supported. Both ISO and BCP-47 language codes are accepted. Current Language Restrictions: * Only English text ("en") is supported. If none of the languages specified by the caller are supported, an `UNIMPLEMENTED` error is returned. */ - languages?: string[]; + languages?: string[] | null; /** * Specification of requested attributes. The AttributeParameters serve as configuration for each associated attribute. The map keys are attribute names. The following attributes are available: "ATTACK_ON_AUTHOR" - Attack on author of original article or post. "ATTACK_ON_COMMENTER" - Attack on fellow commenter. "ATTACK_ON_PUBLISHER" - Attack on publisher of article/post. "INCOHERENT" - Difficult to understand, nonsensical. "INFLAMMATORY" - Intending to provoke or inflame. "OBSCENE" - Obscene, such as cursing. "OFF_TOPIC" - Not related to the original topic. "SPAM" - Commercial/advertising spam content. "UNSUBSTANTIAL" - Trivial. */ - requestedAttributes?: {[key: string]: Schema$AttributeParameters}; + requestedAttributes?: {[key: string]: Schema$AttributeParameters} | null; /** * Session ID. Used to join related RPCs into a single session. For example, an interactive tool that calls both the AnalyzeComment and SuggestCommentScore RPCs should set all invocations of both RPCs to the same Session ID, typically a random 64-bit integer. */ - sessionId?: string; + sessionId?: string | null; /** * An advisory parameter that will return span annotations if the model is capable of providing scores with sub-comment resolution. This will likely increase the size of the returned message. */ - spanAnnotations?: boolean; + spanAnnotations?: boolean | null; } /** * The comment analysis response message. @@ -165,19 +165,19 @@ export namespace commentanalyzer_v1alpha1 { /** * Scores for the requested attributes. The map keys are attribute names (same as the requested_attribute field in AnalyzeCommentRequest, for example "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc). */ - attributeScores?: {[key: string]: Schema$AttributeScores}; + attributeScores?: {[key: string]: Schema$AttributeScores} | null; /** * Same token from the original AnalyzeCommentRequest. */ - clientToken?: string; + clientToken?: string | null; /** * Contains the languages detected from the text content, sorted in order of likelihood. */ - detectedLanguages?: string[]; + detectedLanguages?: string[] | null; /** * The language(s) used by CommentAnalyzer service to choose which Model to use when analyzing the comment. Might better be called "effective_languages". The logic used to make the choice is as follows: if Request.languages.empty() effective_languages = detected_languages else effective_languages = Request.languages */ - languages?: string[]; + languages?: string[] | null; } /** * A type of context specific to a comment left on a single-threaded comment message board, where comments are either a top level comment or the child of a top level comment. @@ -199,11 +199,11 @@ export namespace commentanalyzer_v1alpha1 { /** * Don't return scores for this attribute that are below this threshold. If unset, a default threshold will be applied. A FloatValue wrapper is used to distinguish between 0 vs. default/unset. */ - scoreThreshold?: number; + scoreThreshold?: number | null; /** * What type of scores to return. If unset, defaults to probability scores. */ - scoreType?: string; + scoreType?: string | null; } /** * This holds score values for a single attribute. It contains both per-span scores as well as an overall summary score.. @@ -238,11 +238,11 @@ export namespace commentanalyzer_v1alpha1 { /** * The type of the above value. */ - type?: string; + type?: string | null; /** * Score value. Semantics described by type below. */ - value?: number; + value?: number | null; } /** * This is a single score for a given span of text. @@ -251,8 +251,8 @@ export namespace commentanalyzer_v1alpha1 { /** * "begin" and "end" describe the span of the original text that the attribute score applies to. The values are the UTF-16 codepoint range. "end" is exclusive. For example, with the text "Hi there", the begin/end pair (0,2) describes the text "Hi". If "begin" and "end" are unset, the score applies to the full text. */ - begin?: number; - end?: number; + begin?: number | null; + end?: number | null; /** * The score value. */ @@ -265,11 +265,11 @@ export namespace commentanalyzer_v1alpha1 { /** * Attribute scores for the comment. The map keys are attribute names, same as the requested_attribute field in AnalyzeCommentRequest (for example "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc.). This field has the same type as the `attribute_scores` field in AnalyzeCommentResponse. To specify an overall attribute score for the entire comment as a whole, use the `summary_score` field of the mapped AttributeScores object. To specify scores on specific subparts of the comment, use the `span_scores` field. All SpanScore objects must have begin and end fields set. All Score objects must be explicitly set (for binary classification, use the score values 0 and 1). If Score objects don't include a ScoreType, `PROBABILITY` is assumed. `attribute_scores` must not be empty. The mapped AttributeScores objects also must not be empty. An `INVALID_ARGUMENT` error is returned for all malformed requests. */ - attributeScores?: {[key: string]: Schema$AttributeScores}; + attributeScores?: {[key: string]: Schema$AttributeScores} | null; /** * Opaque token that is echoed from the request to the response. */ - clientToken?: string; + clientToken?: string | null; /** * The comment being scored. */ @@ -277,7 +277,7 @@ export namespace commentanalyzer_v1alpha1 { /** * Optional identifier associating this comment score suggestion with a particular sub-community. Different communities may have different norms and rules. Specifying this value enables training community-specific models. */ - communityId?: string; + communityId?: string | null; /** * The context of the comment. */ @@ -285,11 +285,11 @@ export namespace commentanalyzer_v1alpha1 { /** * The language(s) of the comment and context (if none are specified, the language is automatically detected). If multiple languages are specified, the text is checked in all of them that are supported. Both ISO and BCP-47 language codes are accepted. Current Language Restrictions: * Only English text ("en") is supported. If none of the languages specified by the caller are supported, an `UNIMPLEMENTED` error is returned. */ - languages?: string[]; + languages?: string[] | null; /** * Session ID. Used to join related RPCs into a single session. For example, an interactive tool that calls both the AnalyzeComment and SuggestCommentScore RPCs should set all invocations of both RPCs to the same Session ID, typically a random 64-bit integer. */ - sessionId?: string; + sessionId?: string | null; } /** * The comment score suggestion response message. @@ -298,15 +298,15 @@ export namespace commentanalyzer_v1alpha1 { /** * Same token from the original SuggestCommentScoreRequest. */ - clientToken?: string; + clientToken?: string | null; /** * The list of languages detected from the comment text. */ - detectedLanguages?: string[]; + detectedLanguages?: string[] | null; /** * The list of languages provided in the request. */ - requestedLanguages?: string[]; + requestedLanguages?: string[] | null; } /** * Represents a body of text. @@ -315,11 +315,11 @@ export namespace commentanalyzer_v1alpha1 { /** * UTF-8 encoded text. */ - text?: string; + text?: string | null; /** * Type of the text field. */ - type?: string; + type?: string | null; } export class Resource$Comments { diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index 6c143be9e7c..37016efcfac 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -132,27 +132,27 @@ export namespace composer_v1 { /** * Output only. The time at which this environment was created. */ - createTime?: string; + createTime?: string | null; /** * Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ - name?: string; + name?: string | null; /** * The current state of the environment. */ - state?: string; + state?: string | null; /** * Output only. The time at which this environment was last modified. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. */ - uuid?: string; + uuid?: string | null; } /** * Configuration information for an environment. @@ -161,15 +161,15 @@ export namespace composer_v1 { /** * Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)). */ - airflowUri?: string; + airflowUri?: string | null; /** * Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix. */ - dagGcsPrefix?: string; + dagGcsPrefix?: string | null; /** * Output only. The Kubernetes Engine cluster used to run this environment. */ - gkeCluster?: string; + gkeCluster?: string | null; /** * The configuration used for the Kubernetes Engine cluster. */ @@ -177,7 +177,7 @@ export namespace composer_v1 { /** * The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. */ - nodeCount?: number; + nodeCount?: number | null; /** * The configuration settings for software inside the environment. */ @@ -190,15 +190,15 @@ export namespace composer_v1 { /** * The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b(.c)" */ - imageVersionId?: string; + imageVersionId?: string | null; /** * Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. */ - isDefault?: boolean; + isDefault?: boolean | null; /** * supported python versions */ - supportedPythonVersions?: string[]; + supportedPythonVersions?: string[] | null; } /** * The environments in a project and location. @@ -211,7 +211,7 @@ export namespace composer_v1 { /** * The page token used to query for the next page if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The ImageVersions in a project and location. @@ -224,7 +224,7 @@ export namespace composer_v1 { /** * The page token used to query for the next page if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -233,7 +233,7 @@ export namespace composer_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -246,35 +246,35 @@ export namespace composer_v1 { /** * Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. */ - diskSizeGb?: number; + diskSizeGb?: number | null; /** * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which to deploy the VMs used to run the Apache Airflow software, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}". This `location` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`) is specified, the location information from the specified field will be propagated to the unspecified field. */ - location?: string; + location?: string | null; /** * Optional. The Compute Engine [machine type](/compute/docs/machine-types) used for cluster instances, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The `machineType` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. The `machineTypeId` must not be a [shared-core machine type](/compute/docs/machine-types#sharedcore). If this field is unspecified, the `machineTypeId` defaults to "n1-standard-1". */ - machineType?: string; + machineType?: string | null; /** * Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/global/networks/{networkId}". [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. */ - network?: string; + network?: string | null; /** * Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. */ - oauthScopes?: string[]; + oauthScopes?: string[] | null; /** * Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location. */ - subnetwork?: string; + subnetwork?: string | null; /** * Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. */ - tags?: string[]; + tags?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -283,7 +283,7 @@ export namespace composer_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -291,15 +291,15 @@ export namespace composer_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Metadata describing an operation. @@ -308,27 +308,27 @@ export namespace composer_v1 { /** * Output only. The time the operation was submitted to the server. */ - createTime?: string; + createTime?: string | null; /** * Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing. */ - endTime?: string; + endTime?: string | null; /** * Output only. The type of operation being performed. */ - operationType?: string; + operationType?: string | null; /** * Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name). */ - resource?: string; + resource?: string | null; /** * Output only. The UUID of the resource being operated on. */ - resourceUuid?: string; + resourceUuid?: string | null; /** * Output only. The current operation state. */ - state?: string; + state?: string | null; } /** * Specifies the selection and configuration of software inside the environment. @@ -337,23 +337,23 @@ export namespace composer_v1 { /** * Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), and cannot be overridden. */ - airflowConfigOverrides?: {[key: string]: string}; + airflowConfigOverrides?: {[key: string]: string} | null; /** * Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` */ - envVariables?: {[key: string]: string}; + envVariables?: {[key: string]: string} | null; /** * The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the version is a [semantic version](https://semver.org) or `latest`. When the patch version is omitted, the current Cloud Composer patch version is selected. When `latest` is provided instead of an explicit version number, the server replaces `latest` with the current Cloud Composer version and stores that version number in the same field. The portion of the image version that follows <em>airflow-</em> is an official Apache Airflow repository [release name](https://github.com/apache/incubator-airflow/releases). See also [Version List](/composer/docs/concepts/versioning/composer-versions). */ - imageVersion?: string; + imageVersion?: string | null; /** * Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value. */ - pypiPackages?: {[key: string]: string}; + pypiPackages?: {[key: string]: string} | null; /** * Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. */ - pythonVersion?: string; + pythonVersion?: 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). @@ -362,15 +362,15 @@ export namespace composer_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index aaac303df3d..f3b7b45f8c2 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -132,27 +132,27 @@ export namespace composer_v1beta1 { /** * Output only. The time at which this environment was created. */ - createTime?: string; + createTime?: string | null; /** * Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ - name?: string; + name?: string | null; /** * The current state of the environment. */ - state?: string; + state?: string | null; /** * Output only. The time at which this environment was last modified. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. */ - uuid?: string; + uuid?: string | null; } /** * Configuration information for an environment. @@ -161,15 +161,15 @@ export namespace composer_v1beta1 { /** * Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)). */ - airflowUri?: string; + airflowUri?: string | null; /** * Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix. */ - dagGcsPrefix?: string; + dagGcsPrefix?: string | null; /** * Output only. The Kubernetes Engine cluster used to run this environment. */ - gkeCluster?: string; + gkeCluster?: string | null; /** * The configuration used for the Kubernetes Engine cluster. */ @@ -177,7 +177,7 @@ export namespace composer_v1beta1 { /** * The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. */ - nodeCount?: number; + nodeCount?: number | null; /** * The configuration used for the Private IP Cloud Composer environment. */ @@ -194,15 +194,15 @@ export namespace composer_v1beta1 { /** * The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b(.c)" */ - imageVersionId?: string; + imageVersionId?: string | null; /** * Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. */ - isDefault?: boolean; + isDefault?: boolean | null; /** * supported python versions */ - supportedPythonVersions?: string[]; + supportedPythonVersions?: string[] | null; } /** * Configuration for controlling how IPs are allocated in the GKE cluster. @@ -211,23 +211,23 @@ export namespace composer_v1beta1 { /** * Optional. The IP address range used to allocate IP addresses to pods in the cluster. This field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` but not both. */ - clusterIpv4CidrBlock?: string; + clusterIpv4CidrBlock?: string | null; /** * Optional. The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` but not both. This field is applicable only when `use_ip_aliases` is true. */ - clusterSecondaryRangeName?: string; + clusterSecondaryRangeName?: string | null; /** * Optional. The IP address range of the services IP addresses in this cluster. This field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. Specify `services_secondary_range_name` or `services_ipv4_cidr_block` but not both. */ - servicesIpv4CidrBlock?: string; + servicesIpv4CidrBlock?: string | null; /** * Optional. The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either `services_secondary_range_name` or `services_ipv4_cidr_block` but not both. This field is applicable only when `use_ip_aliases` is true. */ - servicesSecondaryRangeName?: string; + servicesSecondaryRangeName?: string | null; /** * Optional. Whether or not to enable Alias IPs in the GKE cluster. If `true`, a VPC-native cluster is created. */ - useIpAliases?: boolean; + useIpAliases?: boolean | null; } /** * The environments in a project and location. @@ -240,7 +240,7 @@ export namespace composer_v1beta1 { /** * The page token used to query for the next page if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The ImageVersions in a project and location. @@ -253,7 +253,7 @@ export namespace composer_v1beta1 { /** * The page token used to query for the next page if one exists. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -262,7 +262,7 @@ export namespace composer_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -275,7 +275,7 @@ export namespace composer_v1beta1 { /** * Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. */ - diskSizeGb?: number; + diskSizeGb?: number | null; /** * Optional. The IPAllocationPolicy fields for the GKE cluster. */ @@ -283,31 +283,31 @@ export namespace composer_v1beta1 { /** * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which to deploy the VMs used to run the Apache Airflow software, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}". This `location` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`) is specified, the location information from the specified field will be propagated to the unspecified field. */ - location?: string; + location?: string | null; /** * Optional. The Compute Engine [machine type](/compute/docs/machine-types) used for cluster instances, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The `machineType` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. The `machineTypeId` must not be a [shared-core machine type](/compute/docs/machine-types#sharedcore). If this field is unspecified, the `machineTypeId` defaults to "n1-standard-1". */ - machineType?: string; + machineType?: string | null; /** * Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/global/networks/{networkId}". If unspecified, the default network in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. For [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see `nodeConfig.subnetwork`. */ - network?: string; + network?: string | null; /** * Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. */ - oauthScopes?: string[]; + oauthScopes?: string[] | null; /** * Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location. */ - subnetwork?: string; + subnetwork?: string | null; /** * Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. */ - tags?: string[]; + tags?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -316,7 +316,7 @@ export namespace composer_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -324,15 +324,15 @@ export namespace composer_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Metadata describing an operation. @@ -341,27 +341,27 @@ export namespace composer_v1beta1 { /** * Output only. The time the operation was submitted to the server. */ - createTime?: string; + createTime?: string | null; /** * Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing. */ - endTime?: string; + endTime?: string | null; /** * Output only. The type of operation being performed. */ - operationType?: string; + operationType?: string | null; /** * Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name). */ - resource?: string; + resource?: string | null; /** * Output only. The UUID of the resource being operated on. */ - resourceUuid?: string; + resourceUuid?: string | null; /** * Output only. The current operation state. */ - state?: string; + state?: string | null; } /** * Configuration options for the private GKE cluster in a Cloud Composer environment. @@ -370,11 +370,11 @@ export namespace composer_v1beta1 { /** * Optional. If `true`, access to the public endpoint of the GKE cluster is denied. */ - enablePrivateEndpoint?: boolean; + enablePrivateEndpoint?: boolean | null; /** * The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used. */ - masterIpv4CidrBlock?: string; + masterIpv4CidrBlock?: string | null; } /** * The configuration information for configuring a Private IP Cloud Composer environment. @@ -383,7 +383,7 @@ export namespace composer_v1beta1 { /** * Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is true, `use_ip_aliases` must be true. */ - enablePrivateEnvironment?: boolean; + enablePrivateEnvironment?: boolean | null; /** * Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment. */ @@ -396,23 +396,23 @@ export namespace composer_v1beta1 { /** * Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), and cannot be overridden. */ - airflowConfigOverrides?: {[key: string]: string}; + airflowConfigOverrides?: {[key: string]: string} | null; /** * Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` */ - envVariables?: {[key: string]: string}; + envVariables?: {[key: string]: string} | null; /** * The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the version is a [semantic version](https://semver.org) or `latest`. When the patch version is omitted, the current Cloud Composer patch version is selected. When `latest` is provided instead of an explicit version number, the server replaces `latest` with the current Cloud Composer version and stores that version number in the same field. The portion of the image version that follows <em>airflow-</em> is an official Apache Airflow repository [release name](https://github.com/apache/incubator-airflow/releases). See also [Version List](/composer/docs/concepts/versioning/composer-versions). */ - imageVersion?: string; + imageVersion?: string | null; /** * Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value. */ - pypiPackages?: {[key: string]: string}; + pypiPackages?: {[key: string]: string} | null; /** * Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. */ - pythonVersion?: string; + pythonVersion?: 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). @@ -421,15 +421,15 @@ export namespace composer_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts new file mode 100644 index 00000000000..d737340951d --- /dev/null +++ b/src/apis/compute/alpha.ts @@ -0,0 +1,81371 @@ +/** + * 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 compute_alpha { + export interface Options extends GlobalOptions { + version: 'alpha'; + } + + 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; + } + + /** + * Compute Engine API + * + * Creates and runs virtual machines on Google Cloud Platform. + * + * @example + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * @namespace compute + * @type {Function} + * @version alpha + * @variation alpha + * @param {object=} options Options for Compute + */ + export class Compute { + context: APIRequestContext; + acceleratorTypes: Resource$Acceleratortypes; + addresses: Resource$Addresses; + autoscalers: Resource$Autoscalers; + backendBuckets: Resource$Backendbuckets; + backendServices: Resource$Backendservices; + disks: Resource$Disks; + diskTypes: Resource$Disktypes; + externalVpnGateways: Resource$Externalvpngateways; + firewalls: Resource$Firewalls; + forwardingRules: Resource$Forwardingrules; + globalAddresses: Resource$Globaladdresses; + globalForwardingRules: Resource$Globalforwardingrules; + globalNetworkEndpointGroups: Resource$Globalnetworkendpointgroups; + globalOperations: Resource$Globaloperations; + globalOrganizationOperations: Resource$Globalorganizationoperations; + globalPublicDelegatedPrefixes: Resource$Globalpublicdelegatedprefixes; + healthChecks: Resource$Healthchecks; + httpHealthChecks: Resource$Httphealthchecks; + httpsHealthChecks: Resource$Httpshealthchecks; + images: Resource$Images; + instanceGroupManagers: Resource$Instancegroupmanagers; + instanceGroups: Resource$Instancegroups; + instances: Resource$Instances; + instanceTemplates: Resource$Instancetemplates; + interconnectAttachments: Resource$Interconnectattachments; + interconnectLocations: Resource$Interconnectlocations; + interconnects: Resource$Interconnects; + licenseCodes: Resource$Licensecodes; + licenses: Resource$Licenses; + machineImages: Resource$Machineimages; + machineTypes: Resource$Machinetypes; + networkEndpointGroups: Resource$Networkendpointgroups; + networks: Resource$Networks; + nodeGroups: Resource$Nodegroups; + nodeTemplates: Resource$Nodetemplates; + nodeTypes: Resource$Nodetypes; + organizationSecurityPolicies: Resource$Organizationsecuritypolicies; + packetMirrorings: Resource$Packetmirrorings; + projects: Resource$Projects; + publicAdvertisedPrefixes: Resource$Publicadvertisedprefixes; + publicDelegatedPrefixes: Resource$Publicdelegatedprefixes; + regionAutoscalers: Resource$Regionautoscalers; + regionBackendServices: Resource$Regionbackendservices; + regionCommitments: Resource$Regioncommitments; + regionDisks: Resource$Regiondisks; + regionDiskTypes: Resource$Regiondisktypes; + regionHealthChecks: Resource$Regionhealthchecks; + regionHealthCheckServices: Resource$Regionhealthcheckservices; + regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; + regionInstanceGroups: Resource$Regioninstancegroups; + regionNotificationEndpoints: Resource$Regionnotificationendpoints; + regionOperations: Resource$Regionoperations; + regions: Resource$Regions; + regionSslCertificates: Resource$Regionsslcertificates; + regionTargetHttpProxies: Resource$Regiontargethttpproxies; + regionTargetHttpsProxies: Resource$Regiontargethttpsproxies; + regionUrlMaps: Resource$Regionurlmaps; + reservations: Resource$Reservations; + resourcePolicies: Resource$Resourcepolicies; + routers: Resource$Routers; + routes: Resource$Routes; + securityPolicies: Resource$Securitypolicies; + snapshots: Resource$Snapshots; + sslCertificates: Resource$Sslcertificates; + sslPolicies: Resource$Sslpolicies; + subnetworks: Resource$Subnetworks; + targetHttpProxies: Resource$Targethttpproxies; + targetHttpsProxies: Resource$Targethttpsproxies; + targetInstances: Resource$Targetinstances; + targetPools: Resource$Targetpools; + targetSslProxies: Resource$Targetsslproxies; + targetTcpProxies: Resource$Targettcpproxies; + targetVpnGateways: Resource$Targetvpngateways; + urlMaps: Resource$Urlmaps; + vpnGateways: Resource$Vpngateways; + vpnTunnels: Resource$Vpntunnels; + zoneOperations: Resource$Zoneoperations; + zones: Resource$Zones; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.acceleratorTypes = new Resource$Acceleratortypes(this.context); + this.addresses = new Resource$Addresses(this.context); + this.autoscalers = new Resource$Autoscalers(this.context); + this.backendBuckets = new Resource$Backendbuckets(this.context); + this.backendServices = new Resource$Backendservices(this.context); + this.disks = new Resource$Disks(this.context); + this.diskTypes = new Resource$Disktypes(this.context); + this.externalVpnGateways = new Resource$Externalvpngateways(this.context); + this.firewalls = new Resource$Firewalls(this.context); + this.forwardingRules = new Resource$Forwardingrules(this.context); + this.globalAddresses = new Resource$Globaladdresses(this.context); + this.globalForwardingRules = new Resource$Globalforwardingrules( + this.context + ); + this.globalNetworkEndpointGroups = new Resource$Globalnetworkendpointgroups( + this.context + ); + this.globalOperations = new Resource$Globaloperations(this.context); + this.globalOrganizationOperations = new Resource$Globalorganizationoperations( + this.context + ); + this.globalPublicDelegatedPrefixes = new Resource$Globalpublicdelegatedprefixes( + this.context + ); + this.healthChecks = new Resource$Healthchecks(this.context); + this.httpHealthChecks = new Resource$Httphealthchecks(this.context); + this.httpsHealthChecks = new Resource$Httpshealthchecks(this.context); + this.images = new Resource$Images(this.context); + this.instanceGroupManagers = new Resource$Instancegroupmanagers( + this.context + ); + this.instanceGroups = new Resource$Instancegroups(this.context); + this.instances = new Resource$Instances(this.context); + this.instanceTemplates = new Resource$Instancetemplates(this.context); + this.interconnectAttachments = new Resource$Interconnectattachments( + this.context + ); + this.interconnectLocations = new Resource$Interconnectlocations( + this.context + ); + 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 + ); + this.networks = new Resource$Networks(this.context); + this.nodeGroups = new Resource$Nodegroups(this.context); + this.nodeTemplates = new Resource$Nodetemplates(this.context); + this.nodeTypes = new Resource$Nodetypes(this.context); + this.organizationSecurityPolicies = new Resource$Organizationsecuritypolicies( + this.context + ); + this.packetMirrorings = new Resource$Packetmirrorings(this.context); + this.projects = new Resource$Projects(this.context); + this.publicAdvertisedPrefixes = new Resource$Publicadvertisedprefixes( + this.context + ); + this.publicDelegatedPrefixes = new Resource$Publicdelegatedprefixes( + this.context + ); + this.regionAutoscalers = new Resource$Regionautoscalers(this.context); + this.regionBackendServices = new Resource$Regionbackendservices( + this.context + ); + this.regionCommitments = new Resource$Regioncommitments(this.context); + this.regionDisks = new Resource$Regiondisks(this.context); + this.regionDiskTypes = new Resource$Regiondisktypes(this.context); + this.regionHealthChecks = new Resource$Regionhealthchecks(this.context); + this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( + this.context + ); + this.regionInstanceGroupManagers = new Resource$Regioninstancegroupmanagers( + this.context + ); + this.regionInstanceGroups = new Resource$Regioninstancegroups( + this.context + ); + this.regionNotificationEndpoints = new Resource$Regionnotificationendpoints( + this.context + ); + this.regionOperations = new Resource$Regionoperations(this.context); + this.regions = new Resource$Regions(this.context); + this.regionSslCertificates = new Resource$Regionsslcertificates( + this.context + ); + this.regionTargetHttpProxies = new Resource$Regiontargethttpproxies( + this.context + ); + this.regionTargetHttpsProxies = new Resource$Regiontargethttpsproxies( + this.context + ); + this.regionUrlMaps = new Resource$Regionurlmaps(this.context); + this.reservations = new Resource$Reservations(this.context); + this.resourcePolicies = new Resource$Resourcepolicies(this.context); + this.routers = new Resource$Routers(this.context); + this.routes = new Resource$Routes(this.context); + this.securityPolicies = new Resource$Securitypolicies(this.context); + this.snapshots = new Resource$Snapshots(this.context); + this.sslCertificates = new Resource$Sslcertificates(this.context); + this.sslPolicies = new Resource$Sslpolicies(this.context); + this.subnetworks = new Resource$Subnetworks(this.context); + this.targetHttpProxies = new Resource$Targethttpproxies(this.context); + this.targetHttpsProxies = new Resource$Targethttpsproxies(this.context); + this.targetInstances = new Resource$Targetinstances(this.context); + this.targetPools = new Resource$Targetpools(this.context); + this.targetSslProxies = new Resource$Targetsslproxies(this.context); + this.targetTcpProxies = new Resource$Targettcpproxies(this.context); + this.targetVpnGateways = new Resource$Targetvpngateways(this.context); + this.urlMaps = new Resource$Urlmaps(this.context); + this.vpnGateways = new Resource$Vpngateways(this.context); + this.vpnTunnels = new Resource$Vpntunnels(this.context); + this.zoneOperations = new Resource$Zoneoperations(this.context); + this.zones = new Resource$Zones(this.context); + } + } + + /** + * A specification of the type and number of accelerator cards attached to the instance. + */ + export interface Schema$AcceleratorConfig { + /** + * The number of the guest accelerator cards exposed to this instance. + */ + acceleratorCount?: number | null; + /** + * Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. + */ + acceleratorType?: string | null; + } + /** + * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) + */ + export interface Schema$AcceleratorType { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this accelerator type. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] An optional textual description of the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. + */ + kind?: string | null; + /** + * [Output Only] Maximum accelerator cards allowed per instance. + */ + maximumCardsPerInstance?: number | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$AcceleratorTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of AcceleratorTypesScopedList resources. + */ + items?: {[key: string]: Schema$AcceleratorTypesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. + */ + 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; + } + /** + * Contains a list of accelerator types. + */ + export interface Schema$AcceleratorTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of AcceleratorType resources. + */ + items?: Schema$AcceleratorType[]; + /** + * [Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$AcceleratorTypesScopedList { + /** + * [Output Only] A list of accelerator types contained in this scope. + */ + acceleratorTypes?: Schema$AcceleratorType[]; + /** + * [Output Only] An informational warning that appears when the accelerator types list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * An access configuration attached to an instance's network interface. Only one access config per instance is supported. + */ + export interface Schema$AccessConfig { + /** + * [Output Only] Type of the resource. Always compute#accessConfig for access configs. + */ + kind?: string | null; + /** + * The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. + */ + name?: string | null; + /** + * An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + */ + natIP?: string | null; + /** + * This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. + */ + networkTier?: string | null; + /** + * [Output Only] The public DNS domain name for the instance. + */ + publicDnsName?: string | null; + /** + * The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. + */ + publicPtrDomainName?: string | null; + /** + * Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. + */ + setPublicDns?: boolean | null; + /** + * Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. + */ + setPublicPtr?: boolean | null; + /** + * The type of configuration. The default and only option is ONE_TO_ONE_NAT. + */ + type?: string | null; + } + /** + * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) + */ + export interface Schema$Address { + /** + * The static IP address represented by this resource. + */ + address?: string | null; + /** + * The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. + */ + addressType?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this field when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. + */ + ipVersion?: string | null; + /** + * [Output Only] Type of the resource. Always compute#address for addresses. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: 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?: string | null; + /** + * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. + */ + network?: string | null; + /** + * This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM. + */ + networkTier?: string | null; + /** + * The prefix length if the resource reprensents an IP range. + */ + prefixLength?: number | null; + /** + * The purpose of this resource, which can be one of the following values: - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. - `DNS_RESOLVER` for a DNS resolver address in a subnetwork - `VPC_PEERING` for addresses that are reserved for VPC peer networks. - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. + */ + purpose?: string | null; + /** + * [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. + */ + status?: string | null; + /** + * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. + */ + subnetwork?: string | null; + /** + * [Output Only] The URLs of the resources that are using this address. + */ + users?: string[] | null; + } + export interface Schema$AddressAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of AddressesScopedList resources. + */ + items?: {[key: string]: Schema$AddressesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$AddressesScopedList { + /** + * [Output Only] A list of addresses contained in this scope. + */ + addresses?: Schema$Address[]; + /** + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Contains a list of addresses. + */ + export interface Schema$AddressList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Address resources. + */ + items?: Schema$Address[]; + /** + * [Output Only] Type of resource. Always compute#addressList for lists of addresses. + */ + 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; + } + /** + * An alias IP range attached to an instance's network interface. + */ + export interface Schema$AliasIpRange { + /** + * The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). + */ + ipCidrRange?: string | null; + /** + * The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. + */ + subnetworkRangeName?: string | null; + } + export interface Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk { + /** + * Specifies the size of the disk in base-2 GB. + */ + diskSizeGb?: string | null; + /** + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. + */ + interface?: string | null; + } + /** + * Properties of the SKU instances being reserved. + */ + export interface Schema$AllocationSpecificSKUAllocationReservedInstanceProperties { + /** + * Specifies accelerator type and count. + */ + guestAccelerators?: Schema$AcceleratorConfig[]; + /** + * Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. + */ + localSsds?: Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk[]; + /** + * Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. + */ + machineType?: string | null; + /** + * Minimum cpu platform the reservation. + */ + minCpuPlatform?: string | null; + } + /** + * This reservation type allows to pre allocate specific instance configuration. + */ + export interface Schema$AllocationSpecificSKUReservation { + /** + * Specifies the number of resources that are allocated. + */ + count?: string | null; + /** + * The instance properties for the reservation. + */ + instanceProperties?: Schema$AllocationSpecificSKUAllocationReservedInstanceProperties; + /** + * [OutputOnly] Indicates how many instances are in use. + */ + inUseCount?: string | null; + } + /** + * An instance-attached disk resource. + */ + export interface Schema$AttachedDisk { + /** + * 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 a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + */ + deviceName?: string | null; + /** + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. + */ + diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. + */ + diskSizeGb?: string | null; + /** + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. + */ + index?: number | null; + /** + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. + */ + initializeParams?: Schema$AttachedDiskInitializeParams; + /** + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported. + */ + 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 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; + /** + * For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api. + */ + savedState?: string | null; + /** + * [Output Only] shielded vm initial state stored on disk + */ + shieldedInstanceInitialState?: Schema$InitialStateConfig; + /** + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. + */ + source?: string | null; + /** + * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. + */ + type?: string | null; + } + /** + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. + */ + export interface Schema$AttachedDiskInitializeParams { + /** + * An optional description. Provide this property when creating the disk. + */ + description?: string | null; + /** + * Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. + */ + 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. + */ + diskSizeGb?: string | null; + /** + * Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. + */ + 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. + */ + labels?: {[key: string]: string} | null; + /** + * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. + */ + replicaZones?: string[] | null; + /** + * Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. + */ + resourcePolicies?: string[] | null; + /** + * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. + */ + sourceImage?: string | null; + /** + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. + */ + sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. + */ + sourceSnapshot?: string | null; + /** + * The customer-supplied encryption key of the source snapshot. + */ + sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + } + /** + * 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[]; + exemptedMembers?: string[] | null; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + 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; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * The authentication settings for the backend service. + */ + export interface Schema$AuthenticationPolicy { + /** + * List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required. + */ + origins?: Schema$OriginAuthenticationMethod[]; + /** + * List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required. + */ + peers?: Schema$PeerAuthenticationMethod[]; + /** + * Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication. + */ + principalBinding?: string | null; + /** + * Configures the mechanism to obtain server-side security certificates and identity information. + */ + serverTlsContext?: Schema$TlsContext; + } + /** + * Authorization configuration provides service-level and method-level access control for a service. + */ + export interface Schema$AuthorizationConfig { + /** + * List of RbacPolicies. + */ + policies?: Schema$RbacPolicy[]; + } + /** + * Authorization-related information used by Cloud Audit Logging. + */ + export interface Schema$AuthorizationLoggingOptions { + /** + * The type of the permission that was checked. + */ + permissionType?: string | null; + } + /** + * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) + */ + export interface Schema$Autoscaler { + /** + * The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. + */ + autoscalingPolicy?: Schema$AutoscalingPolicy; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] 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). + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The status of the autoscaler configuration. + */ + status?: string | null; + /** + * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. + */ + statusDetails?: Schema$AutoscalerStatusDetails[]; + /** + * URL of the managed instance group that this autoscaler will scale. + */ + target?: string | null; + /** + * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). + */ + zone?: string | null; + } + export interface Schema$AutoscalerAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of AutoscalersScopedList resources. + */ + items?: {[key: string]: Schema$AutoscalersScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. + */ + 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; + } + /** + * Contains a list of Autoscaler resources. + */ + export interface Schema$AutoscalerList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Autoscaler resources. + */ + items?: Schema$Autoscaler[]; + /** + * [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$AutoscalersScopedList { + /** + * [Output Only] A list of autoscalers contained in this scope. + */ + autoscalers?: Schema$Autoscaler[]; + /** + * [Output Only] Informational warning which replaces the list of autoscalers when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$AutoscalerStatusDetails { + /** + * The status message. + */ + message?: string | null; + /** + * The type of error returned. + */ + type?: string | null; + } + /** + * Cloud Autoscaler policy. + */ + export interface Schema$AutoscalingPolicy { + /** + * The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. + */ + coolDownPeriodSec?: number | null; + /** + * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. + */ + cpuUtilization?: Schema$AutoscalingPolicyCpuUtilization; + /** + * Configuration parameters of autoscaling based on a custom metric. + */ + customMetricUtilizations?: Schema$AutoscalingPolicyCustomMetricUtilization[]; + /** + * Configuration parameters of autoscaling based on load balancer. + */ + loadBalancingUtilization?: Schema$AutoscalingPolicyLoadBalancingUtilization; + /** + * The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. + */ + maxNumReplicas?: number | null; + /** + * 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; + /** + * Configuration parameters of autoscaling based on queuing system. + */ + queueBasedScaling?: Schema$AutoscalingPolicyQueueBasedScaling; + scaleDownControl?: Schema$AutoscalingPolicyScaleDownControl; + } + /** + * CPU utilization policy. + */ + export interface Schema$AutoscalingPolicyCpuUtilization { + /** + * The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. + */ + utilizationTarget?: number | null; + } + /** + * Custom utilization metric policy. + */ + export interface Schema$AutoscalingPolicyCustomMetricUtilization { + /** + * A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value. + */ + filter?: string | null; + /** + * The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. + */ + metric?: string | null; + /** + * If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead. + */ + singleInstanceAssignment?: number | null; + /** + * The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances. + */ + utilizationTarget?: number | null; + /** + * Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + */ + utilizationTargetType?: string | null; + } + /** + * Configuration parameters of autoscaling based on load balancing. + */ + export interface Schema$AutoscalingPolicyLoadBalancingUtilization { + /** + * Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. + */ + utilizationTarget?: number | null; + } + /** + * Configuration parameters of autoscaling based on queuing system. + */ + export interface Schema$AutoscalingPolicyQueueBasedScaling { + /** + * Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale. + */ + acceptableBacklogPerInstance?: number | null; + /** + * Configuration for Cloud Pub/Sub subscription queue. + */ + cloudPubSub?: Schema$AutoscalingPolicyQueueBasedScalingCloudPubSub; + /** + * The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale. + */ + singleWorkerThroughputPerSec?: number | null; + } + /** + * Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. + */ + export interface Schema$AutoscalingPolicyQueueBasedScalingCloudPubSub { + /** + * Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler. + */ + subscription?: string | null; + /** + * Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource. + */ + topic?: string | null; + } + /** + * Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below. + */ + export interface Schema$AutoscalingPolicyScaleDownControl { + /** + * Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step. + */ + maxScaledDownReplicas?: Schema$FixedOrPercent; + /** + * How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above. + */ + timeWindowSec?: number | null; + } + /** + * Message containing information of one individual backend. + */ + export interface Schema$Backend { + /** + * Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol. + */ + balancingMode?: string | null; + /** + * A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing. + */ + capacityScaler?: number | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. + */ + failover?: boolean | null; + /** + * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. + */ + group?: string | null; + /** + * Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION. + */ + maxConnections?: number | null; + /** + * Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION. + */ + maxConnectionsPerEndpoint?: number | null; + /** + * Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION. + */ + maxConnectionsPerInstance?: number | null; + /** + * The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. + */ + maxRate?: number | null; + /** + * Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION. + */ + maxRatePerEndpoint?: number | null; + /** + * Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION. + */ + maxRatePerInstance?: number | null; + /** + * Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance. + */ + maxUtilization?: number | null; + } + /** + * Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. + */ + export interface Schema$BackendBucket { + /** + * Cloud Storage bucket name. + */ + bucketName?: string | null; + /** + * Cloud CDN configuration for this BackendBucket. + */ + cdnPolicy?: Schema$BackendBucketCdnPolicy; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional textual description of the resource; provided by the client when the resource is created. + */ + description?: string | null; + /** + * If true, enable Cloud CDN for this BackendBucket. + */ + enableCdn?: boolean | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * Type of the resource. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + } + /** + * Message containing Cloud CDN configuration for a backend bucket. + */ + export interface Schema$BackendBucketCdnPolicy { + /** + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. + */ + signedUrlCacheMaxAgeSec?: string | null; + /** + * [Output Only] Names of the keys for signing request URLs. + */ + signedUrlKeyNames?: string[] | null; + } + /** + * Contains a list of BackendBucket resources. + */ + export interface Schema$BackendBucketList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of BackendBucket resources. + */ + items?: Schema$BackendBucket[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + */ + export interface Schema$BackendService { + /** + * If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400). + */ + affinityCookieTtlSec?: number | null; + /** + * The list of backends that serve this BackendService. + */ + backends?: Schema$Backend[]; + /** + * Cloud CDN configuration for this BackendService. + */ + cdnPolicy?: Schema$BackendServiceCdnPolicy; + /** + * Settings controlling the volume of connections to a backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + circuitBreakers?: Schema$CircuitBreakers; + connectionDraining?: Schema$ConnectionDraining; + /** + * Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + consistentHash?: Schema$ConsistentHashLoadBalancerSettings; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * Headers that the HTTP/S load balancer should add to proxied requests. + */ + customRequestHeaders?: string[] | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS. + */ + enableCDN?: boolean | null; + /** + * Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend. + */ + failoverPolicy?: Schema$BackendServiceFailoverPolicy; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. + */ + fingerprint?: string | null; + /** + * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. + */ + healthChecks?: string[] | null; + iap?: Schema$BackendServiceIAP; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#backendService for backend services. + */ + kind?: string | null; + /** + * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. + */ + loadBalancingScheme?: string | null; + /** + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + localityLbPolicy?: string | null; + /** + * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. + */ + logConfig?: Schema$BackendServiceLogConfig; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL. + */ + network?: string | null; + /** + * Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + outlierDetection?: Schema$OutlierDetection; + /** + * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). + */ + port?: number | null; + /** + * A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing). + */ + portName?: string | null; + /** + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. + */ + protocol?: string | null; + /** + * [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] The resource URL for the security policy associated with this backend service. + */ + securityPolicy?: string | null; + /** + * This field specifies the security policy that applies to this backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + securitySettings?: Schema$SecuritySettings; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + 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. + */ + sessionAffinity?: string | null; + /** + * The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds. + */ + timeoutSec?: number | null; + } + /** + * Contains a list of BackendServicesScopedList. + */ + export interface Schema$BackendServiceAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of BackendServicesScopedList resources. + */ + items?: {[key: string]: Schema$BackendServicesScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Message containing Cloud CDN configuration for a backend service. + */ + export interface Schema$BackendServiceCdnPolicy { + /** + * The CacheKeyPolicy for this CdnPolicy. + */ + cacheKeyPolicy?: Schema$CacheKeyPolicy; + /** + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. + */ + signedUrlCacheMaxAgeSec?: string | null; + /** + * [Output Only] Names of the keys for signing request URLs. + */ + signedUrlKeyNames?: string[] | null; + } + export interface Schema$BackendServiceFailoverPolicy { + /** + * This can be set to true only if the protocol is TCP. The default is false. + */ + disableConnectionDrainOnFailover?: boolean | null; + /** + * Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false. + */ + dropTrafficIfUnhealthy?: boolean | null; + /** + * Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. + */ + failoverRatio?: number | null; + } + export interface Schema$BackendServiceGroupHealth { + /** + * Metadata defined as annotations on the network endpoint group. + */ + annotations?: {[key: string]: string} | null; + /** + * Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. + */ + healthStatus?: Schema$HealthStatus[]; + /** + * [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. + */ + kind?: string | null; + } + /** + * Identity-Aware Proxy + */ + export interface Schema$BackendServiceIAP { + enabled?: boolean | null; + oauth2ClientId?: string | null; + /** + * [Input Only] OAuth client info required to generate client id to be used for IAP. + */ + oauth2ClientInfo?: Schema$BackendServiceIAPOAuth2ClientInfo; + oauth2ClientSecret?: string | null; + /** + * [Output Only] SHA256 hash value for the field oauth2_client_secret above. + */ + oauth2ClientSecretSha256?: string | null; + } + export interface Schema$BackendServiceIAPOAuth2ClientInfo { + /** + * Application name to be used in OAuth consent screen. + */ + applicationName?: string | null; + /** + * Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend. + */ + clientName?: string | null; + /** + * Developer's information to be used in OAuth consent screen. + */ + developerEmailAddress?: string | null; + } + /** + * Contains a list of BackendService resources. + */ + export interface Schema$BackendServiceList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of BackendService resources. + */ + items?: Schema$BackendService[]; + /** + * [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services. + */ + 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; + } + /** + * The available logging options for the load balancer traffic served by this backend service. + */ + export interface Schema$BackendServiceLogConfig { + /** + * This field denotes whether to enable logging for the load balancer traffic served by this backend service. + */ + enable?: boolean | null; + /** + * This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0. + */ + sampleRate?: number | null; + } + export interface Schema$BackendServiceReference { + backendService?: string | null; + } + export interface Schema$BackendServicesScopedList { + /** + * A list of BackendServices contained in this scope. + */ + backendServices?: Schema$BackendService[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$BfdPacket { + /** + * The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + authenticationPresent?: boolean | null; + /** + * The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + controlPlaneIndependent?: boolean | null; + /** + * The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + demand?: boolean | null; + /** + * The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880 + */ + diagnostic?: string | null; + /** + * The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + final?: boolean | null; + /** + * The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880 + */ + length?: number | null; + /** + * The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + minEchoRxIntervalMs?: number | null; + /** + * The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + minRxIntervalMs?: number | null; + /** + * The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + minTxIntervalMs?: number | null; + /** + * The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + multiplier?: number | null; + /** + * The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + multipoint?: boolean | null; + /** + * The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + myDiscriminator?: number | null; + /** + * The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + poll?: boolean | null; + /** + * The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 + */ + state?: string | null; + /** + * The version number of the BFD protocol, as specified in section 4.1 of RFC5880. + */ + version?: number | null; + /** + * The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + yourDiscriminator?: number | null; + } + /** + * Next free: 15 + */ + export interface Schema$BfdStatus { + /** + * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. + */ + bfdSessionInitializationMode?: string | null; + /** + * Unix timestamp of the most recent config update. + */ + configUpdateTimestampMicros?: string | null; + /** + * Control packet counts for the current BFD session. + */ + controlPacketCounts?: Schema$BfdStatusPacketCounts; + /** + * Inter-packet time interval statistics for control packets. + */ + controlPacketIntervals?: Schema$PacketIntervals[]; + /** + * Echo packet counts for the current BFD session. + */ + echoPacketCounts?: Schema$BfdStatusPacketCounts; + /** + * Inter-packet time interval statistics for echo packets. + */ + echoPacketIntervals?: Schema$PacketIntervals[]; + /** + * The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880 + */ + localDiagnostic?: string | null; + /** + * The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 + */ + localState?: string | null; + /** + * Negotiated transmit interval for control packets. + */ + negotiatedLocalControlTxIntervalMs?: number | null; + /** + * Negotiated transmit interval for echo packets. + */ + negotiatedLocalEchoTxIntervalMs?: number | null; + /** + * The most recent Rx control packet for this BFD session. + */ + rxPacket?: Schema$BfdPacket; + /** + * The most recent Tx control packet for this BFD session. + */ + txPacket?: Schema$BfdPacket; + /** + * Session uptime in milliseconds. Value will be 0 if session is not up. + */ + uptimeMs?: string | null; + /** + * Indicates if echo mode is currently being used. + */ + usingEchoMode?: boolean | null; + } + export interface Schema$BfdStatusPacketCounts { + /** + * Number of packets received since the beginning of the current BFD session. + */ + numRx?: number | null; + /** + * Number of packets received that were rejected because of errors since the beginning of the current BFD session. + */ + numRxRejected?: number | null; + /** + * Number of packets received that were successfully processed since the beginning of the current BFD session. + */ + numRxSuccessful?: number | null; + /** + * Number of packets transmitted since the beginning of the current BFD session. + */ + numTx?: number | null; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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; + } + export interface Schema$CacheInvalidationRule { + /** + * If set, this invalidation rule will only apply to requests with a Host header matching host. + */ + host?: string | null; + path?: string | null; + } + /** + * Message containing what to include in the cache key for a request for Cloud CDN. + */ + export interface Schema$CacheKeyPolicy { + /** + * If true, requests to different hosts will be cached separately. + */ + includeHost?: boolean | null; + /** + * If true, http and https requests will be cached separately. + */ + includeProtocol?: boolean | null; + /** + * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. + */ + includeQueryString?: boolean | null; + /** + * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. + */ + queryStringBlacklist?: string[] | null; + /** + * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. + */ + queryStringWhitelist?: string[] | null; + } + /** + * gRPC call credentials to access the SDS server. + */ + export interface Schema$CallCredentials { + /** + * The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: ACCESS_TOKEN: An access token is used as call credentials for the SDS server. GCE_VM: The local GCE VM service account credentials are used to access the SDS server. JWT_SERVICE_TOKEN: The user provisioned service account credentials are used to access the SDS server. FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. + */ + callCredentialType?: string | null; + /** + * Custom authenticator credentials. + */ + fromPlugin?: Schema$MetadataCredentialsFromPlugin; + } + /** + * gRPC channel credentials to access the SDS server. + */ + export interface Schema$ChannelCredentials { + /** + * The call credentials to access the SDS server. + */ + certificates?: Schema$TlsCertificatePaths; + /** + * The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. + */ + channelCredentialType?: string | null; + } + /** + * Settings controlling the volume of connections to a backend service. + */ + export interface Schema$CircuitBreakers { + /** + * The timeout for new network connections to hosts. + */ + connectTimeout?: Schema$Duration; + /** + * The maximum number of connections to the backend cluster. If not specified, the default is 1024. + */ + maxConnections?: number | null; + /** + * The maximum number of pending requests allowed to the backend cluster. If not specified, the default is 1024. + */ + maxPendingRequests?: number | null; + /** + * The maximum number of parallel requests that allowed to the backend cluster. If not specified, the default is 1024. + */ + maxRequests?: number | null; + /** + * Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. + */ + maxRequestsPerConnection?: number | null; + /** + * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 3. + */ + maxRetries?: number | null; + } + /** + * The client side authentication settings for connection originating from the backend service. + */ + export interface Schema$ClientTlsSettings { + /** + * Configures the mechanism to obtain client-side security certificates and identity information. This field is only applicable when mode is set to MUTUAL. + */ + clientTlsContext?: Schema$TlsContext; + /** + * Indicates whether connections to this port should be secured using TLS. The value of this field determines how TLS is enforced. This can be set to one of the following values: DISABLE: Do not setup a TLS connection to the backends. SIMPLE: Originate a TLS connection to the backends. MUTUAL: Secure connections to the backends using mutual TLS by presenting client certificates for authentication. + */ + mode?: string | null; + /** + * SNI string to present to the server during TLS handshake. This field is applicable only when mode is SIMPLE or MUTUAL. + */ + sni?: string | null; + /** + * A list of alternate names to verify the subject identity in the certificate.If specified, the proxy will verify that the server certificate's subject alt name matches one of the specified values. This field is applicable only when mode is SIMPLE or MUTUAL. + */ + subjectAltNames?: string[] | null; + } + /** + * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) + */ + export interface Schema$Commitment { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] Commitment end time in RFC3339 text format. + */ + endTimestamp?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#commitment for commitments. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + */ + plan?: string | null; + /** + * [Output Only] URL of the region where this commitment may be used. + */ + region?: string | null; + /** + * List of reservations in this commitment. + */ + reservations?: Schema$Reservation[]; + /** + * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. + */ + resources?: Schema$ResourceCommitment[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] Commitment start time in RFC3339 text format. + */ + startTimestamp?: string | null; + /** + * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + */ + status?: string | null; + /** + * [Output Only] An optional, human-readable explanation of the status. + */ + statusMessage?: string | null; + /** + * The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. + */ + type?: string | null; + } + export interface Schema$CommitmentAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of CommitmentsScopedList resources. + */ + items?: {[key: string]: Schema$CommitmentsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments. + */ + 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; + } + /** + * Contains a list of Commitment resources. + */ + export interface Schema$CommitmentList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Commitment resources. + */ + items?: Schema$Commitment[]; + /** + * [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$CommitmentsScopedList { + /** + * [Output Only] A list of commitments contained in this scope. + */ + commitments?: Schema$Commitment[]; + /** + * [Output Only] Informational warning which replaces the list of commitments when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A condition to be met. + */ + export interface Schema$Condition { + /** + * Trusted attributes supplied by the IAM system. + */ + iam?: string | null; + /** + * An operator to apply the subject with. + */ + op?: string | null; + /** + * Trusted attributes discharged by the service. + */ + svc?: string | null; + /** + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. + */ + sys?: string | null; + /** + * The objects of the condition. + */ + values?: string[] | null; + } + /** + * Message containing connection draining configuration. + */ + export interface Schema$ConnectionDraining { + /** + * The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]. + */ + drainingTimeoutSec?: number | null; + } + /** + * This message defines settings for a consistent hash style load balancer. + */ + export interface Schema$ConsistentHashLoadBalancerSettings { + /** + * Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. + */ + httpCookie?: Schema$ConsistentHashLoadBalancerSettingsHttpCookie; + /** + * The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD. + */ + httpHeaderName?: string | null; + /** + * The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. + */ + minimumRingSize?: string | null; + } + /** + * The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. + */ + export interface Schema$ConsistentHashLoadBalancerSettingsHttpCookie { + /** + * Name of the cookie. + */ + name?: string | null; + /** + * Path to set for the cookie. + */ + path?: string | null; + /** + * Lifetime of the cookie. + */ + ttl?: Schema$Duration; + } + /** + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing + */ + export interface Schema$CorsPolicy { + /** + * In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default is false. + */ + allowCredentials?: boolean | null; + /** + * Specifies the content for the Access-Control-Allow-Headers header. + */ + allowHeaders?: string[] | null; + /** + * Specifies the content for the Access-Control-Allow-Methods header. + */ + allowMethods?: string[] | null; + /** + * Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex. + */ + allowOriginRegexes?: string[] | null; + /** + * Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex. + */ + allowOrigins?: string[] | null; + /** + * If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. + */ + disabled?: boolean | null; + /** + * Specifies the content for the Access-Control-Expose-Headers header. + */ + exposeHeaders?: string[] | null; + /** + * Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. + */ + maxAge?: number | null; + } + /** + * Represents a customer-supplied encryption key + */ + export interface Schema$CustomerEncryptionKey { + /** + * The name of the encryption key that is stored in Google Cloud KMS. + */ + kmsKeyName?: string | null; + kmsKeyServiceAccount?: string | null; + /** + * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. + */ + rawKey?: string | null; + /** + * Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: - The key is wrapped using a RSA public key certificate provided by Google. - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + */ + rsaEncryptedKey?: string | null; + /** + * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. + */ + sha256?: string | null; + } + export interface Schema$CustomerEncryptionKeyProtectedDisk { + /** + * Decrypts data associated with the disk with a customer-supplied encryption key. + */ + diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. + */ + source?: string | null; + } + /** + * Deprecation status for a public resource. + */ + export interface Schema$DeprecationStatus { + /** + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. + */ + deleted?: string | null; + /** + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. + */ + deprecated?: string | null; + /** + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. + */ + obsolete?: string | null; + /** + * The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. + */ + replacement?: string | null; + /** + * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. + */ + state?: string | null; + } + /** + * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) + */ + export interface Schema$Disk { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * 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. + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#disk for disks. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this disk. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; + /** + * [Output Only] Last attach timestamp in RFC3339 text format. + */ + lastAttachTimestamp?: string | null; + /** + * [Output Only] Last detach timestamp in RFC3339 text format. + */ + lastDetachTimestamp?: string | null; + /** + * Integer license codes indicating which licenses are attached to this disk. + */ + licenseCodes?: string[] | null; + /** + * A list of publicly visible licenses. Reserved for Google's use. + */ + licenses?: string[] | null; + /** + * Indicates whether or not the disk can be read/write attached to more than one instance. + */ + multiWriter?: boolean | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Internal use only. + */ + options?: string | null; + /** + * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. + */ + physicalBlockSizeBytes?: string | null; + /** + * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. + */ + replicaZones?: string[] | null; + /** + * Resource policies applied to this disk for automatic snapshot creations. + */ + resourcePolicies?: string[] | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. + */ + sizeGb?: string | null; + /** + * The source disk used to create this disk. 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/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + */ + sourceDisk?: string | null; + /** + * [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. + */ + sourceDiskId?: string | null; + /** + * The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family + */ + sourceImage?: string | null; + /** + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. + */ + sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. + */ + sourceImageId?: string | null; + /** + * The source snapshot used to create this disk. 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/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot + */ + sourceSnapshot?: string | null; + /** + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. + */ + sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The 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; + /** + * [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. + */ + status?: string | null; + /** + * [Deprecated] Storage type of the persistent disk. + */ + storageType?: string | null; + /** + * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + */ + type?: string | null; + /** + * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance + */ + users?: string[] | null; + /** + * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$DiskAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of DisksScopedList resources. + */ + items?: {[key: string]: Schema$DisksScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. + */ + 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; + } + /** + * A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. + */ + export interface Schema$DiskInstantiationConfig { + /** + * 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; + /** + * The custom source image to be used to restore this disk when instantiating this instance template. + */ + customImage?: string | null; + /** + * Specifies the device name of the disk to which the configurations apply to. + */ + deviceName?: string | null; + /** + * Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. + */ + instantiateFrom?: string | null; + } + /** + * A list of Disk resources. + */ + export interface Schema$DiskList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Disk resources. + */ + items?: Schema$Disk[]; + /** + * [Output Only] Type of resource. Always compute#diskList for lists of disks. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$DiskMoveRequest { + /** + * The URL of the destination zone to move the disk. 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 + */ + destinationZone?: string | null; + /** + * The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + */ + targetDisk?: string | null; + } + export interface Schema$DisksAddResourcePoliciesRequest { + /** + * Resource policies to be added to this disk. + */ + resourcePolicies?: string[] | null; + } + export interface Schema$DisksRemoveResourcePoliciesRequest { + /** + * Resource policies to be removed from this disk. + */ + resourcePolicies?: string[] | null; + } + export interface Schema$DisksResizeRequest { + /** + * The new size of the persistent disk, which is specified in GB. + */ + sizeGb?: string | null; + } + export interface Schema$DisksScopedList { + /** + * [Output Only] A list of disks contained in this scope. + */ + disks?: Schema$Disk[]; + /** + * [Output Only] Informational warning which replaces the list of disks when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) + */ + export interface Schema$DiskType { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] Server-defined default disk size in GB. + */ + defaultDiskSizeGb?: string | null; + /** + * [Output Only] The deprecation status associated with this disk type. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] An optional description of this resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#diskType for disk types. + */ + kind?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". + */ + validDiskSize?: string | null; + /** + * [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$DiskTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of DiskTypesScopedList resources. + */ + items?: {[key: string]: Schema$DiskTypesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#diskTypeAggregatedList. + */ + 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; + } + /** + * Contains a list of disk types. + */ + export interface Schema$DiskTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of DiskType resources. + */ + items?: Schema$DiskType[]; + /** + * [Output Only] Type of resource. Always compute#diskTypeList for disk types. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$DiskTypesScopedList { + /** + * [Output Only] A list of disk types contained in this scope. + */ + diskTypes?: Schema$DiskType[]; + /** + * [Output Only] Informational warning which replaces the list of disk types when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A set of Display Device options + */ + export interface Schema$DisplayDevice { + /** + * Defines whether the instance has Display enabled. + */ + enableDisplay?: boolean | null; + } + export interface Schema$DistributionPolicy { + /** + * Zones where the regional managed instance group will create and manage instances. + */ + zones?: Schema$DistributionPolicyZoneConfiguration[]; + } + export interface Schema$DistributionPolicyZoneConfiguration { + /** + * The URL of the zone. The zone must exist in the region where the managed instance group is located. + */ + zone?: string | null; + } + /** + * A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. + */ + export interface Schema$Duration { + /** + * Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + */ + nanos?: number | null; + /** + * Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + */ + seconds?: string | null; + } + 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" + */ + 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; + } + /** + * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. + */ + export interface Schema$ExternalVpnGateway { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * List of interfaces for this external VPN gateway. + */ + interfaces?: Schema$ExternalVpnGatewayInterface[]; + /** + * [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this ExternalVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Indicates the user-supplied redundancy type of this external VPN gateway. + */ + redundancyType?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + } + /** + * The interface for the external VPN gateway. + */ + export interface Schema$ExternalVpnGatewayInterface { + /** + * The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 + */ + id?: number | null; + /** + * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. + */ + ipAddress?: string | null; + } + /** + * Response to the list request, and contains a list of externalVpnGateways. + */ + export interface Schema$ExternalVpnGatewayList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of ExternalVpnGateway resources. + */ + items?: Schema$ExternalVpnGateway[]; + /** + * [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$FileContentBuffer { + /** + * The raw content in the secure keys file. + */ + content?: string | null; + fileType?: string | null; + } + /** + * Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. + */ + export interface Schema$Firewall { + /** + * The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. + */ + allowed?: Array<{IPProtocol?: string; ports?: string[]}> | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. + */ + denied?: Array<{IPProtocol?: string; ports?: string[]}> | null; + /** + * An optional description of this resource. Provide this field when you create the resource. + */ + description?: string | null; + /** + * If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. + */ + destinationRanges?: string[] | null; + /** + * Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields. + */ + direction?: string | null; + /** + * Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. + */ + disabled?: boolean | null; + /** + * Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. + */ + enableLogging?: boolean | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#firewall for firewall rules. + */ + kind?: string | null; + /** + * This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. + */ + logConfig?: Schema$FirewallLogConfig; + /** + * 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; + /** + * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default + */ + network?: string | null; + /** + * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. + */ + priority?: number | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported. + */ + sourceRanges?: string[] | null; + /** + * If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. + */ + sourceServiceAccounts?: string[] | null; + /** + * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. + */ + sourceTags?: string[] | null; + /** + * A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. + */ + targetServiceAccounts?: string[] | null; + /** + * A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. + */ + targetTags?: string[] | null; + } + /** + * Contains a list of firewalls. + */ + export interface Schema$FirewallList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Firewall resources. + */ + items?: Schema$Firewall[]; + /** + * [Output Only] Type of resource. Always compute#firewallList for lists of firewalls. + */ + 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; + } + /** + * The available logging options for a firewall rule. + */ + export interface Schema$FirewallLogConfig { + /** + * This field denotes whether to enable logging for a particular firewall rule. + */ + enable?: boolean | null; + /** + * This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs. + */ + metadata?: string | null; + } + /** + * Encapsulates numeric value that can be either absolute or relative. + */ + export interface Schema$FixedOrPercent { + /** + * [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up. + */ + calculated?: number | null; + /** + * Specifies a fixed number of VM instances. This must be a positive integer. + */ + fixed?: number | null; + /** + * Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. + */ + percent?: number | null; + } + /** + * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + */ + export interface Schema$ForwardingRule { + /** + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + */ + allowGlobalAccess?: boolean | null; + /** + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. + */ + allPorts?: boolean | null; + /** + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. + */ + backendService?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. + */ + fingerprint?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: * projects/project_id/regions/region/addresses/address-name * regions/region/addresses/address-name * global/addresses/address-name * address-name The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + */ + IPAddress?: string | null; + /** + * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. + */ + IPProtocol?: string | null; + /** + * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. + */ + ipVersion?: string | null; + /** + * Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. + */ + isMirroringCollector?: boolean | null; + /** + * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + */ + loadBalancingScheme?: string | null; + /** + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + */ + metadataFilters?: Schema$MetadataFilter[]; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * This field is not used for external load balancing. For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. + */ + network?: string | null; + /** + * This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. + */ + networkTier?: string | null; + /** + * This field is deprecated. See the port field. + */ + 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. + */ + ports?: string[] | null; + /** + * [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. This field is only used for internal load balancing. + */ + serviceLabel?: string | null; + /** + * [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. + */ + serviceName?: string | null; + /** + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. + */ + subnetwork?: string | null; + /** + * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. + */ + target?: string | null; + } + export interface Schema$ForwardingRuleAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of ForwardingRulesScopedList resources. + */ + items?: {[key: string]: Schema$ForwardingRulesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules. + */ + 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; + } + /** + * Contains a list of ForwardingRule resources. + */ + export interface Schema$ForwardingRuleList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of ForwardingRule resources. + */ + items?: Schema$ForwardingRule[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$ForwardingRuleReference { + forwardingRule?: string | null; + } + export interface Schema$ForwardingRulesScopedList { + /** + * A list of forwarding rules contained in this scope. + */ + forwardingRules?: Schema$ForwardingRule[]; + /** + * Informational warning which replaces the list of forwarding rules when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$GlobalNetworkEndpointGroupsAttachEndpointsRequest { + /** + * The list of network endpoints to be attached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } + export interface Schema$GlobalNetworkEndpointGroupsDetachEndpointsRequest { + /** + * The list of network endpoints to be detached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } + export interface Schema$GlobalSetLabelsRequest { + /** + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. + */ + labelFingerprint?: string | null; + /** + * A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). + */ + labels?: {[key: string]: string} | null; + } + export interface Schema$GlobalSetPolicyRequest { + /** + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. + */ + bindings?: Schema$Binding[]; + /** + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. + */ + etag?: string | null; + /** + * 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 in general a valid policy but certain services (like Projects) might reject them. + */ + policy?: Schema$Policy; + } + /** + * gRPC config to access the SDS server. + */ + export interface Schema$GrpcServiceConfig { + /** + * The call credentials to access the SDS server. + */ + callCredentials?: Schema$CallCredentials; + /** + * The channel credentials to access the SDS server. + */ + channelCredentials?: Schema$ChannelCredentials; + /** + * The target URI of the SDS server. + */ + targetUri?: string | null; + } + /** + * A guest attributes entry. + */ + export interface Schema$GuestAttributes { + /** + * [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. + */ + kind?: string | null; + /** + * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') + */ + queryPath?: string | null; + /** + * [Output Only] The value of the requested queried path. + */ + queryValue?: Schema$GuestAttributesValue; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * The key to search for. + */ + variableKey?: string | null; + /** + * [Output Only] The value found for the requested key. + */ + variableValue?: string | null; + } + /** + * A guest attributes namespace/key/value entry. + */ + export interface Schema$GuestAttributesEntry { + /** + * Key for the guest attribute entry. + */ + key?: string | null; + /** + * Namespace for the guest attribute entry. + */ + namespace?: string | null; + /** + * Value for the guest attribute entry. + */ + value?: string | null; + } + /** + * Array of guest attribute namespace/key/value tuples. + */ + export interface Schema$GuestAttributesValue { + items?: Schema$GuestAttributesEntry[]; + } + /** + * Guest OS features. + */ + export interface Schema$GuestOsFeature { + /** + * The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. + */ + type?: string | null; + } + /** + * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. + */ + export interface Schema$HealthCheck { + /** + * How often (in seconds) to send a health check. The default value is 5 seconds. + */ + checkIntervalSec?: number | null; + /** + * [Output Only] Creation timestamp in 3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. + */ + healthyThreshold?: number | null; + http2HealthCheck?: Schema$HTTP2HealthCheck; + httpHealthCheck?: Schema$HTTPHealthCheck; + httpsHealthCheck?: Schema$HTTPSHealthCheck; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Type of the resource. + */ + kind?: string | null; + /** + * Configure logging on this health check. + */ + logConfig?: Schema$HealthCheckLogConfig; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] Region where the health check resides. Not applicable to global health checks. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + sslHealthCheck?: Schema$SSLHealthCheck; + tcpHealthCheck?: Schema$TCPHealthCheck; + /** + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. + */ + timeoutSec?: number | null; + /** + * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. + */ + type?: string | null; + udpHealthCheck?: Schema$UDPHealthCheck; + /** + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. + */ + unhealthyThreshold?: number | null; + } + /** + * Contains a list of HealthCheck resources. + */ + export interface Schema$HealthCheckList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthCheck resources. + */ + items?: Schema$HealthCheck[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. + */ + export interface Schema$HealthCheckLogConfig { + /** + * Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. + */ + enable?: boolean | null; + } + /** + * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check + */ + export interface Schema$HealthCheckReference { + healthCheck?: string | null; + } + export interface Schema$HealthChecksAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthChecksScopedList resources. + */ + items?: {[key: string]: Schema$HealthChecksScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A HealthCheckService defines a set of backends on which to perform periodic health checks and an endpoint to which to send notification of changes in the health status of the backends. + */ + export interface Schema$HealthCheckService { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs. + */ + healthChecks?: string[] | null; + /** + * Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. . + */ + healthStatusAggregationPolicy?: string | null; + /** + * Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. . + */ + healthStatusAggregationStrategy?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. + */ + kind?: string | null; + /** + * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. + */ + networkEndpointGroups?: string[] | null; + /** + * List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. + */ + notificationEndpoints?: string[] | null; + /** + * [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + } + /** + * A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service + */ + export interface Schema$HealthCheckServiceReference { + healthCheckService?: string | null; + } + export interface Schema$HealthCheckServicesList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthCheckService resources. + */ + items?: Schema$HealthCheckService[]; + /** + * [Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HealthChecksScopedList { + /** + * A list of HealthChecks contained in this scope. + */ + healthChecks?: Schema$HealthCheck[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HealthStatus { + /** + * Metadata defined as annotations for network endpoint. + */ + annotations?: {[key: string]: string} | null; + /** + * Health state of the instance. + */ + healthState?: string | null; + /** + * URL of the instance resource. + */ + instance?: string | null; + /** + * The IP address represented by this resource. + */ + ipAddress?: string | null; + /** + * The port on the instance. + */ + port?: number | null; + } + export interface Schema$HealthStatusForNetworkEndpoint { + /** + * URL of the backend service associated with the health state of the network endpoint. + */ + backendService?: Schema$BackendServiceReference; + /** + * URL of the forwarding rule associated with the health state of the network endpoint. + */ + forwardingRule?: Schema$ForwardingRuleReference; + /** + * URL of the health check associated with the health state of the network endpoint. + */ + healthCheck?: Schema$HealthCheckReference; + /** + * URL of the health check service associated with the health state of the network endpoint. + */ + healthCheckService?: Schema$HealthCheckServiceReference; + /** + * Health state of the network endpoint determined based on the health checks configured. + */ + healthState?: string | null; + } + /** + * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. + */ + export interface Schema$HostRule { + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. + */ + hosts?: string[] | null; + /** + * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. + */ + pathMatcher?: string | null; + } + export interface Schema$HTTP2HealthCheck { + /** + * The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The request path of the HTTP/2 health check request. The default value is /. + */ + requestPath?: string | null; + /** + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + */ + response?: string | null; + } + /** + * Specification for how requests are aborted as part of fault injection. + */ + export interface Schema$HttpFaultAbort { + /** + * The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. + */ + httpStatus?: number | null; + /** + * The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. + */ + percentage?: number | null; + } + /** + * Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. + */ + export interface Schema$HttpFaultDelay { + /** + * Specifies the value of the fixed delay interval. + */ + fixedDelay?: Schema$Duration; + /** + * The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. + */ + percentage?: number | null; + } + /** + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. + */ + export interface Schema$HttpFaultInjection { + /** + * The specification for how client requests are aborted as part of fault injection. + */ + abort?: Schema$HttpFaultAbort; + /** + * The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. + */ + delay?: Schema$HttpFaultDelay; + } + /** + * The request and response header transformations that take effect before the request is passed along to the selected backendService. + */ + export interface Schema$HttpHeaderAction { + /** + * Headers to add to a matching request prior to forwarding the request to the backendService. + */ + requestHeadersToAdd?: Schema$HttpHeaderOption[]; + /** + * A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. + */ + requestHeadersToRemove?: string[] | null; + /** + * Headers to add the response prior to sending the response back to the client. + */ + responseHeadersToAdd?: Schema$HttpHeaderOption[]; + /** + * A list of header names for headers that need to be removed from the response prior to sending the response back to the client. + */ + responseHeadersToRemove?: string[] | null; + } + /** + * matchRule criteria for request header matches. + */ + export interface Schema$HttpHeaderMatch { + /** + * The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + exactMatch?: string | null; + /** + * The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". + */ + headerName?: string | null; + /** + * If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false. + */ + invertMatch?: boolean | null; + /** + * The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + prefixMatch?: string | null; + /** + * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + presentMatch?: boolean | null; + /** + * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + rangeMatch?: Schema$Int64RangeMatch; + /** + * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + regexMatch?: string | null; + /** + * The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + suffixMatch?: string | null; + } + /** + * Specification determining how headers are added to requests or responses. + */ + export interface Schema$HttpHeaderOption { + /** + * The name of the header. + */ + headerName?: string | null; + /** + * The value of the header to add. + */ + headerValue?: string | null; + /** + * If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. + */ + replace?: boolean | null; + } + /** + * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. + */ + export interface Schema$HttpHealthCheck { + /** + * How often (in seconds) to send a health check. The default value is 5 seconds. + */ + checkIntervalSec?: number | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. + */ + healthyThreshold?: number | null; + /** + * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The TCP port number for the HTTP health check request. The default value is 80. + */ + port?: number | null; + /** + * The request path of the HTTP health check request. The default value is /. This field does not support query parameters. + */ + requestPath?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. + */ + timeoutSec?: number | null; + /** + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. + */ + unhealthyThreshold?: number | null; + } + export interface Schema$HTTPHealthCheck { + /** + * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The request path of the HTTP health check request. The default value is /. + */ + requestPath?: string | null; + /** + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + */ + response?: string | null; + } + /** + * Contains a list of HttpHealthCheck resources. + */ + export interface Schema$HttpHealthCheckList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HttpHealthCheck resources. + */ + items?: Schema$HttpHealthCheck[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * HttpRouteRuleMatch criteria for a request's query parameter. + */ + 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. + */ + exactMatch?: string | null; + /** + * The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. + */ + 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. + */ + presentMatch?: boolean | null; + /** + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set. + */ + regexMatch?: string | null; + } + /** + * Specifies settings for an HTTP redirect. + */ + export interface Schema$HttpRedirectAction { + /** + * The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. + */ + hostRedirect?: string | null; + /** + * If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. + */ + httpsRedirect?: boolean | null; + /** + * The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters. + */ + pathRedirect?: string | null; + /** + * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. + */ + prefixRedirect?: string | null; + /** + * The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. + */ + redirectResponseCode?: string | null; + /** + * If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. + */ + stripQuery?: boolean | null; + } + /** + * The retry policy associates with HttpRouteRule + */ + export interface Schema$HttpRetryPolicy { + /** + * Specifies the allowed number retries. This number must be > 0. + */ + numRetries?: number | null; + /** + * Specifies a non-zero timeout per retry attempt. + */ + perTryTimeout?: Schema$Duration; + /** + * Specfies one or more conditions when this retry rule applies. Valid values are: - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable + */ + retryConditions?: string[] | null; + } + export interface Schema$HttpRouteAction { + /** + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing + */ + corsPolicy?: Schema$CorsPolicy; + /** + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. + */ + faultInjectionPolicy?: Schema$HttpFaultInjection; + /** + * Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. + */ + requestMirrorPolicy?: Schema$RequestMirrorPolicy; + /** + * Specifies the retry policy associated with this route. + */ + retryPolicy?: Schema$HttpRetryPolicy; + /** + * Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. + */ + timeout?: Schema$Duration; + /** + * The spec to modify the URL of the request, prior to forwarding the request to the matched service + */ + urlRewrite?: Schema$UrlRewrite; + /** + * A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. + */ + weightedBackendServices?: Schema$WeightedBackendService[]; + } + /** + * An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. + */ + export interface Schema$HttpRouteRule { + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction + */ + headerAction?: Schema$HttpHeaderAction; + matchRules?: Schema$HttpRouteRuleMatch[]; + /** + * 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. + */ + routeAction?: Schema$HttpRouteAction; + /** + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. + */ + service?: string | null; + /** + * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. + */ + urlRedirect?: Schema$HttpRedirectAction; + } + /** + * HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. + */ + export interface Schema$HttpRouteRuleMatch { + /** + * 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. + */ + fullPathMatch?: string | null; + /** + * Specifies a list of header match criteria, all of which must match corresponding headers in the request. + */ + headerMatches?: Schema$HttpHeaderMatch[]; + /** + * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive 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. + */ + 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. + */ + prefixMatch?: string | null; + /** + * Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. + */ + queryParameterMatches?: Schema$HttpQueryParameterMatch[]; + /** + * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + */ + regexMatch?: string | null; + } + export interface Schema$HTTPSHealthCheck { + /** + * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The request path of the HTTPS health check request. The default value is /. + */ + requestPath?: string | null; + /** + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + */ + response?: string | null; + } + /** + * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. + */ + export interface Schema$HttpsHealthCheck { + /** + * How often (in seconds) to send a health check. The default value is 5 seconds. + */ + checkIntervalSec?: number | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. + */ + healthyThreshold?: number | null; + /** + * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Type of the resource. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The TCP port number for the HTTPS health check request. The default value is 443. + */ + port?: number | null; + /** + * The request path of the HTTPS health check request. The default value is "/". + */ + requestPath?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. + */ + timeoutSec?: number | null; + /** + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. + */ + unhealthyThreshold?: number | null; + } + /** + * Contains a list of HttpsHealthCheck resources. + */ + export interface Schema$HttpsHealthCheckList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HttpsHealthCheck resources. + */ + items?: Schema$HttpsHealthCheck[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) + */ + export interface Schema$Image { + /** + * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). + */ + archiveSizeBytes?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * The deprecation status associated with this image. + */ + deprecated?: Schema$DeprecationStatus; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Size of the image when restored onto a persistent disk (in GB). + */ + diskSizeGb?: string | null; + /** + * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. + */ + family?: string | null; + /** + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. + */ + imageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] Type of the resource. Always compute#image for images. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this image. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; + /** + * Integer license codes indicating which licenses are attached to this image. + */ + licenseCodes?: string[] | null; + /** + * Any applicable license URI. + */ + licenses?: string[] | null; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The parameters of the raw disk image. + */ + rawDisk?: { + containerType?: string; + sha1Checksum?: string; + source?: string; + } | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * Set the secure boot keys of shielded instance. + */ + shieldedInstanceInitialState?: Schema$InitialStateConfig; + /** + * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + */ + sourceDisk?: string | null; + /** + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. + */ + sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. + */ + sourceDiskId?: string | null; + /** + * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. + */ + sourceImage?: string | null; + /** + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. + */ + sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. + */ + sourceImageId?: string | null; + /** + * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. + */ + sourceSnapshot?: string | null; + /** + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. + */ + sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. + */ + sourceSnapshotId?: string | null; + /** + * The type of the image used to create this disk. The default and only value is RAW + */ + sourceType?: string | null; + /** + * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. + */ + status?: string | null; + /** + * Cloud Storage bucket storage location of the image (regional or multi-regional). + */ + storageLocations?: string[] | null; + } + /** + * Contains a list of images. + */ + export interface Schema$ImageList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Image resources. + */ + items?: Schema$Image[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Initial State for shielded instance, these are public keys which are safe to store in public + */ + export interface Schema$InitialStateConfig { + /** + * The Key Database (db). + */ + dbs?: Schema$FileContentBuffer[]; + /** + * The forbidden key database (dbx). + */ + dbxs?: Schema$FileContentBuffer[]; + /** + * The Key Exchange Key (KEK). + */ + keks?: Schema$FileContentBuffer[]; + /** + * The Platform Key (PK). + */ + pk?: Schema$FileContentBuffer; + } + /** + * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) + */ + export interface Schema$Instance { + /** + * Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. + */ + canIpForward?: boolean | null; + /** + * [Output Only] The CPU platform used by this instance. + */ + cpuPlatform?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * Whether the resource should be protected against deletion. + */ + deletionProtection?: boolean | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Array of disks associated with this instance. Persistent disks must be created before you can assign them. + */ + disks?: Schema$AttachedDisk[]; + /** + * 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. + */ + guestAccelerators?: Schema$AcceleratorConfig[]; + /** + * Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. + */ + hostname?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group. + */ + instanceEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] Type of the resource. Always compute#instance for instances. + */ + kind?: string | null; + /** + * A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this instance. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; + /** + * Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. + */ + machineType?: string | null; + /** + * The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. + */ + metadata?: Schema$Metadata; + /** + * Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". + */ + minCpuPlatform?: 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. + */ + name?: string | null; + /** + * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. + */ + networkInterfaces?: Schema$NetworkInterface[]; + /** + * Total amount of preserved state for SUSPENDED instances. Read-only in the api. + */ + preservedStateSizeGb?: string | null; + /** + * Specifies the reservations that this instance can consume from. + */ + reservationAffinity?: Schema$ReservationAffinity; + /** + * Resource policies applied to this instance. + */ + resourcePolicies?: string[] | null; + /** + * Sets the scheduling options for this instance. + */ + scheduling?: Schema$Scheduling; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. + */ + serviceAccounts?: Schema$ServiceAccount[]; + shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; + 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. + */ + startRestricted?: boolean | null; + /** + * [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. + */ + status?: string | null; + /** + * [Output Only] An optional, human-readable explanation of the status. + */ + statusMessage?: string | null; + /** + * Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. + */ + tags?: Schema$Tags; + /** + * [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$InstanceAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * An object that contains a list of instances scoped by zone. + */ + items?: {[key: string]: Schema$InstancesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. + */ + 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 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 ==) + */ + export interface Schema$InstanceGroup { + /** + * [Output Only] The creation timestamp for this instance group in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. + */ + fingerprint?: string | null; + /** + * [Output Only] A unique identifier for this instance group, generated by the server. + */ + id?: string | null; + /** + * [Output Only] The resource type, which is always compute#instanceGroup for instance groups. + */ + kind?: string | null; + /** + * The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. + */ + name?: string | null; + /** + * Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. + */ + namedPorts?: Schema$NamedPort[]; + /** + * The URL of the network to which all instances in the instance group belong. + */ + network?: string | null; + /** + * [Output Only] The URL of the region where the instance group is located (for regional resources). + */ + region?: string | null; + /** + * [Output Only] The URL for this instance group. The server generates this URL. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The total number of instances in the instance group. + */ + size?: number | null; + /** + * [Output Only] The URL of the subnetwork to which all instances in the instance group belong. + */ + subnetwork?: string | null; + /** + * [Output Only] The URL of the zone where the instance group is located (for zonal resources). + */ + zone?: string | null; + } + export interface Schema$InstanceGroupAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceGroupsScopedList resources. + */ + items?: {[key: string]: Schema$InstanceGroupsScopedList} | null; + /** + * [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. + */ + 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; + } + /** + * A list of InstanceGroup resources. + */ + export interface Schema$InstanceGroupList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceGroup resources. + */ + items?: Schema$InstanceGroup[]; + /** + * [Output Only] The resource type, which is always compute#instanceGroupList for instance group 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 Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) + */ + export interface Schema$InstanceGroupManager { + /** + * The autohealing policy for this managed instance group. You can specify only one value. + */ + autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; + /** + * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + */ + baseInstanceName?: string | null; + /** + * [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. + */ + currentActions?: Schema$InstanceGroupManagerActionsSummary; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Policy specifying intended distribution of instances in regional managed instance group. + */ + distributionPolicy?: Schema$DistributionPolicy; + /** + * The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. + */ + failoverAction?: string | null; + /** + * Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. + */ + fingerprint?: string | null; + /** + * [Output Only] A unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] The URL of the Instance Group resource. + */ + instanceGroup?: string | null; + /** + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. + */ + instanceTemplate?: string | null; + /** + * [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. + */ + kind?: string | null; + /** + * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. + */ + name?: string | null; + /** + * Named ports configured for the Instance Groups complementary to this Instance Group Manager. + */ + namedPorts?: Schema$NamedPort[]; + /** + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions. + */ + pendingActions?: Schema$InstanceGroupManagerPendingActionsSummary; + /** + * [Output Only] The URL of the region where the managed instance group resides (for regional resources). + */ + region?: string | null; + /** + * [Output Only] The URL for this managed instance group. The server defines this URL. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * 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. + */ + status?: Schema$InstanceGroupManagerStatus; + /** + * The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. + */ + targetPools?: string[] | null; + /** + * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. + */ + targetSize?: number | null; + /** + * The update policy for this managed instance group. + */ + updatePolicy?: Schema$InstanceGroupManagerUpdatePolicy; + /** + * Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. + */ + versions?: Schema$InstanceGroupManagerVersion[]; + /** + * [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). + */ + zone?: string | null; + } + export interface Schema$InstanceGroupManagerActionsSummary { + /** + * [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. + */ + abandoning?: number | null; + /** + * [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. + */ + creating?: number | null; + /** + * [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. + */ + creatingWithoutRetries?: number | null; + /** + * [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. + */ + deleting?: number | null; + /** + * [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. + */ + none?: number | null; + /** + * [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. + */ + recreating?: number | null; + /** + * [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. + */ + refreshing?: number | null; + /** + * [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. + */ + restarting?: number | null; + /** + * [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. + */ + verifying?: number | null; + } + export interface Schema$InstanceGroupManagerAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceGroupManagersScopedList resources. + */ + items?: {[key: string]: Schema$InstanceGroupManagersScopedList} | null; + /** + * [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$InstanceGroupManagerAutoHealingPolicy { + /** + * The URL for the health check that signals autohealing. + */ + healthCheck?: string | null; + /** + * The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. + */ + initialDelaySec?: number | null; + /** + * Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. + */ + maxUnavailable?: Schema$FixedOrPercent; + } + /** + * [Output Only] A list of managed instance groups. + */ + export interface Schema$InstanceGroupManagerList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceGroupManager resources. + */ + items?: Schema$InstanceGroupManager[]; + /** + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$InstanceGroupManagerPendingActionsSummary { + /** + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created. + */ + creating?: number | null; + /** + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted. + */ + deleting?: number | null; + /** + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated. + */ + recreating?: number | null; + /** + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted. + */ + restarting?: number | null; + } + export interface Schema$InstanceGroupManagersAbandonInstancesRequest { + /** + * 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]. + */ + instances?: string[] | null; + } + /** + * InstanceGroupManagers.applyUpdatesToInstances + */ + export interface Schema$InstanceGroupManagersApplyUpdatesRequest { + /** + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + /** + * The maximal action that should be performed on the instances. By default REPLACE. This field is deprecated, please use most_disruptive_allowed_action. + */ + maximalAction?: string | null; + /** + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. + */ + minimalAction?: string | null; + /** + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. + */ + mostDisruptiveAllowedAction?: string | null; + } + /** + * InstanceGroupManagers.createInstances + */ + 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]. + */ + instances?: string[] | null; + } + /** + * InstanceGroupManagers.deletePerInstanceConfigs + */ + export interface Schema$InstanceGroupManagersDeletePerInstanceConfigsReq { + /** + * The list of instances for which we want to delete per-instance configs on this managed instance group. + */ + instances?: string[] | null; + /** + * The list of instance names for which we want to delete per-instance configs on this managed instance group. + */ + 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. + */ + managedInstances?: Schema$ManagedInstance[]; + /** + * [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$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]. + */ + instances?: string[] | null; + } + export interface Schema$InstanceGroupManagersResizeAdvancedRequest { + /** + * If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds. This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario. This flag is applicable only to the current resize request. It does not influence other resize requests in any way. You can see which instances is being creating in which mode by calling the get or listManagedInstances API. + */ + noCreationRetries?: boolean | null; + /** + * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. + */ + targetSize?: number | null; + } + export interface Schema$InstanceGroupManagersScopedList { + /** + * [Output Only] The list of managed instance groups that are contained in the specified project and zone. + */ + instanceGroupManagers?: Schema$InstanceGroupManager[]; + /** + * [Output Only] The warning that replaces the list of managed instance groups when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$InstanceGroupManagersSetAutoHealingRequest { + autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; + } + export interface Schema$InstanceGroupManagersSetInstanceTemplateRequest { + /** + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. + */ + instanceTemplate?: string | null; + } + export interface Schema$InstanceGroupManagersSetTargetPoolsRequest { + /** + * The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. + */ + fingerprint?: string | null; + /** + * The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings. + */ + targetPools?: string[] | null; + } + export interface Schema$InstanceGroupManagerStatus { + /** + * [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. + */ + 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. + */ + maxSurge?: Schema$FixedOrPercent; + /** + * The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. 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 maxUnavailable. + */ + maxUnavailable?: Schema$FixedOrPercent; + /** + * Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. + */ + minimalAction?: string | null; + /** + * 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). + */ + type?: string | null; + } + export interface Schema$InstanceGroupManagerVersion { + /** + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. + */ + instanceTemplate?: string | null; + /** + * Name of the version. Unique among all versions in the scope of this managed instance group. + */ + name?: string | null; + /** + * Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. + */ + tag?: string | null; + /** + * Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. + */ + targetSize?: Schema$FixedOrPercent; + } + export interface Schema$InstanceGroupsAddInstancesRequest { + /** + * The list of instances to add to the instance group. + */ + instances?: Schema$InstanceReference[]; + } + export interface Schema$InstanceGroupsListInstances { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceWithNamedPorts resources. + */ + items?: Schema$InstanceWithNamedPorts[]; + /** + * [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$InstanceGroupsListInstancesRequest { + /** + * A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. + */ + instanceState?: string | null; + } + export interface Schema$InstanceGroupsRemoveInstancesRequest { + /** + * The list of instances to remove from the instance group. + */ + instances?: Schema$InstanceReference[]; + } + export interface Schema$InstanceGroupsScopedList { + /** + * [Output Only] The list of instance groups that are contained in this scope. + */ + instanceGroups?: Schema$InstanceGroup[]; + /** + * [Output Only] An informational warning that replaces the list of instance groups when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$InstanceGroupsSetNamedPortsRequest { + /** + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet. + */ + fingerprint?: string | null; + /** + * The list of named ports to set for this instance group. + */ + namedPorts?: Schema$NamedPort[]; + } + /** + * Contains a list of instances. + */ + export interface Schema$InstanceList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Instance resources. + */ + items?: Schema$Instance[]; + /** + * [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. + */ + 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; + } + /** + * Contains a list of instance referrers. + */ + export interface Schema$InstanceListReferrers { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Reference resources. + */ + items?: Schema$Reference[]; + /** + * [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$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 + */ + destinationZone?: string | null; + /** + * The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance + */ + targetInstance?: string | null; + } + export interface Schema$InstanceProperties { + /** + * Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. + */ + canIpForward?: boolean | null; + /** + * An optional text description for the instances that are created from this instance template. + */ + description?: string | null; + /** + * An array of disks that are associated with the instances that are created from this template. + */ + disks?: Schema$AttachedDisk[]; + /** + * Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer + */ + displayDevice?: Schema$DisplayDevice; + /** + * A list of guest accelerator cards' type and count to use for instances created from the instance template. + */ + guestAccelerators?: Schema$AcceleratorConfig[]; + /** + * Labels to apply to instances that are created from this template. + */ + labels?: {[key: string]: string} | null; + /** + * The machine type to use for instances that are created from this template. + */ + machineType?: string | null; + /** + * The metadata key/value pairs to assign to instances that are created from this template. 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 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 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 reservations that this instance can consume from. + */ + reservationAffinity?: Schema$ReservationAffinity; + /** + * Specifies the scheduling options for the instances that are created from this template. + */ + 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 template. Use metadata queries to obtain the access tokens for these instances. + */ + serviceAccounts?: Schema$ServiceAccount[]; + shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; + /** + * Specifies the Shielded VM options for the instances that are created from this template. + */ + shieldedVmConfig?: Schema$ShieldedVmConfig; + /** + * A list of tags to apply to the instances that are created from this template. 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; + } + export interface Schema$InstanceReference { + /** + * The URL for a specific instance. + */ + instance?: string | null; + } + export interface Schema$InstancesAddResourcePoliciesRequest { + /** + * Resource policies to be added to this instance. + */ + resourcePolicies?: string[] | null; + } + export interface Schema$InstancesGetEffectiveFirewallsResponse { + /** + * Effective firewalls on the instance. + */ + firewalls?: Schema$Firewall[]; + /** + * Effective firewalls from organization policies. + */ + organizationFirewalls?: Schema$InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy[]; + } + /** + * A pruned SecurityPolicy containing ID and any applicable firewall rules. + */ + export interface Schema$InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy { + /** + * The unique identifier for the security policy. This identifier is defined by the server. + */ + id?: string | null; + /** + * The rules that apply to the network. + */ + rules?: Schema$SecurityPolicyRule[]; + } + export interface Schema$InstancesRemoveResourcePoliciesRequest { + /** + * Resource policies to be removed from this instance. + */ + resourcePolicies?: string[] | null; + } + export interface Schema$InstancesResumeRequest { + /** + * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. + */ + disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; + /** + * Decrypts data associated with an instance that is protected with a customer-supplied encryption key. If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed. + */ + instanceEncryptionKey?: Schema$CustomerEncryptionKey; + } + export interface Schema$InstancesScopedList { + /** + * [Output Only] A list of instances contained in this scope. + */ + instances?: Schema$Instance[]; + /** + * [Output Only] Informational warning which replaces the list of instances when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$InstancesSetLabelsRequest { + /** + * Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels. + */ + labelFingerprint?: string | null; + labels?: {[key: string]: string} | null; + } + export interface Schema$InstancesSetMachineResourcesRequest { + /** + * A list of the type and count of accelerator cards attached to the instance. + */ + guestAccelerators?: Schema$AcceleratorConfig[]; + } + export interface Schema$InstancesSetMachineTypeRequest { + /** + * Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1 + */ + machineType?: string | null; + } + export interface Schema$InstancesSetMinCpuPlatformRequest { + /** + * Minimum cpu/platform this instance should be started at. + */ + minCpuPlatform?: string | null; + } + export interface Schema$InstancesSetNameRequest { + /** + * The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name. + */ + currentName?: string | null; + /** + * The name to be applied to the instance. Needs to be RFC 1035 compliant. + */ + name?: string | null; + } + export interface Schema$InstancesSetServiceAccountRequest { + /** + * Email address of the service account. + */ + email?: string | null; + /** + * The list of scopes to be made available for this service account. + */ + scopes?: string[] | null; + } + export interface Schema$InstancesStartWithEncryptionKeyRequest { + /** + * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. + */ + disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; + /** + * Decrypts data associated with an instance that is protected with a customer-supplied encryption key. If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed. + */ + instanceEncryptionKey?: Schema$CustomerEncryptionKey; + } + /** + * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) + */ + export interface Schema$InstanceTemplate { + /** + * [Output Only] The creation timestamp for this instance template in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] A unique identifier for this instance template. The server defines this identifier. + */ + id?: string | null; + /** + * [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. + */ + kind?: string | null; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The instance properties for this instance template. + */ + properties?: Schema$InstanceProperties; + /** + * [Output Only] The URL for this instance template. The server defines this URL. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * The source instance used to create the template. 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; + /** + * The source instance params to use to create this instance template. + */ + sourceInstanceParams?: Schema$SourceInstanceParams; + } + /** + * A list of instance templates. + */ + export interface Schema$InstanceTemplateList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceTemplate resources. + */ + items?: Schema$InstanceTemplate[]; + /** + * [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template 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; + } + export interface Schema$InstanceWithNamedPorts { + /** + * [Output Only] The URL of the instance. + */ + instance?: string | null; + /** + * [Output Only] The named ports that belong to this instance group. + */ + namedPorts?: Schema$NamedPort[]; + /** + * [Output Only] The status of the instance. + */ + status?: string | null; + } + /** + * HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. + */ + export interface Schema$Int64RangeMatch { + /** + * The end of the range (exclusive) in signed long integer format. + */ + rangeEnd?: string | null; + /** + * The start of the range (inclusive) in signed long integer format. + */ + rangeStart?: string | null; + } + /** + * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + */ + export interface Schema$Interconnect { + /** + * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + */ + adminEnabled?: boolean | null; + /** + * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. + */ + circuitInfos?: Schema$InterconnectCircuitInfo[]; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. + */ + customerName?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] A list of outages expected for this Interconnect. + */ + expectedOutages?: Schema$InterconnectOutageNotification[]; + /** + * [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. + */ + googleIpAddress?: string | null; + /** + * [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. + */ + googleReferenceId?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. + */ + interconnectAttachments?: string[] | null; + /** + * Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. + */ + interconnectType?: string | null; + /** + * [Output Only] Type of the resource. Always compute#interconnect for interconnects. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. + */ + linkType?: string | null; + /** + * URL of the InterconnectLocation object that represents where this connection is to be provisioned. + */ + location?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. + */ + nocContactEmail?: string | null; + /** + * [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + */ + operationalStatus?: string | null; + /** + * [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. + */ + peerIpAddress?: string | null; + /** + * [Output Only] Number of links actually provisioned in this interconnect. + */ + provisionedLinkCount?: number | null; + /** + * Target number of physical links in the link bundle, as requested by the customer. + */ + requestedLinkCount?: number | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + */ + state?: string | null; + } + /** + * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) + */ + export interface Schema$InterconnectAttachment { + /** + * Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. + */ + adminEnabled?: boolean | null; + /** + * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + */ + bandwidth?: string | null; + /** + * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. + */ + candidateSubnets?: string[] | null; + /** + * [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + */ + cloudRouterIpAddress?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + */ + customerRouterIpAddress?: string | null; + /** + * An optional description of this resource. + */ + description?: string | null; + /** + * Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. + */ + edgeAvailabilityDomain?: string | null; + /** + * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. + */ + googleReferenceId?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * URL of the underlying Interconnect object that this attachment's traffic will traverse through. + */ + interconnect?: string | null; + /** + * [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. + */ + mtu?: number | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. + */ + operationalStatus?: string | null; + /** + * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" + */ + pairingKey?: string | null; + /** + * Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. + */ + partnerAsn?: string | null; + /** + * Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. + */ + partnerMetadata?: Schema$InterconnectAttachmentPartnerMetadata; + /** + * [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED. + */ + privateInterconnectInfo?: Schema$InterconnectAttachmentPrivateInfo; + /** + * [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. + */ + router?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. + */ + state?: string | null; + /** + * The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. + */ + type?: string | null; + /** + * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. + */ + vlanTag8021q?: number | null; + } + export interface Schema$InterconnectAttachmentAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InterconnectAttachmentsScopedList resources. + */ + items?: {[key: string]: Schema$InterconnectAttachmentsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments. + */ + 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; + } + /** + * Response to the list request, and contains a list of interconnect attachments. + */ + export interface Schema$InterconnectAttachmentList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InterconnectAttachment resources. + */ + items?: Schema$InterconnectAttachment[]; + /** + * [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments. + */ + 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; + } + /** + * Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. + */ + export interface Schema$InterconnectAttachmentPartnerMetadata { + /** + * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. + */ + interconnectName?: string | null; + /** + * Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values. + */ + partnerName?: string | null; + /** + * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. + */ + portalUrl?: string | null; + } + /** + * Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. + */ + export interface Schema$InterconnectAttachmentPrivateInfo { + /** + * [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region. + */ + tag8021q?: number | null; + } + export interface Schema$InterconnectAttachmentsScopedList { + /** + * A list of interconnect attachments contained in this scope. + */ + interconnectAttachments?: Schema$InterconnectAttachment[]; + /** + * Informational warning which replaces the list of addresses when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 + */ + export interface Schema$InterconnectCircuitInfo { + /** + * Customer-side demarc ID for this circuit. + */ + customerDemarcId?: string | null; + /** + * Google-assigned unique ID for this circuit. Assigned at circuit turn-up. + */ + googleCircuitId?: string | null; + /** + * Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. + */ + googleDemarcId?: string | null; + } + /** + * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. + */ + export interface Schema$InterconnectDiagnostics { + /** + * A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled. + */ + arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; + /** + * A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect. + */ + links?: Schema$InterconnectDiagnosticsLinkStatus[]; + /** + * The MAC address of the Interconnect's bundle interface. + */ + macAddress?: string | null; + } + /** + * Describing the ARP neighbor entries seen on this link + */ + export interface Schema$InterconnectDiagnosticsARPEntry { + /** + * The IP address of this ARP neighbor. + */ + ipAddress?: string | null; + /** + * The MAC address of this ARP neighbor. + */ + macAddress?: string | null; + } + export interface Schema$InterconnectDiagnosticsLinkLACPStatus { + /** + * System ID of the port on Google?s side of the LACP exchange. + */ + googleSystemId?: string | null; + /** + * System ID of the port on the neighbor?s side of the LACP exchange. + */ + neighborSystemId?: string | null; + /** + * The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. + */ + state?: string | null; + } + export interface Schema$InterconnectDiagnosticsLinkOpticalPower { + /** + * The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. + */ + state?: string | null; + /** + * Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. + */ + value?: number | null; + } + export interface Schema$InterconnectDiagnosticsLinkStatus { + /** + * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled + */ + arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; + /** + * The unique ID for this link assigned during turn up by Google. + */ + circuitId?: string | null; + /** + * The Demarc address assigned by Google and provided in the LoA. + */ + googleDemarc?: string | null; + lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; + /** + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. + */ + receivingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; + /** + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level. + */ + transmittingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; + } + /** + * Response to the list request, and contains a list of interconnects. + */ + export interface Schema$InterconnectList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Interconnect resources. + */ + items?: Schema$Interconnect[]; + /** + * [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. + */ + 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 Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. + */ + export interface Schema$InterconnectLocation { + /** + * [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. + */ + address?: string | null; + /** + * [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". + */ + availabilityZone?: string | null; + /** + * [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". + */ + city?: string | null; + /** + * [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA + */ + continent?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] An optional description of the resource. + */ + description?: string | null; + /** + * [Output Only] The name of the provider for this facility (e.g., EQUINIX). + */ + facilityProvider?: string | null; + /** + * [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). + */ + facilityProviderFacilityId?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. + */ + kind?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). + */ + peeringdbFacilityId?: string | null; + /** + * [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. + */ + regionInfos?: Schema$InterconnectLocationRegionInfo[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. + */ + status?: string | null; + } + /** + * Response to the list request, and contains a list of interconnect locations. + */ + export interface Schema$InterconnectLocationList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InterconnectLocation resources. + */ + items?: Schema$InterconnectLocation[]; + /** + * [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations. + */ + 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; + } + /** + * Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. + */ + export interface Schema$InterconnectLocationRegionInfo { + /** + * Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. + */ + expectedRttMs?: string | null; + /** + * Identifies the network presence of this location. + */ + locationPresence?: string | null; + /** + * URL for the region of this location. + */ + region?: string | null; + } + /** + * Description of a planned outage on this Interconnect. Next id: 9 + */ + export interface Schema$InterconnectOutageNotification { + /** + * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. + */ + affectedCircuits?: string[] | null; + /** + * A description about the purpose of the outage. + */ + description?: string | null; + /** + * Scheduled end time for the outage (milliseconds since Unix epoch). + */ + endTime?: string | null; + /** + * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. + */ + issueType?: string | null; + /** + * Unique identifier for this outage notification. + */ + name?: string | null; + /** + * The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. + */ + source?: string | null; + /** + * Scheduled start time for the outage (milliseconds since Unix epoch). + */ + startTime?: string | null; + /** + * State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. + */ + state?: string | null; + } + /** + * Response for the InterconnectsGetDiagnosticsRequest. + */ + export interface Schema$InterconnectsGetDiagnosticsResponse { + result?: Schema$InterconnectDiagnostics; + } + export interface Schema$InternalIpAddress { + /** + * IP CIDR address or range. + */ + cidr?: string | null; + /** + * The owner of the internal IP address. + */ + owner?: string | null; + /** + * The purpose of the internal IP address if applicable. + */ + purpose?: string | null; + /** + * The region of the internal IP address if applicable. + */ + region?: string | null; + /** + * The type of the internal IP address. + */ + type?: string | null; + } + export interface Schema$InternalIpOwner { + /** + * IP CIDR range being owned. + */ + ipCidrRange?: string | null; + /** + * URLs of the IP owners of the IP CIDR range. + */ + owners?: string[] | null; + /** + * Whether this IP CIDR range is reserved for system use. + */ + systemOwned?: boolean | null; + } + export interface Schema$IpAddressesList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InternalIpAddress resources. + */ + items?: Schema$InternalIpAddress[]; + /** + * [Output Only] Type of resource. Always compute#ipAddressesList for IP addresses 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; + } + /** + * Contains a list of IP owners. + */ + export interface Schema$IpOwnerList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InternalIpOwner resources. + */ + items?: Schema$InternalIpOwner[]; + /** + * [Output Only] Type of resource. Always compute#ipOwnerList for lists of IP owners. + */ + 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; + } + /** + * JWT configuration for origin authentication. + */ + export interface Schema$Jwt { + /** + * A JWT containing any of these audiences will be accepted. The service name will be accepted if audiences is empty. Examples: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com + */ + audiences?: string[] | null; + /** + * Identifies the issuer that issued the JWT, which is usually a URL or an email address. Examples: https://securetoken.google.com, 1234567-compute@developer.gserviceaccount.com + */ + issuer?: string | null; + /** + * The provider?s public key set to validate the signature of the JWT. + */ + jwksPublicKeys?: string | null; + /** + * jwt_headers and jwt_params define where to extract the JWT from an HTTP request. If no explicit location is specified, the following default locations are tried in order: 1. The Authorization header using the Bearer schema. See `here `_. Example: Authorization: Bearer . 2. `access_token` query parameter. See `this `_ Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations its issuer specified or from the default locations. This field is set if JWT is sent in a request header. This field specifies the header name. For example, if `header=x-goog-iap-jwt-assertion`, the header format will be x-goog-iap-jwt-assertion: . + */ + jwtHeaders?: Schema$JwtHeader[]; + /** + * This field is set if JWT is sent in a query parameter. This field specifies the query parameter name. For example, if jwt_params[0] is jwt_token, the JWT format in the query parameter is /path?jwt_token=. + */ + jwtParams?: string[] | null; + } + /** + * This message specifies a header location to extract JWT token. + */ + export interface Schema$JwtHeader { + /** + * The HTTP header name. + */ + name?: string | null; + /** + * The value prefix. The value format is "value_prefix" For example, for "Authorization: Bearer ", value_prefix="Bearer " with a space at the end. + */ + valuePrefix?: string | null; + } + /** + * A license resource. + */ + export interface Schema$License { + /** + * [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. + */ + chargesUseFee?: boolean | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional textual description of the resource; provided by the client when the resource is created. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#license for licenses. + */ + kind?: string | null; + /** + * [Output Only] The unique code used to attach this license to images, snapshots, and disks. + */ + licenseCode?: string | null; + /** + * Name of the resource. The name must be 1-63 characters long and comply with RFC1035. + */ + name?: string | null; + resourceRequirements?: Schema$LicenseResourceRequirements; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. + */ + transferable?: boolean | null; + } + export interface Schema$LicenseCode { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] Description of this License Code. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#licenseCode for licenses. + */ + kind?: string | null; + /** + * [Output Only] URL and description aliases of Licenses with the same License Code. + */ + licenseAlias?: Schema$LicenseCodeLicenseAlias[]; + /** + * [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Current state of this License Code. + */ + state?: string | null; + /** + * [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. + */ + transferable?: boolean | null; + } + export interface Schema$LicenseCodeLicenseAlias { + /** + * [Output Only] Description of this License Code. + */ + description?: string | null; + /** + * [Output Only] URL of license corresponding to this License Code. + */ + selfLink?: string | null; + } + export interface Schema$LicenseResourceRequirements { + /** + * Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. + */ + minGuestCpuCount?: number | null; + /** + * Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. + */ + minMemoryMb?: number | null; + } + export interface Schema$LicensesListResponse { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of License resources. + */ + items?: Schema$License[]; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$LocalDisk { + /** + * Specifies the number of such disks. + */ + diskCount?: string | null; + /** + * Specifies the size of the disk in base-2 GB. + */ + diskSizeGb?: string | 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. + */ + diskType?: string | null; + } + /** + * Specifies what kind of log the caller must write + */ + export interface Schema$LogConfig { + /** + * Cloud audit options. + */ + cloudAudit?: Schema$LogConfigCloudAuditOptions; + /** + * Counter options. + */ + counter?: Schema$LogConfigCounterOptions; + /** + * Data access options. + */ + dataAccess?: Schema$LogConfigDataAccessOptions; + } + /** + * Write a Cloud Audit log + */ + export interface Schema$LogConfigCloudAuditOptions { + /** + * Information used by the Cloud Audit Logging pipeline. + */ + authorizationLoggingOptions?: Schema$AuthorizationLoggingOptions; + /** + * The log_name to populate in the Cloud Audit Record. + */ + logName?: string | null; + } + /** + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). + */ + export interface Schema$LogConfigCounterOptions { + /** + * The field value to attribute. + */ + field?: string | null; + /** + * The metric to update. + */ + metric?: string | null; + } + /** + * Write a Data Access (Gin) log + */ + export interface Schema$LogConfigDataAccessOptions { + /** + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. + */ + logMode?: string | null; + } + /** + * 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; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: 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 { + etag?: string | null; + /** + * [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 ==) + */ + export interface Schema$MachineType { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this machine type. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] An optional textual description of the resource. + */ + description?: string | null; + /** + * [Output Only] The number of virtual CPUs that are available to the instance. + */ + guestCpus?: number | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. + */ + isSharedCpu?: boolean | null; + /** + * [Output Only] The type of the resource. Always compute#machineType for machine types. + */ + kind?: string | null; + /** + * [Output Only] Maximum persistent disks allowed. + */ + maximumPersistentDisks?: number | null; + /** + * [Output Only] Maximum total persistent disks size (GB) allowed. + */ + maximumPersistentDisksSizeGb?: string | null; + /** + * [Output Only] The amount of physical memory available to the instance, defined in MB. + */ + memoryMb?: number | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The name of the zone where the machine type resides, such as us-central1-a. + */ + zone?: string | null; + } + export interface Schema$MachineTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of MachineTypesScopedList resources. + */ + items?: {[key: string]: Schema$MachineTypesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. + */ + 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; + } + /** + * Contains a list of machine types. + */ + export interface Schema$MachineTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of MachineType resources. + */ + items?: Schema$MachineType[]; + /** + * [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$MachineTypesScopedList { + /** + * [Output Only] A list of machine types contained in this scope. + */ + machineTypes?: Schema$MachineType[]; + /** + * [Output Only] An informational warning that appears when the machine types list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A Managed Instance resource. + */ + export interface Schema$ManagedInstance { + /** + * [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. + */ + currentAction?: string | null; + /** + * [Output only] The unique identifier for this resource. This field is empty when instance does not exist. + */ + id?: string | null; + /** + * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. + */ + instance?: string | null; + /** + * [Output Only] Health state of the instance per health-check. + */ + instanceHealth?: Schema$ManagedInstanceInstanceHealth[]; + /** + * [Output Only] The status of the instance. This field is empty when the instance does not exist. + */ + instanceStatus?: string | null; + /** + * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. + */ + instanceTemplate?: string | null; + /** + * [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] Tag describing the version. + */ + tag?: string | null; + /** + * [Output Only] Intended version of this instance. + */ + version?: Schema$ManagedInstanceVersion; + } + export interface Schema$ManagedInstanceInstanceHealth { + /** + * [Output Only] The current detailed instance health state. + */ + detailedHealthState?: string | null; + /** + * [Output Only] The URL for the health check that verifies whether the instance is healthy. + */ + healthCheck?: string | null; + /** + * [Output Only] The current instance health state. This field will not get promoted to beta/GA and might be removed from alpha APIs after 01/12/2019. Please use detailed_health_state field instead. + */ + healthState?: string | null; + } + export interface Schema$ManagedInstanceLastAttempt { + /** + * [Output Only] Encountered errors during the last attempt to create or delete the instance. + */ + errors?: { + errors?: Array<{code?: string; location?: string; message?: string}>; + } | null; + } + export interface Schema$ManagedInstanceVersion { + /** + * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. + */ + instanceTemplate?: string | null; + /** + * [Output Only] Name of the version. + */ + name?: string | null; + } + /** + * A metadata key/value entry. + */ + export interface Schema$Metadata { + /** + * Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. + */ + fingerprint?: string | null; + /** + * Array of key/value pairs. The total size of all keys and values must be less than 512 KB. + */ + items?: Array<{key?: string; value?: string}> | null; + /** + * [Output Only] Type of the resource. Always compute#metadata for metadata. + */ + kind?: string | null; + } + /** + * Custom authenticator credentials. + */ + export interface Schema$MetadataCredentialsFromPlugin { + /** + * Plugin name. + */ + name?: string | null; + /** + * A text proto that conforms to a Struct type definition interpreted by the plugin. + */ + 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. + */ + export interface Schema$MetadataFilter { + /** + * The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. + */ + filterLabels?: Schema$MetadataFilterLabelMatch[]; + /** + * Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. + */ + filterMatchCriteria?: string | null; + } + /** + * MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. + */ + export interface Schema$MetadataFilterLabelMatch { + /** + * Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. + */ + name?: string | null; + /** + * The value of the label must match the specified value. value can have a maximum length of 1024 characters. + */ + value?: string | null; + } + /** + * Configuration for the mutual Tls mode for peer authentication. + */ + export interface Schema$MutualTls { + /** + * Specifies if the server TLS is configured to be strict or permissive. This field can be set to one of the following: STRICT: Client certificate must be presented, connection is in TLS. PERMISSIVE: Client certificate can be omitted, connection can be either plaintext or TLS. + */ + mode?: string | null; + } + /** + * The named port. For example: . + */ + export interface Schema$NamedPort { + /** + * The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. + */ + name?: string | null; + /** + * The port number, which can be a value between 1 and 65535. + */ + port?: number | null; + } + /** + * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) + */ + export interface Schema$Network { + /** + * When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. + */ + autoCreateSubnetworks?: boolean | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] Type of VM-to-VM traffic encryption for this network. + */ + crossVmEncryption?: string | null; + /** + * An optional description of this resource. Provide this field when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The gateway address for default routing out of the network, selected by GCP. + */ + gatewayIPv4?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. + */ + IPv4Range?: string | null; + /** + * [Output Only] Type of the resource. Always compute#network for networks. + */ + kind?: string | null; + /** + * [Output Only] Type of LB-to-VM traffic encryption for this network. + */ + loadBalancerVmEncryption?: string | null; + /** + * Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1600 bytes. + */ + mtu?: number | null; + /** + * The multicast mode for this network. If set to ZONAL, multicast is allowed within a zone. If set to DISABLED, multicast is disabled for this network. The default is DISABLED. + */ + multicastMode?: string | 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?: string | null; + /** + * [Output Only] A list of network peerings for the resource. + */ + peerings?: Schema$NetworkPeering[]; + /** + * The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. + */ + routingConfig?: Schema$NetworkRoutingConfig; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. + */ + subnetworks?: string[] | null; + } + /** + * The network endpoint. + */ + export interface Schema$NetworkEndpoint { + /** + * Metadata defined as annotations on the network endpoint. + */ + annotations?: {[key: string]: string} | null; + /** + * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. + */ + fqdn?: string | null; + /** + * The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035. + */ + instance?: string | null; + /** + * Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. + */ + ipAddress?: string | null; + /** + * Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used. + */ + port?: number | null; + } + /** + * Represents a collection of network endpoints. + */ + export interface Schema$NetworkEndpointGroup { + /** + * Metadata defined as annotations on the network endpoint group. + */ + annotations?: {[key: string]: string} | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * The default port used if the port number is not specified in the network endpoint. + */ + defaultPort?: number | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. + */ + kind?: string | null; + /** + * This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated. + */ + loadBalancer?: Schema$NetworkEndpointGroupLbNetworkEndpointGroup; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. + */ + network?: string | null; + /** + * Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT. + */ + networkEndpointType?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output only] Number of network endpoints in the network endpoint group. + */ + size?: number | null; + /** + * Optional URL of the subnetwork to which all network endpoints in the NEG belong. + */ + subnetwork?: string | null; + /** + * Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now. + */ + type?: string | null; + /** + * [Output Only] The URL of the zone where the network endpoint group is located. + */ + zone?: string | null; + } + export interface Schema$NetworkEndpointGroupAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkEndpointGroupsScopedList resources. + */ + items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList} | null; + /** + * [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. + */ + 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; + } + /** + * Load balancing specific fields for network endpoint group. + */ + export interface Schema$NetworkEndpointGroupLbNetworkEndpointGroup { + /** + * The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. + */ + defaultPort?: number | null; + /** + * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated. + */ + network?: string | null; + /** + * Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. + */ + subnetwork?: string | null; + /** + * [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. + */ + zone?: string | null; + } + export interface Schema$NetworkEndpointGroupList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkEndpointGroup resources. + */ + items?: Schema$NetworkEndpointGroup[]; + /** + * [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group 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; + } + export interface Schema$NetworkEndpointGroupsAttachEndpointsRequest { + /** + * The list of network endpoints to be attached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } + export interface Schema$NetworkEndpointGroupsDetachEndpointsRequest { + /** + * The list of network endpoints to be detached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } + export interface Schema$NetworkEndpointGroupsListEndpointsRequest { + /** + * Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported. + */ + endpointFilters?: Schema$NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter[]; + /** + * Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided. + */ + healthStatus?: string | null; + } + export interface Schema$NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter { + networkEndpoint?: Schema$NetworkEndpoint; + } + export interface Schema$NetworkEndpointGroupsListNetworkEndpoints { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkEndpointWithHealthStatus resources. + */ + items?: Schema$NetworkEndpointWithHealthStatus[]; + /** + * [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group. + */ + 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] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NetworkEndpointGroupsScopedList { + /** + * [Output Only] The list of network endpoint groups that are contained in this scope. + */ + networkEndpointGroups?: Schema$NetworkEndpointGroup[]; + /** + * [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NetworkEndpointWithHealthStatus { + /** + * [Output only] The health status of network endpoint; + */ + healths?: Schema$HealthStatusForNetworkEndpoint[]; + /** + * [Output only] The network endpoint; + */ + networkEndpoint?: Schema$NetworkEndpoint; + } + /** + * A network interface resource attached to an instance. + */ + export interface Schema$NetworkInterface { + /** + * An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. + */ + accessConfigs?: Schema$AccessConfig[]; + /** + * An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. + */ + aliasIpRanges?: Schema$AliasIpRange[]; + /** + * 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. + */ + kind?: string | null; + /** + * [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. + */ + name?: string | null; + /** + * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default + */ + network?: string | null; + /** + * An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. + */ + networkIP?: string | null; + /** + * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork + */ + subnetwork?: string | null; + } + /** + * Contains a list of networks. + */ + export interface Schema$NetworkList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Network resources. + */ + items?: Schema$Network[]; + /** + * [Output Only] Type of resource. Always compute#networkList for lists of networks. + */ + 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; + } + /** + * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. + */ + export interface Schema$NetworkPeering { + /** + * Whether Cloud Routers in this network can automatically advertise subnets from the peer network. + */ + advertisePeerSubnetsViaRouters?: boolean | null; + /** + * This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. + */ + autoCreateRoutes?: boolean | null; + /** + * Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. + */ + exchangeSubnetRoutes?: boolean | null; + /** + * Whether to export the custom routes to peer network. + */ + exportCustomRoutes?: boolean | null; + /** + * Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. + */ + exportSubnetRoutesWithPublicIp?: boolean | null; + /** + * Whether to import the custom routes from peer network. + */ + importCustomRoutes?: boolean | null; + /** + * Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. + */ + importSubnetRoutesWithPublicIp?: boolean | null; + /** + * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. + */ + network?: string | null; + /** + * Maximum Transmission Unit in bytes. + */ + peerMtu?: number | null; + /** + * [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. + */ + state?: string | null; + /** + * [Output Only] Details about the current state of the peering. + */ + stateDetails?: string | null; + } + /** + * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. + */ + export interface Schema$NetworkRoutingConfig { + /** + * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. + */ + routingMode?: string | null; + } + export interface Schema$NetworksAddPeeringRequest { + /** + * This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. + */ + autoCreateRoutes?: boolean | null; + /** + * This field will be deprecated soon. Use export_custom_routes in network_peering instead. Whether to export the custom routes to peer network. + */ + exportCustomRoutes?: boolean | null; + /** + * This field will be deprecated soon. Use import_custom_routes in network_peering instead. Whether to import the custom routes from peer network. + */ + importCustomRoutes?: boolean | null; + /** + * Name of the peering, which should conform to RFC1035. + */ + name?: string | null; + /** + * Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. + */ + networkPeering?: Schema$NetworkPeering; + /** + * URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. + */ + peerNetwork?: string | null; + } + export interface Schema$NetworksGetEffectiveFirewallsResponse { + /** + * Effective firewalls on the network. + */ + firewalls?: Schema$Firewall[]; + /** + * Effective firewalls from organization policies. + */ + organizationFirewalls?: Schema$NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy[]; + } + /** + * A pruned SecurityPolicy containing ID and any applicable firewall rules. + */ + export interface Schema$NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy { + /** + * [Output Only] The unique identifier for the security policy. This identifier is defined by the server. + */ + id?: string | null; + /** + * The rules that apply to the network. + */ + rules?: Schema$SecurityPolicyRule[]; + } + export interface Schema$NetworksRemovePeeringRequest { + /** + * Name of the peering, which should conform to RFC1035. + */ + name?: string | null; + } + export interface Schema$NetworksUpdatePeeringRequest { + 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: 15 + */ + export interface Schema$NodeGroup { + autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] The type of the resource. Always compute#nodeGroup for node group. + */ + kind?: string | null; + 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. + */ + name?: string | null; + /** + * The URL of the node template to which this node group belongs. + */ + nodeTemplate?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The total number of nodes in the node group. + */ + size?: number | null; + status?: string | null; + /** + * [Output Only] The name of the zone where the node group resides, such as us-central1-a. + */ + zone?: string | null; + } + export interface Schema$NodeGroupAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NodeGroupsScopedList resources. + */ + items?: {[key: string]: Schema$NodeGroupsScopedList} | null; + /** + * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NodeGroupAutoscalingPolicy { + maxSize?: number | null; + minSize?: number | null; + mode?: string | null; + } + /** + * Contains a list of nodeGroups. + */ + export interface Schema$NodeGroupList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NodeGroup resources. + */ + items?: Schema$NodeGroup[]; + /** + * [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NodeGroupNode { + /** + * Local disk configurations. + */ + disks?: Schema$LocalDisk[]; + /** + * Instances scheduled on this node. + */ + instances?: string[] | null; + /** + * The name of the node. + */ + name?: string | null; + /** + * The type of this node. + */ + nodeType?: string | null; + /** + * Binding properties for the physical server. + */ + serverBinding?: Schema$ServerBinding; + status?: string | null; + } + export interface Schema$NodeGroupsAddNodesRequest { + /** + * Count of additional nodes to be added to the node group. + */ + additionalNodeCount?: number | null; + } + export interface Schema$NodeGroupsDeleteNodesRequest { + /** + * Names of the nodes to delete. + */ + nodes?: string[] | null; + } + export interface Schema$NodeGroupsListNodes { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Node resources. + */ + items?: Schema$NodeGroupNode[]; + /** + * [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NodeGroupsScopedList { + /** + * [Output Only] A list of node groups contained in this scope. + */ + nodeGroups?: Schema$NodeGroup[]; + /** + * [Output Only] An informational warning that appears when the nodeGroup list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NodeGroupsSetAutoscalingPolicyRequest { + autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; + } + export interface Schema$NodeGroupsSetNodeTemplateRequest { + /** + * Full or partial URL of the node template resource to be updated for this node group. + */ + 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 ==) + */ + export interface Schema$NodeTemplate { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + disks?: Schema$LocalDisk[]; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. + */ + kind?: 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. + */ + name?: string | null; + /** + * Labels to use for node affinity, which will be used in instance scheduling. + */ + nodeAffinityLabels?: {[key: string]: string} | null; + /** + * The node type to use for nodes group that are created from this template. + */ + nodeType?: string | null; + /** + * The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. + */ + nodeTypeFlexibility?: Schema$NodeTemplateNodeTypeFlexibility; + /** + * [Output Only] The name of the region where the node template resides, such as us-central1. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. + */ + serverBinding?: Schema$ServerBinding; + /** + * [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. + */ + status?: string | null; + /** + * [Output Only] An optional, human-readable explanation of the status. + */ + statusMessage?: string | null; + } + export interface Schema$NodeTemplateAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NodeTemplatesScopedList resources. + */ + items?: {[key: string]: Schema$NodeTemplatesScopedList} | null; + /** + * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. + */ + 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; + } + /** + * Contains a list of node templates. + */ + export interface Schema$NodeTemplateList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NodeTemplate resources. + */ + items?: Schema$NodeTemplate[]; + /** + * [Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NodeTemplateNodeTypeFlexibility { + cpus?: string | null; + localSsd?: string | null; + memory?: string | null; + } + export interface Schema$NodeTemplatesScopedList { + /** + * [Output Only] A list of node templates contained in this scope. + */ + nodeTemplates?: Schema$NodeTemplate[]; + /** + * [Output Only] An informational warning that appears when the node templates list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) + */ + export interface Schema$NodeType { + /** + * [Output Only] The CPU platform used by this node type. + */ + cpuPlatform?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this node type. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] An optional textual description of the resource. + */ + description?: string | null; + /** + * [Output Only] The number of virtual CPUs that are available to the node type. + */ + guestCpus?: number | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] The type of the resource. Always compute#nodeType for node types. + */ + kind?: string | null; + /** + * [Output Only] Local SSD available to the node type, defined in GB. + */ + localSsdGb?: number | null; + /** + * [Output Only] The amount of physical memory available to the node type, defined in MB. + */ + memoryMb?: number | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The name of the zone where the node type resides, such as us-central1-a. + */ + zone?: string | null; + } + export interface Schema$NodeTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NodeTypesScopedList resources. + */ + items?: {[key: string]: Schema$NodeTypesScopedList} | null; + /** + * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. + */ + 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; + } + /** + * Contains a list of node types. + */ + export interface Schema$NodeTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NodeType resources. + */ + items?: Schema$NodeType[]; + /** + * [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$NodeTypesScopedList { + /** + * [Output Only] A list of node types contained in this scope. + */ + nodeTypes?: Schema$NodeType[]; + /** + * [Output Only] An informational warning that appears when the node types list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. + */ + export interface Schema$NotificationEndpoint { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Settings of the gRPC notification endpoint including the endpoint URL and the retry duration. + */ + grpcSettings?: Schema$NotificationEndpointGrpcSettings; + /** + * [Output Only] A unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + } + /** + * Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. + */ + export interface Schema$NotificationEndpointGrpcSettings { + /** + * Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 + */ + authority?: string | null; + /** + * Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name. + */ + endpoint?: string | null; + /** + * Optional. If specified, this field is used to populate the ?name? field in gRPC requests. + */ + payloadName?: string | null; + /** + * How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number. + */ + retryDurationSec?: number | null; + } + export interface Schema$NotificationEndpointList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NotificationEndpoint resources. + */ + items?: Schema$NotificationEndpoint[]; + /** + * [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) + */ + export interface Schema$Operation { + /** + * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. + */ + clientOperationId?: string | null; + /** + * [Deprecated] This field is deprecated. + */ + creationTimestamp?: string | null; + /** + * [Output Only] A textual description of the operation, which is set when the operation is created. + */ + description?: string | null; + /** + * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. + */ + endTime?: string | null; + /** + * [Output Only] If errors are generated during processing of the operation, this field will be populated. + */ + error?: { + errors?: Array<{code?: string; location?: string; message?: string}>; + } | null; + /** + * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. + */ + httpErrorMessage?: string | null; + /** + * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. + */ + httpErrorStatusCode?: number | null; + /** + * [Output Only] The unique identifier for the operation. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + */ + insertTime?: string | null; + /** + * [Output Only] Type of the resource. Always compute#operation for Operation resources. + */ + kind?: string | null; + /** + * [Output Only] Name of the operation. + */ + name?: string | null; + /** + * [Output Only] The type of operation, such as insert, update, or delete, and so on. + */ + operationType?: string | null; + /** + * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. + */ + progress?: number | null; + /** + * [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + */ + startTime?: string | null; + /** + * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + */ + status?: string | null; + /** + * [Output Only] An optional textual description of the current status of the operation. + */ + statusMessage?: string | null; + /** + * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + */ + targetId?: string | null; + /** + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. + */ + targetLink?: string | null; + /** + * [Output Only] User who requested the operation, for example: user@example.com. + */ + user?: string | null; + /** + * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. + */ + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }> | null; + /** + * [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. + */ + zone?: string | null; + } + export interface Schema$OperationAggregatedList { + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] A map of scoped operation lists. + */ + items?: {[key: string]: Schema$OperationsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. + */ + 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; + } + /** + * Contains a list of Operation resources. + */ + export interface Schema$OperationList { + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] A list of Operation resources. + */ + items?: Schema$Operation[]; + /** + * [Output Only] Type of resource. Always compute#operations for Operations resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$OperationsScopedList { + /** + * [Output Only] A list of operations contained in this scope. + */ + operations?: Schema$Operation[]; + /** + * [Output Only] Informational warning which replaces the list of operations when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$OrganizationSecurityPoliciesListAssociationsResponse { + /** + * A list of associations. + */ + associations?: Schema$SecurityPolicyAssociation[]; + /** + * [Output Only] Type of securityPolicy associations. Always compute#organizationSecurityPoliciesListAssociations for lists of securityPolicy associations. + */ + kind?: string | null; + } + /** + * Configuration for the origin authentication method. + */ + export interface Schema$OriginAuthenticationMethod { + jwt?: Schema$Jwt; + } + /** + * Settings controlling eviction of unhealthy hosts from the load balancing pool. + */ + export interface Schema$OutlierDetection { + /** + * The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + */ + baseEjectionTime?: Schema$Duration; + /** + * Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + */ + consecutiveErrors?: number | null; + /** + * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5. + */ + consecutiveGatewayFailure?: number | null; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + */ + enforcingConsecutiveErrors?: number | null; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + */ + enforcingConsecutiveGatewayFailure?: number | null; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + */ + enforcingSuccessRate?: number | null; + /** + * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. + */ + interval?: Schema$Duration; + /** + * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%. + */ + maxEjectionPercent?: number | null; + /** + * The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. + */ + successRateMinimumHosts?: number | null; + /** + * The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. + */ + successRateRequestVolume?: number | null; + /** + * This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + */ + successRateStdevFactor?: number | null; + } + /** + * Next free: 7 + */ + export interface Schema$PacketIntervals { + /** + * Average observed inter-packet interval in milliseconds. + */ + avgMs?: string | null; + /** + * From how long ago in the past these intervals were observed. + */ + duration?: string | null; + /** + * Maximum observed inter-packet interval in milliseconds. + */ + maxMs?: string | null; + /** + * Minimum observed inter-packet interval in milliseconds. + */ + minMs?: string | null; + /** + * Number of inter-packet intervals from which these statistics were derived. + */ + numIntervals?: string | null; + /** + * The type of packets for which inter-packet intervals were computed. + */ + type?: string | null; + } + /** + * Represents a PacketMirroring resource. + */ + export interface Schema$PacketMirroring { + /** + * The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true. + */ + collectorIlb?: Schema$PacketMirroringForwardingRuleInfo; + /** + * 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. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. + */ + enable?: string | null; + /** + * Filter for mirrored traffic. If unspecified, all traffic is mirrored. + */ + filter?: Schema$PacketMirroringFilter; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. + */ + kind?: string | null; + /** + * PacketMirroring mirroredResourceInfos. Each mirroredResourceInfo specifies a set of mirrored VM instances and/or a set of subnetworks for which traffic from/to all VM instances will be mirrored. + */ + mirroredResources?: Schema$PacketMirroringMirroredResourceInfo; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network. + */ + network?: Schema$PacketMirroringNetworkInfo; + /** + * 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. + */ + priority?: number | null; + /** + * [Output Only] URI of the region where the packetMirroring resides. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + } + /** + * Contains a list of packetMirrorings. + */ + export interface Schema$PacketMirroringAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PacketMirroring resources. + */ + items?: {[key: string]: Schema$PacketMirroringsScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$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. + */ + cidrRanges?: string[] | null; + /** + * Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. + */ + IPProtocols?: string[] | null; + } + export interface Schema$PacketMirroringForwardingRuleInfo { + /** + * [Output Only] Unique identifier for the forwarding rule; defined by the server. + */ + canonicalUrl?: string | null; + /** + * Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic. + */ + url?: string | null; + } + /** + * Contains a list of PacketMirroring resources. + */ + export interface Schema$PacketMirroringList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PacketMirroring resources. + */ + items?: Schema$PacketMirroring[]; + /** + * [Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$PacketMirroringMirroredResourceInfo { + /** + * A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances. + */ + instances?: Schema$PacketMirroringMirroredResourceInfoInstanceInfo[]; + /** + * A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in zones contained in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks. + */ + subnetworks?: Schema$PacketMirroringMirroredResourceInfoSubnetInfo[]; + /** + * A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored. + */ + tags?: string[] | null; + } + export interface Schema$PacketMirroringMirroredResourceInfoInstanceInfo { + /** + * [Output Only] Unique identifier for the instance; defined by the server. + */ + canonicalUrl?: string | null; + /** + * Resource URL to the virtual machine instance which is being mirrored. + */ + url?: string | null; + } + export interface Schema$PacketMirroringMirroredResourceInfoSubnetInfo { + /** + * [Output Only] Unique identifier for the subnetwork; defined by the server. + */ + canonicalUrl?: string | null; + /** + * Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored. + */ + url?: string | null; + } + export interface Schema$PacketMirroringNetworkInfo { + /** + * [Output Only] Unique identifier for the network; defined by the server. + */ + canonicalUrl?: string | null; + /** + * URL of the network resource. + */ + url?: string | null; + } + export interface Schema$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. + */ + packetMirrorings?: Schema$PacketMirroring[]; + /** + * Informational warning which replaces the list of packetMirrorings when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. + */ + export interface Schema$PathMatcher { + /** + * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. + */ + defaultRouteAction?: Schema$HttpRouteAction; + /** + * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + */ + defaultService?: string | null; + /** + * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + */ + defaultUrlRedirect?: Schema$HttpRedirectAction; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap + */ + headerAction?: Schema$HttpHeaderAction; + /** + * The name to which this PathMatcher is referred by the HostRule. + */ + name?: string | null; + /** + * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. + */ + pathRules?: Schema$PathRule[]; + /** + * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Only one of pathRules or routeRules must be set. + */ + routeRules?: Schema$HttpRouteRule[]; + } + /** + * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. + */ + export interface Schema$PathRule { + /** + * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. + */ + paths?: string[] | null; + /** + * In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + */ + routeAction?: Schema$HttpRouteAction; + /** + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. + */ + service?: string | null; + /** + * When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. + */ + urlRedirect?: Schema$HttpRedirectAction; + } + /** + * Configuration for the peer authentication method. + */ + export interface Schema$PeerAuthenticationMethod { + /** + * Set if mTLS is used for peer authentication. + */ + mtls?: Schema$MutualTls; + } + 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; + /** + * Intended preserved state for the given instance. Does not contain state generated based on Stateful Policy. + */ + preservedState?: Schema$PreservedState; + } + /** + * All fields defined in a permission are ANDed. + */ + export interface Schema$Permission { + /** + * Extra custom constraints. The constraints are ANDed together. + */ + constraints?: Schema$PermissionConstraint[]; + /** + * Used in Ingress or Egress Gateway cases to specify hosts that the policy applies to. Exact match, prefix match, and suffix match are supported. + */ + hosts?: string[] | null; + /** + * HTTP method. + */ + methods?: string[] | null; + /** + * Negate of hosts. Specifies exclusions. + */ + notHosts?: string[] | null; + /** + * Negate of methods. Specifies exclusions. + */ + notMethods?: string[] | null; + /** + * Negate of paths. Specifies exclusions. + */ + notPaths?: string[] | null; + /** + * Negate of ports. Specifies exclusions. + */ + notPorts?: string[] | null; + /** + * HTTP request paths or gRPC methods. Exact match, prefix match, and suffix match are supported. + */ + paths?: string[] | null; + /** + * Port names or numbers. + */ + ports?: string[] | null; + } + /** + * Custom constraint that specifies a key and a list of allowed values for Istio attributes. + */ + export interface Schema$PermissionConstraint { + /** + * Key of the constraint. + */ + key?: string | null; + /** + * A list of allowed values. + */ + values?: string[] | null; + } + /** + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. + */ + etag?: string | null; + iamOwned?: boolean | null; + /** + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. + */ + rules?: Schema$Rule[]; + /** + * Deprecated. + */ + version?: number | null; + } + export interface Schema$PreconfiguredWafSet { + /** + * List of entities that are currently supported for WAF rules. + */ + expressionSets?: Schema$WafExpressionSet[]; + } + /** + * 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; + } + /** + * All fields defined in a principal are ANDed. + */ + export interface Schema$Principal { + /** + * An expression to specify custom condition. + */ + condition?: string | null; + /** + * The groups the principal belongs to. Exact match, prefix match, and suffix match are supported. + */ + groups?: string[] | null; + /** + * IPv4 or IPv6 address or range (In CIDR format) + */ + ips?: string[] | null; + /** + * The namespaces. Exact match, prefix match, and suffix match are supported. + */ + namespaces?: string[] | null; + /** + * Negate of groups. Specifies exclusions. + */ + notGroups?: string[] | null; + /** + * Negate of IPs. Specifies exclusions. + */ + notIps?: string[] | null; + /** + * Negate of namespaces. Specifies exclusions. + */ + notNamespaces?: string[] | null; + /** + * Negate of users. Specifies exclusions. + */ + notUsers?: string[] | null; + /** + * A map of Istio attribute to expected values. Exact match, prefix match, and suffix match are supported for values. For example, `request.headers[version]: ?v1?`. The properties are ANDed together. + */ + properties?: {[key: string]: string} | null; + /** + * The user names/IDs or service accounts. Exact match, prefix match, and suffix match are supported. + */ + users?: string[] | null; + } + /** + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + */ + export interface Schema$Project { + /** + * Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. + */ + commonInstanceMetadata?: Schema$Metadata; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. + */ + defaultNetworkTier?: string | null; + /** + * [Output Only] Default service account used by VMs running in this project. + */ + defaultServiceAccount?: string | null; + /** + * An optional textual description of the resource. + */ + description?: string | null; + /** + * Restricted features enabled for use on this project. + */ + enabledFeatures?: string[] | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#project for projects. + */ + kind?: string | null; + /** + * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. + */ + name?: string | null; + /** + * [Output Only] Quotas assigned to this project. + */ + quotas?: Schema$Quota[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. + */ + usageExportLocation?: Schema$UsageExportLocation; + /** + * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. + */ + xpnProjectStatus?: string | null; + } + export interface Schema$ProjectsDisableXpnResourceRequest { + /** + * Service resource (a.k.a service project) ID. + */ + xpnResource?: Schema$XpnResourceId; + } + export interface Schema$ProjectsEnableXpnResourceRequest { + /** + * Service resource (a.k.a service project) ID. + */ + xpnResource?: Schema$XpnResourceId; + } + export interface Schema$ProjectsGetXpnResources { + /** + * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * Service resources (a.k.a service projects) attached to this project as their shared VPC host. + */ + resources?: Schema$XpnResourceId[]; + } + export interface Schema$ProjectsListXpnHostsRequest { + /** + * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. + */ + organization?: string | null; + } + export interface Schema$ProjectsSetDefaultNetworkTierRequest { + /** + * Default network tier to be set. + */ + networkTier?: string | null; + } + export interface Schema$ProjectsSetDefaultServiceAccountRequest { + /** + * Email address of the service account. + */ + email?: string | null; + } + /** + * A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet. + */ + export interface Schema$PublicAdvertisedPrefix { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * The IPv4 address to be used for reverse DNS verification. + */ + dnsVerificationIp?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix. + */ + fingerprint?: string | null; + /** + * [Output Only] The unique identifier for the resource type. The server generates this identifier. + */ + id?: string | null; + /** + * The IPv4 address range, in CIDR format, represented by this public advertised prefix. + */ + ipCidrRange?: string | null; + /** + * [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] The list of public delegated prefixes that exist for this public advertised prefix. + */ + publicDelegatedPrefixs?: Schema$PublicAdvertisedPrefixPublicDelegatedPrefix[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The shared secret to be used for reverse DNS verification. + */ + sharedSecret?: string | null; + /** + * The status of the public advertised prefix. + */ + status?: string | null; + } + export interface Schema$PublicAdvertisedPrefixList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PublicAdvertisedPrefix resources. + */ + items?: Schema$PublicAdvertisedPrefix[]; + /** + * [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. + */ + 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 CIDR range which can be used to assign addresses. + */ + export interface Schema$PublicAdvertisedPrefixPublicDelegatedPrefix { + /** + * The name of the public delegated prefix + */ + name?: string | null; + /** + * The region of the public delegated prefix if it is regional. If absent, the prefix is global. + */ + region?: string | null; + /** + * The status of the public delegated prefix. Possible values are: ACTIVE: The public delegated prefix is active DRAINED: The public delegated prefix is drained. + */ + status?: string | null; + } + /** + * A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block. + */ + export interface Schema$PublicDelegatedPrefix { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. + */ + fingerprint?: string | null; + /** + * The list of Google announcements that exist for this delegated prefix. + */ + googleAnnouncements?: Schema$PublicDelegatedPrefixGoogleAnnouncement[]; + /** + * [Output Only] The unique identifier for the resource type. The server generates this identifier. + */ + id?: string | null; + /** + * The IPv4 address range, in CIDR format, represented by this public delegated prefix. + */ + ipCidrRange?: string | null; + /** + * [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. + */ + parentPrefix?: string | null; + /** + * The list of sub public delegated prefixes that exist for this public delegated prefix. + */ + publicDelegatedSubPrefixs?: Schema$PublicDelegatedPrefixPublicDelegatedSubPrefix[]; + /** + * [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The status of the public delegated prefix. + */ + status?: any | null; + } + export interface Schema$PublicDelegatedPrefixAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PublicDelegatedPrefixesScopedList resources. + */ + items?: {[key: string]: Schema$PublicDelegatedPrefixesScopedList} | null; + /** + * [Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$PublicDelegatedPrefixesScopedList { + /** + * [Output Only] A list of PublicDelegatedPrefixes contained in this scope. + */ + publicDelegatedPrefixes?: Schema$PublicDelegatedPrefix[]; + /** + * [Output Only] Informational warning which replaces the list of public delegated prefixes when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A Google announcement advertises the prefix internally within Google's network backbone from the specified scope. + */ + export interface Schema$PublicDelegatedPrefixGoogleAnnouncement { + /** + * The name of a Google announcement. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first // character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The status of this Google announcement. + */ + status?: string | null; + } + export interface Schema$PublicDelegatedPrefixList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PublicDelegatedPrefix resources. + */ + items?: Schema$PublicDelegatedPrefix[]; + /** + * [Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes. + */ + 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 sub PublicDelegatedPrefix. + */ + export interface Schema$PublicDelegatedPrefixPublicDelegatedSubPrefix { + /** + * Name of the project scoping this PublicDelegatedSubPrefix. + */ + delegateeProject?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * The IPv4 address range, in CIDR format, represented by this sub public delegated prefix. + */ + ipCidrRange?: string | null; + /** + * Whether the sub prefix is delegated to create Address resources in the delegatee project. + */ + isAddress?: boolean | null; + /** + * The name of the sub public delegated prefix. + */ + name?: string | null; + /** + * [Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global. + */ + region?: string | null; + /** + * [Output Only] The status of the sub public delegated prefix. + */ + status?: any | null; + } + /** + * A quotas entry. + */ + export interface Schema$Quota { + /** + * [Output Only] Quota limit for this metric. + */ + limit?: number | null; + /** + * [Output Only] Name of the quota metric. + */ + metric?: string | null; + /** + * [Output Only] Owning resource. This is the resource on which this quota is applied. + */ + owner?: string | null; + /** + * [Output Only] Current usage of this metric. + */ + usage?: number | null; + } + export interface Schema$RbacPolicy { + /** + * Name of the RbacPolicy. + */ + name?: string | null; + /** + * The list of permissions. + */ + permissions?: Schema$Permission[]; + /** + * The list of principals. + */ + principals?: Schema$Principal[]; + } + /** + * Represents a reference to a resource. + */ + export interface Schema$Reference { + /** + * [Output Only] Type of the resource. Always compute#reference for references. + */ + kind?: string | null; + /** + * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF + */ + referenceType?: string | null; + /** + * URL of the resource which refers to the target. + */ + referrer?: string | null; + /** + * URL of the resource to which this reference points. + */ + target?: string | null; + } + /** + * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) + */ + export interface Schema$Region { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this region. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] Textual description of the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#region for regions. + */ + kind?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Quotas assigned to this region. + */ + quotas?: Schema$Quota[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] Status of the region, either UP or DOWN. + */ + status?: string | null; + /** + * [Output Only] A list of zones available in this region, in the form of resource URLs. + */ + zones?: string[] | null; + } + /** + * Contains a list of autoscalers. + */ + export interface Schema$RegionAutoscalerList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Autoscaler resources. + */ + items?: Schema$Autoscaler[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$RegionCommitmentsUpdateReservationsRequest { + /** + * List of two reservations to transfer GPUs and local SSD between. + */ + reservations?: Schema$Reservation[]; + } + export interface Schema$RegionDisksAddResourcePoliciesRequest { + /** + * Resource policies to be added to this disk. + */ + resourcePolicies?: string[] | null; + } + export interface Schema$RegionDisksRemoveResourcePoliciesRequest { + /** + * Resource policies to be removed from this disk. + */ + resourcePolicies?: string[] | null; + } + export interface Schema$RegionDisksResizeRequest { + /** + * The new size of the regional persistent disk, which is specified in GB. + */ + sizeGb?: string | null; + } + export interface Schema$RegionDiskTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of DiskType resources. + */ + items?: Schema$DiskType[]; + /** + * [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. + */ + 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; + } + /** + * Contains a list of InstanceGroup resources. + */ + export interface Schema$RegionInstanceGroupList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceGroup resources. + */ + items?: Schema$InstanceGroup[]; + /** + * The resource type. + */ + 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; + } + /** + * RegionInstanceGroupManagers.deletePerInstanceConfigs + */ + export interface Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq { + /** + * The list of instances for which we want to delete per-instance configs on this managed instance group. + */ + instances?: string[] | null; + /** + * The list of instance names for which we want to delete per-instance configs on this managed instance group. + */ + names?: string[] | null; + } + /** + * Contains a list of managed instance groups. + */ + export interface Schema$RegionInstanceGroupManagerList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstanceGroupManager resources. + */ + items?: Schema$InstanceGroupManager[]; + /** + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope. + */ + 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; + } + /** + * 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]. + */ + instances?: string[] | null; + } + /** + * InstanceGroupManagers.applyUpdatesToInstances + */ + export interface Schema$RegionInstanceGroupManagersApplyUpdatesRequest { + /** + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + /** + * The maximal action that should be performed on the instances. By default REPLACE. This field is deprecated, please use most_disruptive_allowed_action. + */ + maximalAction?: string | null; + /** + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. + */ + minimalAction?: string | null; + /** + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. + */ + mostDisruptiveAllowedAction?: string | null; + } + /** + * RegionInstanceGroupManagers.createInstances + */ + 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]. + */ + 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. + */ + managedInstances?: Schema$ManagedInstance[]; + /** + * [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$RegionInstanceGroupManagersRecreateRequest { + /** + * 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]. + */ + instances?: string[] | null; + } + export interface Schema$RegionInstanceGroupManagersSetAutoHealingRequest { + autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; + } + export interface Schema$RegionInstanceGroupManagersSetTargetPoolsRequest { + /** + * Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional. + */ + fingerprint?: string | null; + /** + * The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. + */ + targetPools?: string[] | null; + } + export interface Schema$RegionInstanceGroupManagersSetTemplateRequest { + /** + * URL of the InstanceTemplate resource from which all new instances will be created. + */ + 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. + */ + id?: string | null; + /** + * A list of InstanceWithNamedPorts resources. + */ + items?: Schema$InstanceWithNamedPorts[]; + /** + * The resource type. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$RegionInstanceGroupsListInstancesRequest { + /** + * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. + */ + instanceState?: string | null; + /** + * Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. + */ + portName?: string | null; + } + export interface Schema$RegionInstanceGroupsSetNamedPortsRequest { + /** + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. + */ + fingerprint?: string | null; + /** + * The list of named ports to set for this instance group. + */ + namedPorts?: Schema$NamedPort[]; + } + /** + * Contains a list of region resources. + */ + export interface Schema$RegionList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Region resources. + */ + items?: Schema$Region[]; + /** + * [Output Only] Type of resource. Always compute#regionList for lists of regions. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$RegionSetLabelsRequest { + /** + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. + */ + labelFingerprint?: string | null; + /** + * The labels to set for this resource. + */ + labels?: {[key: string]: string} | null; + } + export interface Schema$RegionSetPolicyRequest { + /** + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. + */ + bindings?: Schema$Binding[]; + /** + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. + */ + etag?: string | null; + /** + * 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 in general a valid policy but certain services (like Projects) might reject them. + */ + policy?: Schema$Policy; + } + export interface Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest { + /** + * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. + */ + sslCertificates?: string[] | null; + } + export interface Schema$RegionUrlMapsValidateRequest { + /** + * Content of the UrlMap to be validated. + */ + resource?: Schema$UrlMap; + } + /** + * A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. + */ + export interface Schema$RequestMirrorPolicy { + /** + * The full or partial URL to the BackendService resource being mirrored to. + */ + backendService?: string | null; + } + /** + * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) + */ + export interface Schema$Reservation { + /** + * [OutputOnly] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. + */ + commitment?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#reservations for reservations. + */ + kind?: 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. + */ + name?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * Reservation for instances with specific machine shapes. + */ + specificReservation?: Schema$AllocationSpecificSKUReservation; + /** + * Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. + */ + specificReservationRequired?: boolean | null; + /** + * [Output Only] The status of the reservation. + */ + status?: string | null; + /** + * Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. + */ + zone?: string | null; + } + /** + * Specifies the reservations that this instance can consume from. + */ + export interface Schema$ReservationAffinity { + /** + * Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. + */ + consumeReservationType?: string | null; + /** + * Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. + */ + key?: string | null; + /** + * Corresponds to the label values of a reservation resource. + */ + values?: string[] | null; + } + /** + * Contains a list of reservations. + */ + export interface Schema$ReservationAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Allocation resources. + */ + items?: {[key: string]: Schema$ReservationsScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$ReservationList { + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] A list of Allocation resources. + */ + items?: Schema$Reservation[]; + /** + * [Output Only] Type of resource.Always compute#reservationsList for listsof reservations + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$ReservationsResizeRequest { + /** + * Number of allocated resources can be resized with minimum = 1 and maximum = 1000. + */ + specificSkuCount?: string | null; + } + export interface Schema$ReservationsScopedList { + /** + * A list of reservations contained in this scope. + */ + reservations?: Schema$Reservation[]; + /** + * Informational warning which replaces the list of reservations when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Commitment for a particular resource (a Commitment is composed of one or more of these). + */ + export interface Schema$ResourceCommitment { + /** + * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. + */ + acceleratorType?: string | null; + /** + * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. + */ + amount?: string | null; + /** + * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY + */ + type?: string | null; + } + export interface Schema$ResourceGroupReference { + /** + * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. + */ + group?: string | null; + } + export interface Schema$ResourcePoliciesScopedList { + /** + * A list of resourcePolicies contained in this scope. + */ + resourcePolicies?: Schema$ResourcePolicy[]; + /** + * Informational warning which replaces the list of resourcePolicies when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$ResourcePolicy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + description?: string | null; + /** + * Resource policy for instacnes for placement configuration. + */ + groupPlacementPolicy?: Schema$ResourcePolicyGroupPlacementPolicy; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#resource_policies for resource policies. + */ + kind?: 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. + */ + name?: string | null; + region?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * Resource policy for persistent disks for creating snapshots. + */ + snapshotSchedulePolicy?: Schema$ResourcePolicySnapshotSchedulePolicy; + /** + * [Output Only] The status of resource policy creation. + */ + status?: string | null; + /** + * Resource policy applicable to VMs for infrastructure maintenance. + */ + vmMaintenancePolicy?: Schema$ResourcePolicyVmMaintenancePolicy; + } + /** + * Contains a list of resourcePolicies. + */ + export interface Schema$ResourcePolicyAggregatedList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of ResourcePolicy resources. + */ + items?: {[key: string]: Schema$ResourcePoliciesScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Time window specified for daily operations. + */ + export interface Schema$ResourcePolicyDailyCycle { + /** + * Defines a schedule that runs every nth day of the month. + */ + daysInCycle?: number | null; + /** + * [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. + */ + duration?: string | null; + /** + * Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid. + */ + startTime?: string | null; + } + /** + * A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality + */ + export interface Schema$ResourcePolicyGroupPlacementPolicy { + /** + * Specifies network locality + */ + locality?: string | null; + /** + * Specifies instances to hosts placement relationship + */ + style?: string | null; + /** + * Number of vms in this placement group + */ + vmCount?: number | null; + } + /** + * Time window specified for hourly operations. + */ + export interface Schema$ResourcePolicyHourlyCycle { + /** + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + */ + duration?: string | null; + /** + * Allows to define schedule that runs every nth hour. + */ + hoursInCycle?: number | null; + /** + * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. + */ + startTime?: string | null; + } + export interface Schema$ResourcePolicyList { + etag?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] A list of ResourcePolicy resources. + */ + items?: Schema$ResourcePolicy[]; + /** + * [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies + */ + 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; + } + /** + * A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicy { + /** + * Retention policy applied to snapshots created by this resource policy. + */ + retentionPolicy?: Schema$ResourcePolicySnapshotSchedulePolicyRetentionPolicy; + /** + * A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy. + */ + schedule?: Schema$ResourcePolicySnapshotSchedulePolicySchedule; + /** + * Properties with which snapshots are created such as labels, encryption keys. + */ + snapshotProperties?: Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties; + } + /** + * Policy for retention of scheduled snapshots. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicyRetentionPolicy { + /** + * Maximum age of the snapshot that is allowed to be kept. + */ + maxRetentionDays?: number | null; + /** + * Specifies the behavior to apply to existing, scheduled snapshots snapshots if the policy is changed. + */ + onPolicySwitch?: string | null; + /** + * Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. + */ + onSourceDiskDelete?: string | null; + } + /** + * A schedule for disks where the schedueled operations are performed. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicySchedule { + dailySchedule?: Schema$ResourcePolicyDailyCycle; + hourlySchedule?: Schema$ResourcePolicyHourlyCycle; + weeklySchedule?: Schema$ResourcePolicyWeeklyCycle; + } + /** + * Specified snapshot properties for scheduled snapshots created by this policy. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties { + /** + * Indication to perform a ?guest aware? snapshot. + */ + guestFlush?: boolean | null; + /** + * Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). + */ + storageLocations?: string[] | null; + } + export interface Schema$ResourcePolicyVmMaintenancePolicy { + concurrencyControlGroup?: Schema$ResourcePolicyVmMaintenancePolicyConcurrencyControl; + /** + * Maintenance windows that are applied to VMs covered by this policy. + */ + maintenanceWindow?: Schema$ResourcePolicyVmMaintenancePolicyMaintenanceWindow; + } + /** + * A concurrency control configuration. Defines a group config that, when attached to an instance, recognizes that instance as part of a group of instances where only up the concurrency_limit of instances in that group can undergo simultaneous maintenance. For more information: go/concurrency-control-design-doc + */ + export interface Schema$ResourcePolicyVmMaintenancePolicyConcurrencyControl { + concurrencyLimit?: number | null; + } + /** + * A maintenance window for VMs. When set, we restrict our maintenance operations to this window. + */ + export interface Schema$ResourcePolicyVmMaintenancePolicyMaintenanceWindow { + dailyMaintenanceWindow?: Schema$ResourcePolicyDailyCycle; + } + /** + * Time window specified for weekly operations. + */ + export interface Schema$ResourcePolicyWeeklyCycle { + /** + * Up to 7 intervals/windows, one for each day of the week. + */ + dayOfWeeks?: Schema$ResourcePolicyWeeklyCycleDayOfWeek[]; + } + export interface Schema$ResourcePolicyWeeklyCycleDayOfWeek { + /** + * Allows to define schedule that runs specified day of the week. + */ + day?: string | null; + /** + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + */ + duration?: string | null; + /** + * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. + */ + startTime?: string | null; + } + /** + * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + */ + export interface Schema$Route { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this field when you create the resource. + */ + description?: string | null; + /** + * The destination range of outgoing packets that this route applies to. Only IPv4 is supported. + */ + destRange?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of this resource. Always compute#routes for Route resources. + */ + 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?: string | null; + /** + * Fully-qualified URL of the network that this route applies to. + */ + network?: string | null; + /** + * The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway + */ + nextHopGateway?: string | null; + /** + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Note that this can only be used when the destination_range is a public (non-RFC 1918) IP CIDR range. + */ + nextHopIlb?: string | null; + /** + * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ + */ + nextHopInstance?: string | null; + /** + * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. + */ + nextHopInterconnectAttachment?: string | null; + /** + * The network IP address of an instance that should handle matching packets. Only IPv4 is supported. + */ + nextHopIp?: string | null; + /** + * The URL of the local network if it should handle matching packets. + */ + nextHopNetwork?: string | null; + /** + * [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. + */ + nextHopPeering?: string | null; + /** + * The URL to a VpnTunnel that should handle matching packets. + */ + nextHopVpnTunnel?: string | null; + /** + * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. + */ + priority?: number | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * A list of instance tags to which this route applies. + */ + tags?: string[] | null; + /** + * [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. + */ + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }> | null; + } + /** + * Contains a list of Route resources. + */ + export interface Schema$RouteList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Route resources. + */ + items?: Schema$Route[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a Cloud Router resource. For more information about Cloud Router, read the the Cloud Router overview. + */ + export interface Schema$Router { + /** + * BGP information specific to this router. + */ + bgp?: Schema$RouterBgp; + /** + * BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. + */ + bgpPeers?: Schema$RouterBgpPeer[]; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. + */ + interfaces?: Schema$RouterInterface[]; + /** + * [Output Only] Type of resource. Always compute#router for routers. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * A list of NAT services created in this router. + */ + nats?: Schema$RouterNat[]; + /** + * URI of the network to which this router belongs. + */ + network?: string | null; + /** + * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + } + /** + * Description-tagged IP ranges for the router to advertise. + */ + export interface Schema$RouterAdvertisedIpRange { + /** + * User-specified description for the IP range. + */ + description?: string | null; + /** + * The IP range to advertise. The value must be a CIDR-formatted string. + */ + range?: string | null; + } + /** + * Contains a list of routers. + */ + export interface Schema$RouterAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Router resources. + */ + items?: {[key: string]: Schema$RoutersScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$RouterBgp { + /** + * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. + */ + advertisedGroups?: string[] | null; + /** + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. + */ + advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; + /** + * User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. + */ + advertiseMode?: string | null; + /** + * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN. + */ + asn?: number | null; + /** + * The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer?s hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 1 and 120. The default is 20. + */ + keepaliveInterval?: number | null; + } + export interface Schema$RouterBgpPeer { + /** + * User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. + */ + advertisedGroups?: string[] | null; + /** + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. + */ + advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; + /** + * The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. + */ + advertisedRoutePriority?: number | null; + /** + * User-specified flag to indicate which mode to use for advertisement. + */ + advertiseMode?: string | null; + /** + * BFD configuration for the BGP peering. + */ + bfd?: Schema$RouterBgpPeerBfd; + /** + * The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. + */ + enable?: string | null; + /** + * Name of the interface the BGP peer is associated with. + */ + interfaceName?: string | null; + /** + * IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. + */ + ipAddress?: string | null; + /** + * [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. + */ + managementType?: string | null; + /** + * Name of this BGP peer. 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; + /** + * Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. + */ + peerAsn?: number | null; + /** + * IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. + */ + peerIpAddress?: string | null; + } + export interface Schema$RouterBgpPeerBfd { + /** + * The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 100 and 30000. The default is 300. + */ + minReceiveInterval?: number | null; + /** + * The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 100 and 30000. The default is 300. + */ + minTransmitInterval?: number | null; + /** + * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. + */ + mode?: string | null; + /** + * The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 2 and 16. The default is 3. + */ + multiplier?: number | null; + /** + * The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO. + */ + packetMode?: string | null; + /** + * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. + */ + sessionInitializationMode?: string | null; + /** + * The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000. + */ + slowTimerInterval?: number | null; + } + export interface Schema$RouterInterface { + /** + * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. + */ + ipRange?: string | null; + /** + * URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be either be a VPN tunnel or an Interconnect attachment. + */ + linkedInterconnectAttachment?: string | null; + /** + * URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be either a VPN tunnel or an Interconnect attachment. + */ + linkedVpnTunnel?: string | null; + /** + * [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. + */ + managementType?: string | null; + /** + * Name of this interface entry. 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; + } + /** + * Contains a list of Router resources. + */ + export interface Schema$RouterList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Router resources. + */ + items?: Schema$Router[]; + /** + * [Output Only] Type of resource. Always compute#router for routers. + */ + 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 Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided. + */ + export interface Schema$RouterNat { + /** + * A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only. + */ + drainNatIps?: string[] | null; + /** + * Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. + */ + icmpIdleTimeoutSec?: number | null; + /** + * Configure logging on this NAT. + */ + logConfig?: Schema$RouterNatLogConfig; + /** + * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM. + */ + minPortsPerVm?: number | null; + /** + * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. + */ + name?: string | null; + /** + * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. + */ + natIpAllocateOption?: string | null; + /** + * A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project. + */ + natIps?: string[] | null; + /** + * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. + */ + sourceSubnetworkIpRangesToNat?: string | null; + /** + * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. + */ + subnetworks?: Schema$RouterNatSubnetworkToNat[]; + /** + * Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. + */ + tcpEstablishedIdleTimeoutSec?: number | null; + /** + * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. + */ + tcpTransitoryIdleTimeoutSec?: number | null; + /** + * Timeout (in seconds) for UDP connections. Defaults to 30s if not set. + */ + udpIdleTimeoutSec?: number | null; + } + /** + * Configuration of logging on a NAT. + */ + export interface Schema$RouterNatLogConfig { + /** + * Indicates whether or not to export logs. This is false by default. + */ + enable?: boolean | null; + /** + * Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. + */ + filter?: string | null; + } + /** + * Defines the IP ranges that want to use NAT for a subnetwork. + */ + export interface Schema$RouterNatSubnetworkToNat { + /** + * URL for the subnetwork resource that will use NAT. + */ + name?: string | null; + /** + * A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat. + */ + secondaryIpRangeNames?: string[] | null; + /** + * Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + */ + sourceIpRangesToNat?: string[] | null; + } + export interface Schema$RoutersPreviewResponse { + /** + * Preview of given router. + */ + resource?: Schema$Router; + } + export interface Schema$RoutersScopedList { + /** + * A list of routers contained in this scope. + */ + routers?: Schema$Router[]; + /** + * Informational warning which replaces the list of routers when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$RouterStatus { + /** + * Best routes for this router's network. + */ + bestRoutes?: Schema$Route[]; + /** + * Best routes learned by this router. + */ + bestRoutesForRouter?: Schema$Route[]; + bgpPeerStatus?: Schema$RouterStatusBgpPeerStatus[]; + natStatus?: Schema$RouterStatusNatStatus[]; + /** + * URI of the network to which this router belongs. + */ + network?: string | null; + } + export interface Schema$RouterStatusBgpPeerStatus { + /** + * Routes that were advertised to the remote BGP peer + */ + advertisedRoutes?: Schema$Route[]; + bfdStatus?: Schema$BfdStatus; + /** + * IP address of the local BGP interface. + */ + ipAddress?: string | null; + /** + * URL of the VPN tunnel that this BGP peer controls. + */ + linkedVpnTunnel?: string | null; + /** + * Name of this BGP peer. Unique within the Routers resource. + */ + name?: string | null; + /** + * Number of routes learned from the remote BGP Peer. + */ + numLearnedRoutes?: number | null; + /** + * IP address of the remote BGP interface. + */ + peerIpAddress?: string | null; + /** + * BGP state as specified in RFC1771. + */ + state?: string | null; + /** + * Status of the BGP peer: {UP, DOWN} + */ + status?: string | null; + /** + * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds + */ + uptime?: string | null; + /** + * Time this session has been up, in seconds. Format: 145 + */ + uptimeSeconds?: string | null; + } + /** + * Status of a NAT contained in this router. Next tag: 9 + */ + export interface Schema$RouterStatusNatStatus { + /** + * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] + */ + autoAllocatedNatIps?: string[] | null; + /** + * A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. + */ + drainAutoAllocatedNatIps?: string[] | null; + /** + * A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. + */ + drainUserAllocatedNatIps?: string[] | null; + /** + * The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. + */ + minExtraNatIpsNeeded?: number | null; + /** + * Unique name of this NAT. + */ + name?: string | null; + /** + * Number of VM endpoints (i.e., Nics) that can use NAT. + */ + numVmEndpointsWithNatMappings?: number | null; + /** + * A list of fully qualified URLs of reserved IP address resources. + */ + userAllocatedNatIpResources?: string[] | null; + /** + * A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133". + */ + userAllocatedNatIps?: string[] | null; + } + export interface Schema$RouterStatusResponse { + /** + * Type of resource. + */ + kind?: string | null; + result?: Schema$RouterStatus; + } + /** + * A rule to be applied in a Policy. + */ + export interface Schema$Rule { + /** + * Required + */ + action?: string | null; + /** + * Additional restrictions that must be met. All conditions must pass for the rule to match. + */ + conditions?: Schema$Condition[]; + /** + * Human-readable description of the rule. + */ + description?: string | null; + /** + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + */ + ins?: string[] | null; + /** + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. + */ + logConfigs?: Schema$LogConfig[]; + /** + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + */ + notIns?: string[] | null; + /** + * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. + */ + permissions?: string[] | null; + } + /** + * 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; + /** + * 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 + */ + export interface Schema$Scheduling { + /** + * 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; + /** + * Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set. + */ + latencyTolerant?: boolean | null; + /** + * 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. + */ + nodeAffinities?: Schema$SchedulingNodeAffinity[]; + /** + * Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. + */ + onHostMaintenance?: string | null; + /** + * Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. + */ + preemptible?: boolean | null; + } + /** + * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. + */ + export interface Schema$SchedulingNodeAffinity { + /** + * Corresponds to the label key of Node resource. + */ + key?: string | null; + /** + * Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. + */ + operator?: string | null; + /** + * Corresponds to the label values of Node resource. + */ + values?: string[] | null; + } + /** + * The configuration to access the SDS server. + */ + export interface Schema$SdsConfig { + /** + * The configuration to access the SDS server over GRPC. + */ + grpcServiceConfig?: Schema$GrpcServiceConfig; + } + export interface Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse { + preconfiguredExpressionSets?: Schema$SecurityPoliciesWafConfig; + } + export interface Schema$SecurityPoliciesWafConfig { + wafRules?: Schema$PreconfiguredWafSet; + } + /** + * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + */ + export interface Schema$SecurityPolicy { + /** + * A list of assocations that belong to this policy. + */ + associations?: Schema$SecurityPolicyAssociation[]; + cloudArmorConfig?: Schema$SecurityPolicyCloudArmorConfig; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. + */ + fingerprint?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] Type of the resource. Always compute#securityPolicyfor security policies + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this security policy resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. + */ + rules?: Schema$SecurityPolicyRule[]; + /** + * [Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples. + */ + ruleTupleCount?: number | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * The type indicates the intended use of the security policy. CLOUD_ARMOR policies apply to backend services. FIREWALL policies apply to organizations. + */ + type?: string | null; + } + export interface Schema$SecurityPolicyAssociation { + /** + * The resource that the security policy is attached to. + */ + attachmentId?: string | null; + /** + * The name for an association. + */ + name?: string | null; + /** + * [Output Only] The security policy ID of the association. + */ + securityPolicyId?: string | null; + } + /** + * Configuration options for Cloud Armor. + */ + export interface Schema$SecurityPolicyCloudArmorConfig { + /** + * If set to true, enables Cloud Armor Machine Learning. + */ + enableMl?: boolean | null; + } + export interface Schema$SecurityPolicyList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SecurityPolicy resources. + */ + items?: Schema$SecurityPolicy[]; + /** + * [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies + */ + 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] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$SecurityPolicyReference { + securityPolicy?: string | null; + } + /** + * Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + */ + export interface Schema$SecurityPolicyRule { + /** + * The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. + */ + action?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL. + */ + direction?: string | null; + /** + * Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL. + */ + enableLogging?: boolean | null; + /** + * [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules + */ + kind?: string | null; + /** + * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. + */ + match?: Schema$SecurityPolicyRuleMatcher; + /** + * If set to true, the specified action is not enforced. + */ + preview?: boolean | null; + /** + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + */ + priority?: number | null; + /** + * Must be specified if the action is "rate_based_blacklist" or "throttle". Cannot be specified for any other actions. + */ + rateLimitOptions?: Schema$SecurityPolicyRuleRateLimitOptions; + /** + * [Output Only] Calculation of the complexity of a single firewall security policy rule. + */ + ruleTupleCount?: number | null; + /** + * A list of network resource URLs to which this rule applies. This field allows you to control which network?s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL. + */ + targetResources?: string[] | null; + } + /** + * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. + */ + export interface Schema$SecurityPolicyRuleMatcher { + /** + * The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. + */ + config?: Schema$SecurityPolicyRuleMatcherConfig; + /** + * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. + */ + expr?: Schema$Expr; + /** + * Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. + */ + versionedExpr?: string | null; + } + export interface Schema$SecurityPolicyRuleMatcherConfig { + /** + * CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL. + */ + destIpRanges?: string[] | null; + /** + * Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL. + */ + destPorts?: Schema$SecurityPolicyRuleMatcherConfigDestinationPort[]; + /** + * CIDR IP address range. + */ + srcIpRanges?: string[] | null; + } + export interface Schema$SecurityPolicyRuleMatcherConfigDestinationPort { + /** + * The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + */ + ipProtocol?: string | null; + /** + * An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL. + */ + ports?: string[] | null; + } + export interface Schema$SecurityPolicyRuleRateLimitOptions { + /** + * Can only be specifed if the action for the rule is "rate_based_blacklist" If specified, determines the time (in seconds) the traffic will continue to be blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds. + */ + blockDuration?: number | null; + /** + * Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload". + */ + conformAction?: string | null; + /** + * Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule. + */ + enforceOnKey?: string | null; + /** + * When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502. + */ + exceedAction?: string | null; + /** + * Rate in requests per second at which to begin ratelimiting. + */ + thresholdRps?: number | null; + } + /** + * The authentication and authorization settings for a BackendService. + */ + export interface Schema$SecuritySettings { + /** + * Authentication policy defines what authentication methods can be accepted on backends, and if authenticated, which method/certificate will set the request principal. + */ + authenticationPolicy?: Schema$AuthenticationPolicy; + /** + * Authorization config defines the Role Based Access Control (RBAC) config. + */ + authorizationConfig?: Schema$AuthorizationConfig; + /** + * TLS Settings for the backend service. + */ + clientTlsSettings?: Schema$ClientTlsSettings; + } + /** + * An instance's serial console output. + */ + export interface Schema$SerialPortOutput { + /** + * [Output Only] The contents of the console output. + */ + contents?: string | null; + /** + * [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. + */ + kind?: string | null; + /** + * [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter. + */ + next?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched. + */ + start?: string | null; + } + export interface Schema$ServerBinding { + type?: string | null; + } + /** + * The TLS settings for the server. + */ + export interface Schema$ServerTlsSettings { + /** + * Configures the mechanism to obtain security certificates and identity information. + */ + proxyTlsContext?: Schema$TlsContext; + /** + * A list of alternate names to verify the subject identity in the certificate presented by the client. + */ + subjectAltNames?: string[] | null; + /** + * Indicates whether connections should be secured using TLS. The value of this field determines how TLS is enforced. This field can be set to one of the following: - SIMPLE Secure connections with standard TLS semantics. - MUTUAL Secure connections to the backends using mutual TLS by presenting client certificates for authentication. + */ + tlsMode?: string | null; + } + /** + * A service account. + */ + export interface Schema$ServiceAccount { + /** + * Email address of the service account. + */ + email?: string | null; + /** + * The list of scopes to be made available for this service account. + */ + scopes?: string[] | null; + } + /** + * A set of Shielded Instance options. + */ + export interface Schema$ShieldedInstanceConfig { + /** + * Defines whether the instance has integrity monitoring enabled. + */ + enableIntegrityMonitoring?: boolean | null; + /** + * Defines whether the instance has Secure Boot enabled. + */ + enableSecureBoot?: boolean | null; + /** + * Defines whether the instance has the vTPM enabled. + */ + enableVtpm?: boolean | null; + } + /** + * A shielded Instance identity entry. + */ + export interface Schema$ShieldedInstanceIdentity { + /** + * An Endorsement Key (EK) issued to the Shielded Instance's vTPM. + */ + encryptionKey?: Schema$ShieldedInstanceIdentityEntry; + /** + * [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. + */ + kind?: string | null; + /** + * An Attestation Key (AK) issued to the Shielded Instance's vTPM. + */ + signingKey?: Schema$ShieldedInstanceIdentityEntry; + } + /** + * A Shielded Instance Identity Entry. + */ + export interface Schema$ShieldedInstanceIdentityEntry { + /** + * A PEM-encoded X.509 certificate. This field can be empty. + */ + ekCert?: string | null; + /** + * A PEM-encoded public key. + */ + ekPub?: string | null; + } + /** + * The policy describes the baseline against which Instance boot integrity is measured. + */ + export interface Schema$ShieldedInstanceIntegrityPolicy { + /** + * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. + */ + updateAutoLearnPolicy?: boolean | null; + } + /** + * A set of Shielded VM options. + */ + export interface Schema$ShieldedVmConfig { + /** + * Defines whether the instance has integrity monitoring enabled. + */ + enableIntegrityMonitoring?: boolean | null; + /** + * Defines whether the instance has Secure Boot enabled. + */ + enableSecureBoot?: boolean | null; + /** + * Defines whether the instance has the vTPM enabled. + */ + enableVtpm?: boolean | null; + } + /** + * A shielded VM identity entry. + */ + export interface Schema$ShieldedVmIdentity { + /** + * An Endorsement Key (EK) issued to the Shielded VM's vTPM. + */ + encryptionKey?: Schema$ShieldedVmIdentityEntry; + /** + * [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry. + */ + kind?: string | null; + /** + * An Attestation Key (AK) issued to the Shielded VM's vTPM. + */ + signingKey?: Schema$ShieldedVmIdentityEntry; + } + /** + * A Shielded Instance Identity Entry. + */ + export interface Schema$ShieldedVmIdentityEntry { + /** + * A PEM-encoded X.509 certificate. This field can be empty. + */ + ekCert?: string | null; + /** + * A PEM-encoded public key. + */ + ekPub?: string | null; + } + /** + * The policy describes the baseline against which VM instance boot integrity is measured. + */ + export interface Schema$ShieldedVmIntegrityPolicy { + /** + * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. + */ + updateAutoLearnPolicy?: boolean | null; + } + /** + * Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs + */ + export interface Schema$SignedUrlKey { + /** + * Name of the key. 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. + */ + keyName?: string | null; + /** + * 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. + */ + keyValue?: string | null; + } + /** + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) + */ + export interface Schema$Snapshot { + /** + * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. + */ + autoCreated?: boolean | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] Size of the snapshot, specified in GB. + */ + diskSizeGb?: 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. + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * [Output Only] Integer license codes indicating which licenses are attached to this snapshot. + */ + licenseCodes?: string[] | null; + /** + * [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). + */ + licenses?: string[] | null; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. + */ + snapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The source disk used to create this snapshot. + */ + sourceDisk?: string | null; + /** + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. + */ + sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. + */ + sourceDiskId?: string | null; + /** + * [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. + */ + status?: string | null; + /** + * [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. + */ + 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; + /** + * Cloud Storage bucket storage location of the snapshot (regional or multi-regional). + */ + storageLocations?: string[] | null; + } + /** + * Contains a list of Snapshot resources. + */ + export interface Schema$SnapshotList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Snapshot resources. + */ + items?: Schema$Snapshot[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$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. + */ + export interface Schema$SourceInstanceParams { + /** + * Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. + */ + 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 ==) + */ + export interface Schema$SslCertificate { + /** + * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. + */ + certificate?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] Expire time of the certificate. RFC3339 + */ + expireTime?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. + */ + kind?: string | null; + /** + * Configuration and status of a managed SSL certificate. + */ + managed?: Schema$SslCertificateManagedSslCertificate; + /** + * 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; + /** + * A write-only private key in PEM format. Only insert requests will include this field. + */ + privateKey?: string | null; + /** + * [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. + */ + region?: string | null; + /** + * [Output only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * Configuration and status of a self-managed SSL certificate. + */ + selfManaged?: Schema$SslCertificateSelfManagedSslCertificate; + /** + * [Output Only] Domains associated with the certificate via Subject Alternative Name. + */ + subjectAlternativeNames?: string[] | null; + /** + * (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. + */ + type?: string | null; + } + export interface Schema$SslCertificateAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SslCertificatesScopedList resources. + */ + items?: {[key: string]: Schema$SslCertificatesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates. + */ + 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; + } + /** + * Contains a list of SslCertificate resources. + */ + export interface Schema$SslCertificateList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SslCertificate resources. + */ + items?: Schema$SslCertificate[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Configuration and status of a managed SSL certificate. + */ + export interface Schema$SslCertificateManagedSslCertificate { + /** + * The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported. + */ + domains?: string[] | null; + /** + * [Output only] Detailed statuses of the domains specified for managed certificate resource. + */ + domainStatus?: {[key: string]: string} | null; + /** + * [Output only] Status of the managed certificate resource. + */ + status?: string | null; + } + /** + * Configuration and status of a self-managed SSL certificate. + */ + export interface Schema$SslCertificateSelfManagedSslCertificate { + /** + * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. + */ + certificate?: string | null; + /** + * A write-only private key in PEM format. Only insert requests will include this field. + */ + privateKey?: string | null; + } + export interface Schema$SslCertificatesScopedList { + /** + * List of SslCertificates contained in this scope. + */ + sslCertificates?: Schema$SslCertificate[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$SSLHealthCheck { + /** + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. + */ + request?: string | null; + /** + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. + */ + response?: string | null; + } + export interface Schema$SslPoliciesList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SslPolicy resources. + */ + items?: Schema$SslPolicy[]; + /** + * [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$SslPoliciesListAvailableFeaturesResponse { + features?: string[] | null; + } + /** + * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) + */ + export interface Schema$SslPolicy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * A list of features enabled when the selected profile is CUSTOM. The - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. + */ + customFeatures?: string[] | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The list of features enabled in the SSL policy. + */ + enabledFeatures?: string[] | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. + */ + fingerprint?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. + */ + kind?: string | null; + /** + * The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. + */ + minTlsVersion?: string | null; + /** + * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. + */ + profile?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * Security settings for the proxy. This field is only applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. + */ + tlsSettings?: Schema$ServerTlsSettings; + /** + * [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. + */ + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }> | null; + } + export interface Schema$SslPolicyReference { + /** + * URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. + */ + 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 ==) + */ + export interface Schema$Subnetwork { + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. Sets the aggregation interval for collecting flow logs. Increasing the interval time reduces the amount of generated flow logs for long-lasting connections. Default is an interval of 5 seconds per connection. Valid values: INTERVAL_5_SEC, INTERVAL_30_SEC, INTERVAL_1_MIN, INTERVAL_5_MIN, INTERVAL_10_MIN, INTERVAL_15_MIN. + */ + aggregationInterval?: string | null; + /** + * Whether this subnetwork can conflict with static routes. Setting this to true allows this subnetwork's primary and secondary ranges to conflict with routes that have already been configured on the corresponding network. Static routes will take precedence over the subnetwork route if the route prefix length is at least as large as the subnetwork prefix length. Also, packets destined to IPs within subnetwork may contain private/sensitive data and are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks. This field cannot be set to true at resource creation time. + */ + allowSubnetCidrRoutesOverlap?: boolean | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. + */ + description?: string | null; + /** + * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. + */ + enableFlowLogs?: boolean | null; + /** + * Deprecated in favor of enable in PrivateIpv6GoogleAccess. Whether the VMs in this subnet can directly access Google services via internal IPv6 addresses. This field can be both set at resource creation time and updated using patch. + */ + enablePrivateV6Access?: boolean | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. + */ + fingerprint?: string | null; + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5, which means half of all collected logs are reported. + */ + flowSampling?: number | null; + /** + * [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. + */ + gatewayAddress?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * 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. + */ + kind?: string | null; + /** + * This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver. + */ + logConfig?: Schema$SubnetworkLogConfig; + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. Configures whether metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. + */ + metadata?: string | null; + /** + * The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. + */ + network?: string | null; + /** + * 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. + */ + purpose?: string | null; + /** + * The type of IP CIDR range to associate with this subnetwork. The default is RFC_1918. When creating a subnetwork in non-RFC 1918 range, this field must be set to NON_RFC_1918. + */ + rangeType?: string | null; + /** + * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. + */ + region?: string | null; + /** + * The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. + */ + role?: string | null; + /** + * An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. + */ + secondaryIpRanges?: Schema$SubnetworkSecondaryRange[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY. + */ + state?: string | null; + } + export interface Schema$SubnetworkAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SubnetworksScopedList resources. + */ + items?: {[key: string]: Schema$SubnetworksScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. + */ + 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; + } + /** + * Contains a list of Subnetwork resources. + */ + export interface Schema$SubnetworkList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Subnetwork resources. + */ + items?: Schema$Subnetwork[]; + /** + * [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. + */ + 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; + } + /** + * The available logging options for this subnetwork. + */ + export interface Schema$SubnetworkLogConfig { + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. + */ + aggregationInterval?: string | null; + /** + * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. + */ + enable?: boolean | null; + /** + * Can only be specified if VPC flow logs for this subnetwork is enabled. Export filter used to define which VPC flow logs should be logged. + */ + filterExpr?: string | null; + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5, which means half of all collected logs are reported. + */ + flowSampling?: number | null; + /** + * Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. + */ + metadata?: string | null; + /** + * Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA. + */ + metadataFields?: string[] | null; + } + /** + * Represents a secondary IP range of a subnetwork. + */ + export interface Schema$SubnetworkSecondaryRange { + /** + * The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. + */ + ipCidrRange?: string | null; + /** + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. + */ + rangeName?: string | null; + /** + * The type of IP CIDR range to associate with this subnetwork secondary range. The default is RFC_1918. When creating a subnetwork in non-RFC 1918 range, this field must be set to NON_RFC_1918. + */ + rangeType?: string | null; + } + export interface Schema$SubnetworksExpandIpCidrRangeRequest { + /** + * The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. + */ + ipCidrRange?: string | null; + /** + * The type of IP CIDR range to associate with this subnetwork. The default is RFC_1918. When expanding to a non-RFC 1918 range, this field must be be set to NON_RFC_1918. + */ + rangeType?: string | null; + } + export interface Schema$SubnetworksScopedList { + /** + * A list of subnetworks contained in this scope. + */ + subnetworks?: Schema$Subnetwork[]; + /** + * An informational warning that appears when the list of addresses is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { + privateIpGoogleAccess?: boolean | null; + } + /** + * A set of instance tags. + */ + export interface Schema$Tags { + /** + * Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. + */ + fingerprint?: string | null; + /** + * An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. + */ + items?: string[] | null; + } + export interface Schema$TargetHttpProxiesScopedList { + /** + * A list of TargetHttpProxies contained in this scope. + */ + targetHttpProxies?: Schema$TargetHttpProxy[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | 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 ==) + */ + export interface Schema$TargetHttpProxy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false. + */ + proxyBind?: boolean | null; + /** + * [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * URL to the UrlMap resource that defines the mapping from URL to the BackendService. + */ + urlMap?: string | null; + } + export interface Schema$TargetHttpProxyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetHttpProxiesScopedList resources. + */ + items?: {[key: string]: Schema$TargetHttpProxiesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. + */ + 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; + } + /** + * A list of TargetHttpProxy resources. + */ + export interface Schema$TargetHttpProxyList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetHttpProxy resources. + */ + items?: Schema$TargetHttpProxy[]; + /** + * Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetHttpsProxiesScopedList { + /** + * A list of TargetHttpsProxies contained in this scope. + */ + targetHttpsProxies?: Schema$TargetHttpsProxy[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { + /** + * QUIC policy for the TargetHttpsProxy resource. + */ + quicOverride?: string | null; + } + export interface Schema$TargetHttpsProxiesSetSslCertificatesRequest { + /** + * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. + */ + 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 ==) + */ + export interface Schema$TargetHttpsProxy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false. + */ + proxyBind?: boolean | null; + /** + * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. + */ + quicOverride?: string | null; + /** + * [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. + */ + sslCertificates?: string[] | null; + /** + * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. + */ + sslPolicy?: string | null; + /** + * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map + */ + urlMap?: string | null; + } + export interface Schema$TargetHttpsProxyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetHttpsProxiesScopedList resources. + */ + items?: {[key: string]: Schema$TargetHttpsProxiesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. + */ + 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; + } + /** + * Contains a list of TargetHttpsProxy resources. + */ + export interface Schema$TargetHttpsProxyList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetHttpsProxy resources. + */ + items?: Schema$TargetHttpsProxy[]; + /** + * Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. + */ + 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 Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) + */ + export interface Schema$TargetInstance { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance + */ + instance?: string | null; + /** + * [Output Only] The type of the resource. Always compute#targetInstance for target instances. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. + */ + natPolicy?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$TargetInstanceAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetInstance resources. + */ + items?: {[key: string]: Schema$TargetInstancesScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Contains a list of TargetInstance resources. + */ + export interface Schema$TargetInstanceList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetInstance resources. + */ + items?: Schema$TargetInstance[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetInstancesScopedList { + /** + * A list of target instances contained in this scope. + */ + targetInstances?: Schema$TargetInstance[]; + /** + * Informational warning which replaces the list of addresses when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + */ + export interface Schema$TargetPool { + /** + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. + */ + backupPool?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. + */ + failoverRatio?: number | null; + /** + * The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. + */ + healthChecks?: string[] | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. + */ + instances?: string[] | null; + /** + * [Output Only] Type of the resource. Always compute#targetPool for target pools. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the target pool resides. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. + */ + sessionAffinity?: string | null; + } + export interface Schema$TargetPoolAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetPool resources. + */ + items?: {[key: string]: Schema$TargetPoolsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetPoolInstanceHealth { + healthStatus?: Schema$HealthStatus[]; + /** + * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. + */ + kind?: string | null; + } + /** + * Contains a list of TargetPool resources. + */ + export interface Schema$TargetPoolList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetPool resources. + */ + items?: Schema$TargetPool[]; + /** + * [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetPoolsAddHealthCheckRequest { + /** + * The HttpHealthCheck to add to the target pool. + */ + healthChecks?: Schema$HealthCheckReference[]; + } + export interface Schema$TargetPoolsAddInstanceRequest { + /** + * A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name + */ + instances?: Schema$InstanceReference[]; + } + export interface Schema$TargetPoolsRemoveHealthCheckRequest { + /** + * Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check + */ + healthChecks?: Schema$HealthCheckReference[]; + } + export interface Schema$TargetPoolsRemoveInstanceRequest { + /** + * URLs of the instances to be removed from target pool. + */ + instances?: Schema$InstanceReference[]; + } + export interface Schema$TargetPoolsScopedList { + /** + * A list of target pools contained in this scope. + */ + targetPools?: Schema$TargetPool[]; + /** + * Informational warning which replaces the list of addresses when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetReference { + target?: string | null; + } + export interface Schema$TargetSslProxiesSetBackendServiceRequest { + /** + * The URL of the new BackendService resource for the targetSslProxy. + */ + service?: string | null; + } + export interface Schema$TargetSslProxiesSetProxyHeaderRequest { + /** + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. + */ + proxyHeader?: string | null; + } + export interface Schema$TargetSslProxiesSetSslCertificatesRequest { + /** + * New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. + */ + sslCertificates?: string[] | null; + } + /** + * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) + */ + export interface Schema$TargetSslProxy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * URL to the BackendService resource. + */ + service?: string | null; + /** + * URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. + */ + sslCertificates?: string[] | null; + /** + * URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. + */ + sslPolicy?: string | null; + } + /** + * Contains a list of TargetSslProxy resources. + */ + export interface Schema$TargetSslProxyList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetSslProxy resources. + */ + items?: Schema$TargetSslProxy[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetTcpProxiesSetBackendServiceRequest { + /** + * The URL of the new BackendService resource for the targetTcpProxy. + */ + service?: string | null; + } + export interface Schema$TargetTcpProxiesSetProxyHeaderRequest { + /** + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. + */ + proxyHeader?: string | null; + } + /** + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + */ + export interface Schema$TargetTcpProxy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * URL to the BackendService resource. + */ + service?: string | null; + } + /** + * Contains a list of TargetTcpProxy resources. + */ + export interface Schema$TargetTcpProxyList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetTcpProxy resources. + */ + items?: Schema$TargetTcpProxy[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + */ + export interface Schema$TargetVpnGateway { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. + */ + forwardingRules?: string[] | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this TargetVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. + */ + network?: string | null; + /** + * [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. + */ + status?: string | null; + /** + * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. + */ + tunnels?: string[] | null; + } + export interface Schema$TargetVpnGatewayAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetVpnGateway resources. + */ + items?: {[key: string]: Schema$TargetVpnGatewaysScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. + */ + 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; + } + /** + * Contains a list of TargetVpnGateway resources. + */ + export interface Schema$TargetVpnGatewayList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetVpnGateway resources. + */ + items?: Schema$TargetVpnGateway[]; + /** + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TargetVpnGatewaysScopedList { + /** + * [Output Only] A list of target VPN gateways contained in this scope. + */ + targetVpnGateways?: Schema$TargetVpnGateway[]; + /** + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$TCPHealthCheck { + /** + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. + */ + request?: string | null; + /** + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. + */ + response?: string | null; + } + export interface Schema$TestFailure { + actualService?: string | null; + expectedService?: string | null; + host?: string | null; + path?: string | null; + } + export interface Schema$TestPermissionsRequest { + /** + * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. + */ + permissions?: string[] | null; + } + export interface Schema$TestPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * Defines the mechanism to obtain the client or server certificate. + */ + export interface Schema$TlsCertificateContext { + /** + * Specifies the certificate and private key paths. This field is applicable only if tlsCertificateSource is set to USE_PATH. + */ + certificatePaths?: Schema$TlsCertificatePaths; + /** + * Defines how TLS certificates are obtained. + */ + certificateSource?: string | null; + /** + * Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. + */ + sdsConfig?: Schema$SdsConfig; + } + /** + * The paths to the mounted TLS Certificates and private key. + */ + export interface Schema$TlsCertificatePaths { + /** + * The path to the file holding the client or server TLS certificate to use. + */ + certificatePath?: string | null; + /** + * The path to the file holding the client or server private key. + */ + privateKeyPath?: string | null; + } + /** + * The TLS settings for the client or server. + */ + export interface Schema$TlsContext { + /** + * Defines the mechanism to obtain the client or server certificate. + */ + certificateContext?: Schema$TlsCertificateContext; + /** + * Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. If omitted, the proxy will not validate the server or client certificate. + */ + validationContext?: Schema$TlsValidationContext; + } + /** + * Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. + */ + export interface Schema$TlsValidationContext { + /** + * The path to the file holding the CA certificate to validate the client or server certificate. + */ + certificatePath?: string | null; + /** + * Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. + */ + sdsConfig?: Schema$SdsConfig; + /** + * Defines how TLS certificates are obtained. + */ + validationSource?: string | null; + } + export interface Schema$UDPHealthCheck { + /** + * The UDP port number for the health check request. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. + */ + request?: string | null; + /** + * The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. + */ + response?: string | null; + } + /** + * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. + */ + export interface Schema$UrlMap { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. + */ + defaultRouteAction?: Schema$HttpRouteAction; + /** + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. + */ + defaultService?: string | null; + /** + * When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + */ + defaultUrlRedirect?: Schema$HttpRedirectAction; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. + */ + fingerprint?: string | null; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. + */ + headerAction?: Schema$HttpHeaderAction; + /** + * The list of HostRules to use against the URL. + */ + hostRules?: Schema$HostRule[]; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#urlMaps for url maps. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * The list of named PathMatchers to use against the URL. + */ + pathMatchers?: Schema$PathMatcher[]; + /** + * [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. + */ + tests?: Schema$UrlMapTest[]; + } + /** + * Contains a list of UrlMap resources. + */ + export interface Schema$UrlMapList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of UrlMap resources. + */ + items?: Schema$UrlMap[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$UrlMapReference { + urlMap?: string | null; + } + export interface Schema$UrlMapsAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of UrlMapsScopedList resources. + */ + items?: {[key: string]: Schema$UrlMapsScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$UrlMapsScopedList { + /** + * A list of UrlMaps contained in this scope. + */ + urlMaps?: Schema$UrlMap[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$UrlMapsValidateRequest { + /** + * Content of the UrlMap to be validated. + */ + resource?: Schema$UrlMap; + } + export interface Schema$UrlMapsValidateResponse { + result?: Schema$UrlMapValidationResult; + } + /** + * Message for the expected URL mappings. + */ + export interface Schema$UrlMapTest { + /** + * The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting. + */ + backendServiceWeight?: number | null; + /** + * Description of this test case. + */ + description?: string | null; + /** + * The expected URL that should be redirected to for the host and path being tested. + */ + expectedUrlRedirect?: string | null; + /** + * Host portion of the URL. + */ + host?: string | null; + /** + * Path portion of the URL. + */ + path?: string | null; + /** + * Expected BackendService resource the given URL should be mapped to. + */ + service?: string | null; + } + /** + * Message representing the validation result for a UrlMap. + */ + export interface Schema$UrlMapValidationResult { + loadErrors?: string[] | null; + /** + * Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons. + */ + loadSucceeded?: boolean | null; + testFailures?: Schema$TestFailure[]; + /** + * If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure. + */ + testPassed?: boolean | null; + } + /** + * The spec for modifying the path before sending the request to the matched backend service. + */ + export interface Schema$UrlRewrite { + /** + * Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters. + */ + hostRewrite?: string | null; + /** + * Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters. + */ + pathPrefixRewrite?: string | null; + } + /** + * Subnetwork which the current user has compute.subnetworks.use permission on. + */ + export interface Schema$UsableSubnetwork { + /** + * The range of internal addresses that are owned by this subnetwork. + */ + ipCidrRange?: string | null; + /** + * Network URL. + */ + network?: string | null; + /** + * Secondary IP ranges. + */ + secondaryIpRanges?: Schema$UsableSubnetworkSecondaryRange[]; + /** + * Subnetwork URL. + */ + subnetwork?: string | null; + } + export interface Schema$UsableSubnetworksAggregatedList { + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output] A list of usable subnetwork URLs. + */ + items?: Schema$UsableSubnetwork[]; + /** + * [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks. + */ + 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; + } + /** + * Secondary IP range of a usable subnetwork. + */ + export interface Schema$UsableSubnetworkSecondaryRange { + /** + * The range of IP addresses belonging to this subnetwork secondary range. + */ + ipCidrRange?: string | null; + /** + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. + */ + rangeName?: string | null; + } + /** + * The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. + */ + export interface Schema$UsageExportLocation { + /** + * The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. + */ + bucketName?: string | null; + /** + * An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. + */ + reportNamePrefix?: string | null; + } + /** + * Contain information of Nat mapping for a VM endpoint (i.e., NIC). + */ + export interface Schema$VmEndpointNatMappings { + /** + * Name of the VM instance which the endpoint belongs to + */ + instanceName?: string | null; + interfaceNatMappings?: Schema$VmEndpointNatMappingsInterfaceNatMappings[]; + } + /** + * Contain information of Nat mapping for an interface of this endpoint. + */ + export interface Schema$VmEndpointNatMappingsInterfaceNatMappings { + /** + * List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. + */ + drainNatIpPortRanges?: string[] | null; + /** + * A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. + */ + natIpPortRanges?: string[] | null; + /** + * Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges. + */ + numTotalDrainNatPorts?: number | null; + /** + * Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. + */ + numTotalNatPorts?: number | null; + /** + * Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". + */ + sourceAliasIpRange?: string | null; + /** + * Primary IP of the VM for this NIC. + */ + sourceVirtualIp?: string | null; + } + /** + * Contains a list of VmEndpointNatMappings. + */ + export interface Schema$VmEndpointNatMappingsList { + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] A list of Nat mapping information of VM endpoints. + */ + result?: Schema$VmEndpointNatMappings[]; + /** + * [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 VPN gateway resource. + */ + export interface Schema$VpnGateway { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an VpnGateway. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. + */ + network?: string | null; + /** + * [Output Only] URL of the region where the VPN gateway resides. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] A list of interfaces on this VPN gateway. + */ + vpnInterfaces?: Schema$VpnGatewayVpnGatewayInterface[]; + } + export interface Schema$VpnGatewayAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of VpnGateway resources. + */ + items?: {[key: string]: Schema$VpnGatewaysScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. + */ + 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; + } + /** + * Contains a list of VpnGateway resources. + */ + export interface Schema$VpnGatewayList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of VpnGateway resources. + */ + items?: Schema$VpnGateway[]; + /** + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$VpnGatewaysGetStatusResponse { + result?: Schema$VpnGatewayStatus; + } + export interface Schema$VpnGatewaysScopedList { + /** + * [Output Only] A list of VPN gateways contained in this scope. + */ + vpnGateways?: Schema$VpnGateway[]; + /** + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$VpnGatewayStatus { + /** + * List of VPN connection for this VpnGateway. + */ + vpnConnections?: Schema$VpnGatewayStatusVpnConnection[]; + } + /** + * Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway. + */ + export interface Schema$VpnGatewayStatusHighAvailabilityRequirementState { + /** + * Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. + */ + state?: string | null; + /** + * Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. + */ + unsatisfiedReason?: string | null; + } + /** + * Contains some information about a VPN tunnel. + */ + export interface Schema$VpnGatewayStatusTunnel { + /** + * The VPN gateway interface this VPN tunnel is associated with. + */ + localGatewayInterface?: number | null; + /** + * The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway. + */ + peerGatewayInterface?: number | null; + /** + * URL reference to the VPN tunnel. + */ + tunnelUrl?: string | null; + } + /** + * A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway. + */ + export interface Schema$VpnGatewayStatusVpnConnection { + /** + * URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. + */ + peerExternalGateway?: string | null; + /** + * URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. + */ + peerGcpGateway?: string | null; + /** + * HighAvailabilityRequirementState for the VPN connection. + */ + state?: Schema$VpnGatewayStatusHighAvailabilityRequirementState; + /** + * List of VPN tunnels that are in this VPN connection. + */ + tunnels?: Schema$VpnGatewayStatusTunnel[]; + } + /** + * A VPN gateway interface. + */ + export interface Schema$VpnGatewayVpnGatewayInterface { + /** + * The numeric ID of this VPN gateway interface. + */ + id?: number | null; + /** + * The external IP address for this VPN gateway interface. + */ + ipAddress?: string | null; + } + /** + * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) + */ + export interface Schema$VpnTunnel { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] Detailed status message for the VPN tunnel. + */ + detailedStatus?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. + */ + ikeVersion?: number | null; + /** + * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + */ + localTrafficSelector?: string[] | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. + */ + peerExternalGateway?: string | null; + /** + * The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. + */ + peerExternalGatewayInterface?: number | null; + /** + * URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. + */ + peerGcpGateway?: string | null; + /** + * IP address of the peer VPN gateway. Only IPv4 is supported. + */ + peerIp?: string | null; + /** + * [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + */ + remoteTrafficSelector?: string[] | null; + /** + * URL of the router resource to be used for dynamic routing. + */ + router?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. + */ + sharedSecret?: string | null; + /** + * Hash of the shared secret. + */ + sharedSecretHash?: string | null; + /** + * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. + */ + status?: string | null; + /** + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + */ + targetVpnGateway?: string | null; + /** + * URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. + */ + vpnGateway?: string | null; + /** + * The interface ID of the VPN gateway with which this VPN tunnel is associated. + */ + vpnGatewayInterface?: number | null; + } + export interface Schema$VpnTunnelAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of VpnTunnelsScopedList resources. + */ + items?: {[key: string]: Schema$VpnTunnelsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. + */ + 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; + } + /** + * Contains a list of VpnTunnel resources. + */ + export interface Schema$VpnTunnelList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of VpnTunnel resources. + */ + items?: Schema$VpnTunnel[]; + /** + * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$VpnTunnelsScopedList { + /** + * A list of VPN tunnels contained in this scope. + */ + vpnTunnels?: Schema$VpnTunnel[]; + /** + * Informational warning which replaces the list of addresses when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$WafExpressionSet { + /** + * A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set. + */ + aliases?: string[] | null; + /** + * List of available expressions. + */ + expressions?: Schema$WafExpressionSetExpression[]; + /** + * Google specified expression set ID. The format should be: - E.g. XSS-20170329 + */ + id?: string | null; + } + export interface Schema$WafExpressionSetExpression { + /** + * Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. + */ + id?: string | null; + } + /** + * In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService + */ + export interface Schema$WeightedBackendService { + /** + * The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight. + */ + backendService?: string | null; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. + */ + headerAction?: Schema$HttpHeaderAction; + /** + * Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000 + */ + weight?: number | null; + } + export interface Schema$XpnHostList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * [Output Only] A list of shared VPC host project URLs. + */ + items?: Schema$Project[]; + /** + * [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. + */ + 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; + } + /** + * Service resource (a.k.a service project) ID. + */ + export interface Schema$XpnResourceId { + /** + * The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). + */ + id?: string | null; + /** + * The type of the service resource. + */ + type?: string | null; + } + /** + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) + */ + export interface Schema$Zone { + /** + * [Output Only] Available cpu/platform selections for the zone. + */ + availableCpuPlatforms?: string[] | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this zone. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] Textual description of the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#zone for zones. + */ + kind?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Full URL reference to the region which hosts the zone. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Status of the zone, either UP or DOWN. + */ + status?: string | null; + } + /** + * Contains a list of zone resources. + */ + export interface Schema$ZoneList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Zone resources. + */ + items?: Schema$Zone[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$ZoneSetLabelsRequest { + /** + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. + */ + labelFingerprint?: string | null; + /** + * The labels to set for this resource. + */ + labels?: {[key: string]: string} | null; + } + export interface Schema$ZoneSetPolicyRequest { + /** + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. + */ + bindings?: Schema$Binding[]; + /** + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. + */ + etag?: string | null; + /** + * 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 in general a valid policy but certain services (like Projects) might reject them. + */ + policy?: Schema$Policy; + } + + export class Resource$Acceleratortypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.acceleratorTypes.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Acceleratortypes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Acceleratortypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Acceleratortypes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Acceleratortypes$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Acceleratortypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Acceleratortypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/acceleratorTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.acceleratorTypes.get + * @desc Returns the specified accelerator type. + * @alias compute.acceleratorTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.acceleratorType Name of the accelerator type to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Acceleratortypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Acceleratortypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Acceleratortypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Acceleratortypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Acceleratortypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Acceleratortypes$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}/zones/{zone}/acceleratorTypes/{acceleratorType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'acceleratorType'], + pathParams: ['acceleratorType', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.acceleratorTypes.list + * @desc Retrieves a list of accelerator types available to the specified project. + * @alias compute.acceleratorTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Acceleratortypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Acceleratortypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Acceleratortypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Acceleratortypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Acceleratortypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Acceleratortypes$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}/zones/{zone}/acceleratorTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Acceleratortypes$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Acceleratortypes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the accelerator type to return. + */ + acceleratorType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Acceleratortypes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Addresses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.addresses.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Addresses$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Addresses$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Addresses$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Addresses$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Addresses$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/aggregated/addresses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.addresses.delete + * @desc Deletes the specified address resource. + * @alias compute.addresses.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.address Name of the address resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Addresses$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Addresses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Addresses$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Addresses$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Addresses$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$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}/addresses/{address}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'address'], + pathParams: ['address', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.addresses.get + * @desc Returns the specified address resource. + * @alias compute.addresses.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.address Name of the address resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Addresses$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Addresses$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Addresses$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Addresses$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Addresses$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$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}/addresses/{address}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'address'], + pathParams: ['address', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.addresses.insert + * @desc Creates an address resource in the specified project by using the data included in the request. + * @alias compute.addresses.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Address} params.resource Request body data + * @param {object} [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$Addresses$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Addresses$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Addresses$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Addresses$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Addresses$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$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}/addresses' + ).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.addresses.list + * @desc Retrieves a list of addresses contained within the specified region. + * @alias compute.addresses.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Addresses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Addresses$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Addresses$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Addresses$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Addresses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$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}/addresses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.addresses.setLabels + * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.addresses.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Addresses$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Addresses$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Addresses$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Addresses$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Addresses$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$Setlabels; + 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}/addresses/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.addresses.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.addresses.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Addresses$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Addresses$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Addresses$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Addresses$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Addresses$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Addresses$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/alpha/projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Addresses$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Addresses$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the address resource to delete. + */ + address?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Addresses$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the address resource to return. + */ + address?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Addresses$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Address; + } + export interface Params$Resource$Addresses$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Addresses$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Addresses$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Autoscalers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.autoscalers.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Autoscalers$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Autoscalers$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Autoscalers$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Autoscalers$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Autoscalers$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.autoscalers.delete + * @desc Deletes the specified autoscaler. + * @alias compute.autoscalers.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.autoscaler Name of the autoscaler 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 Name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Autoscalers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Autoscalers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Autoscalers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Autoscalers$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Autoscalers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$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}/zones/{zone}/autoscalers/{autoscaler}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'autoscaler'], + pathParams: ['autoscaler', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.autoscalers.get + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. + * @alias compute.autoscalers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.autoscaler Name of the autoscaler 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 + */ + get( + params?: Params$Resource$Autoscalers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Autoscalers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Autoscalers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Autoscalers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Autoscalers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$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}/zones/{zone}/autoscalers/{autoscaler}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'autoscaler'], + pathParams: ['autoscaler', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.autoscalers.insert + * @desc Creates an autoscaler in the specified project using the data included in the request. + * @alias compute.autoscalers.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.zone Name of the zone for this request. + * @param {().Autoscaler} params.resource Request body data + * @param {object} [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$Autoscalers$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Autoscalers$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Autoscalers$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Autoscalers$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Autoscalers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$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}/zones/{zone}/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.autoscalers.list + * @desc Retrieves a list of autoscalers contained within the specified zone. + * @alias compute.autoscalers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone Name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Autoscalers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Autoscalers$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Autoscalers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Autoscalers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Autoscalers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$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}/zones/{zone}/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.autoscalers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.autoscaler Name of the autoscaler to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone Name of the zone for this request. + * @param {().Autoscaler} params.resource Request body data + * @param {object} [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$Autoscalers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Autoscalers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Autoscalers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Autoscalers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Autoscalers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$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}/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.autoscalers.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.autoscalers.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Autoscalers$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Autoscalers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Autoscalers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Autoscalers$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Autoscalers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$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/alpha/projects/{project}/zones/{zone}/autoscalers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.autoscalers.update + * @desc Updates an autoscaler in the specified project using the data included in the request. + * @alias compute.autoscalers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.autoscaler Name of the autoscaler 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 Name of the zone for this request. + * @param {().Autoscaler} params.resource Request body data + * @param {object} [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$Autoscalers$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Autoscalers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Autoscalers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Autoscalers$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Autoscalers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Autoscalers$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}/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Autoscalers$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Autoscalers$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to delete. + */ + autoscaler?: 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; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Autoscalers$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to return. + */ + autoscaler?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Autoscalers$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; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Autoscaler; + } + export interface Params$Resource$Autoscalers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Autoscalers$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to patch. + */ + autoscaler?: 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; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Autoscaler; + } + export interface Params$Resource$Autoscalers$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Autoscalers$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to update. + */ + autoscaler?: 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; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Autoscaler; + } + + export class Resource$Backendbuckets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.backendBuckets.addSignedUrlKey + * @desc Adds a key for validating requests with signed URLs for this backend bucket. + * @alias compute.backendBuckets.addSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket resource to which the Signed URL Key should be added. The name 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 {().SignedUrlKey} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addSignedUrlKey( + params?: Params$Resource$Backendbuckets$Addsignedurlkey, + options?: MethodOptions + ): GaxiosPromise; + addSignedUrlKey( + params: Params$Resource$Backendbuckets$Addsignedurlkey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addSignedUrlKey( + params: Params$Resource$Backendbuckets$Addsignedurlkey, + callback: BodyResponseCallback + ): void; + addSignedUrlKey(callback: BodyResponseCallback): void; + addSignedUrlKey( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Addsignedurlkey + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Addsignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$Addsignedurlkey; + 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}/global/backendBuckets/{backendBucket}/addSignedUrlKey' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'backendBucket'], + pathParams: ['backendBucket', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendBuckets.delete + * @desc Deletes the specified BackendBucket resource. + * @alias compute.backendBuckets.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Backendbuckets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Backendbuckets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Backendbuckets$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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}/global/backendBuckets/{backendBucket}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'backendBucket'], + pathParams: ['backendBucket', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendBuckets.deleteSignedUrlKey + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. + * @alias compute.backendBuckets.deleteSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. + * @param {string} params.keyName The name of the Signed URL Key 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 + */ + deleteSignedUrlKey( + params?: Params$Resource$Backendbuckets$Deletesignedurlkey, + options?: MethodOptions + ): GaxiosPromise; + deleteSignedUrlKey( + params: Params$Resource$Backendbuckets$Deletesignedurlkey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteSignedUrlKey( + params: Params$Resource$Backendbuckets$Deletesignedurlkey, + callback: BodyResponseCallback + ): void; + deleteSignedUrlKey(callback: BodyResponseCallback): void; + deleteSignedUrlKey( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Deletesignedurlkey + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Deletesignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$Deletesignedurlkey; + 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}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'backendBucket', 'keyName'], + pathParams: ['backendBucket', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendBuckets.get + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. + * @alias compute.backendBuckets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket 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 + */ + get( + params?: Params$Resource$Backendbuckets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Backendbuckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Backendbuckets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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}/global/backendBuckets/{backendBucket}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'backendBucket'], + pathParams: ['backendBucket', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendBuckets.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.backendBuckets.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$Backendbuckets$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Backendbuckets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Backendbuckets$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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/alpha/projects/{project}/global/backendBuckets/{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.backendBuckets.insert + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. + * @alias compute.backendBuckets.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 {().BackendBucket} params.resource Request body data + * @param {object} [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$Backendbuckets$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Backendbuckets$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Backendbuckets$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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}/global/backendBuckets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendBuckets.list + * @desc Retrieves the list of BackendBucket resources available to the specified project. + * @alias compute.backendBuckets.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$Backendbuckets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Backendbuckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Backendbuckets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Backendbuckets$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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}/global/backendBuckets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.backendBuckets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().BackendBucket} params.resource Request body data + * @param {object} [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$Backendbuckets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Backendbuckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Backendbuckets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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}/global/backendBuckets/{backendBucket}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'backendBucket'], + pathParams: ['backendBucket', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendBuckets.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.backendBuckets.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.resource Request body data + * @param {object} [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$Backendbuckets$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Backendbuckets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Backendbuckets$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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/alpha/projects/{project}/global/backendBuckets/{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.backendBuckets.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.backendBuckets.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.resource Request body data + * @param {object} [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$Backendbuckets$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Backendbuckets$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Backendbuckets$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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/alpha/projects/{project}/global/backendBuckets/{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); + } + } + + /** + * compute.backendBuckets.update + * @desc Updates the specified BackendBucket resource with the data included in the request. + * @alias compute.backendBuckets.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket 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 {().BackendBucket} params.resource Request body data + * @param {object} [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$Backendbuckets$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Backendbuckets$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Backendbuckets$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$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}/global/backendBuckets/{backendBucket}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'backendBucket'], + pathParams: ['backendBucket', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Backendbuckets$Addsignedurlkey + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignedUrlKey; + } + export interface Params$Resource$Backendbuckets$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendBucket resource to delete. + */ + backendBucket?: 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$Backendbuckets$Deletesignedurlkey + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. + */ + backendBucket?: string; + /** + * The name of the Signed URL Key to delete. + */ + keyName?: 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$Backendbuckets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendBucket resource to return. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Backendbuckets$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$Backendbuckets$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + export interface Params$Resource$Backendbuckets$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$Backendbuckets$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendBucket resource to patch. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + export interface Params$Resource$Backendbuckets$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$Backendbuckets$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Backendbuckets$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendBucket resource to update. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + + export class Resource$Backendservices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.backendServices.addSignedUrlKey + * @desc Adds a key for validating requests with signed URLs for this backend service. + * @alias compute.backendServices.addSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to which the Signed URL Key should be added. The name 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 {().SignedUrlKey} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addSignedUrlKey( + params?: Params$Resource$Backendservices$Addsignedurlkey, + options?: MethodOptions + ): GaxiosPromise; + addSignedUrlKey( + params: Params$Resource$Backendservices$Addsignedurlkey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addSignedUrlKey( + params: Params$Resource$Backendservices$Addsignedurlkey, + callback: BodyResponseCallback + ): void; + addSignedUrlKey(callback: BodyResponseCallback): void; + addSignedUrlKey( + paramsOrCallback?: + | Params$Resource$Backendservices$Addsignedurlkey + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Addsignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Addsignedurlkey; + 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}/global/backendServices/{backendService}/addSignedUrlKey' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendServices.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Backendservices$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Backendservices$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Backendservices$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Backendservices$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/backendServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.backendServices.delete + * @desc Deletes the specified BackendService resource. + * @alias compute.backendServices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Backendservices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Backendservices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Backendservices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Backendservices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$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}/global/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendServices.deleteSignedUrlKey + * @desc Deletes a key for validating requests with signed URLs for this backend service. + * @alias compute.backendServices.deleteSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. + * @param {string} params.keyName The name of the Signed URL Key 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 + */ + deleteSignedUrlKey( + params?: Params$Resource$Backendservices$Deletesignedurlkey, + options?: MethodOptions + ): GaxiosPromise; + deleteSignedUrlKey( + params: Params$Resource$Backendservices$Deletesignedurlkey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteSignedUrlKey( + params: Params$Resource$Backendservices$Deletesignedurlkey, + callback: BodyResponseCallback + ): void; + deleteSignedUrlKey(callback: BodyResponseCallback): void; + deleteSignedUrlKey( + paramsOrCallback?: + | Params$Resource$Backendservices$Deletesignedurlkey + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Deletesignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Deletesignedurlkey; + 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}/global/backendServices/{backendService}/deleteSignedUrlKey' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'backendService', 'keyName'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendServices.get + * @desc Returns the specified BackendService resource. Gets a list of available backend services. + * @alias compute.backendServices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService 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 + */ + get( + params?: Params$Resource$Backendservices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Backendservices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Backendservices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Backendservices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$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}/global/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendServices.getHealth + * @desc Gets the most recent health check results for this BackendService. + * @alias compute.backendServices.getHealth + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to which the queried instance belongs. + * @param {string} params.project + * @param {().ResourceGroupReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getHealth( + params?: Params$Resource$Backendservices$Gethealth, + options?: MethodOptions + ): GaxiosPromise; + getHealth( + params: Params$Resource$Backendservices$Gethealth, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHealth( + params: Params$Resource$Backendservices$Gethealth, + callback: BodyResponseCallback + ): void; + getHealth( + callback: BodyResponseCallback + ): void; + getHealth( + paramsOrCallback?: + | Params$Resource$Backendservices$Gethealth + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Gethealth; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Gethealth; + 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}/global/backendServices/{backendService}/getHealth' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.backendServices.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 {().BackendService} params.resource Request body data + * @param {object} [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$Backendservices$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Backendservices$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Backendservices$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Backendservices$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$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}/global/backendServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendServices.list + * @desc Retrieves the list of BackendService resources available to the specified project. + * @alias compute.backendServices.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$Backendservices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Backendservices$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Backendservices$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Backendservices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$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}/global/backendServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.backendServices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().BackendService} params.resource Request body data + * @param {object} [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$Backendservices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Backendservices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Backendservices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Backendservices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$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}/global/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendServices.setSecurityPolicy + * @desc Sets the security policy for the specified backend service. + * @alias compute.backendServices.setSecurityPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to which the security policy should be set. The name 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 {().SecurityPolicyReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSecurityPolicy( + params?: Params$Resource$Backendservices$Setsecuritypolicy, + options?: MethodOptions + ): GaxiosPromise; + setSecurityPolicy( + params: Params$Resource$Backendservices$Setsecuritypolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSecurityPolicy( + params: Params$Resource$Backendservices$Setsecuritypolicy, + callback: BodyResponseCallback + ): void; + setSecurityPolicy(callback: BodyResponseCallback): void; + setSecurityPolicy( + paramsOrCallback?: + | Params$Resource$Backendservices$Setsecuritypolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Setsecuritypolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Setsecuritypolicy; + 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}/global/backendServices/{backendService}/setSecurityPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.backendServices.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.backendServices.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.resource Request body data + * @param {object} [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$Backendservices$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Backendservices$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Backendservices$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Backendservices$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$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/alpha/projects/{project}/global/backendServices/{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); + } + } + + /** + * 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. + * @alias compute.backendServices.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService 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 {().BackendService} params.resource Request body data + * @param {object} [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$Backendservices$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Backendservices$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Backendservices$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Backendservices$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$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}/global/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Backendservices$Addsignedurlkey + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignedUrlKey; + } + export interface Params$Resource$Backendservices$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } + export interface Params$Resource$Backendservices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to delete. + */ + backendService?: 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$Backendservices$Deletesignedurlkey + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. + */ + backendService?: string; + /** + * The name of the Signed URL Key to delete. + */ + keyName?: 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$Backendservices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to return. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Backendservices$Gethealth + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to which the queried instance belongs. + */ + backendService?: string; + /** + * + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResourceGroupReference; + } + export interface Params$Resource$Backendservices$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendService; + } + export interface Params$Resource$Backendservices$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$Backendservices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to patch. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendService; + } + export interface Params$Resource$Backendservices$Setsecuritypolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyReference; + } + export interface Params$Resource$Backendservices$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Backendservices$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to update. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendService; + } + + export class Resource$Disks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.disks.addResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().DisksAddResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addResourcePolicies( + params?: Params$Resource$Disks$Addresourcepolicies, + options?: MethodOptions + ): GaxiosPromise; + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, + callback: BodyResponseCallback + ): void; + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( + paramsOrCallback?: + | Params$Resource$Disks$Addresourcepolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Addresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Addresourcepolicies; + 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}/disks/{disk}/addResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Disks$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Disks$Aggregatedlist, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Disks$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Disks$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/aggregated/disks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.createSnapshot + * @desc Creates a snapshot of a specified persistent disk. + * @alias compute.disks.createSnapshot + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk Name of the persistent disk to snapshot. + * @param {boolean=} params.guestFlush [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). + * @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 {().Snapshot} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createSnapshot( + params?: Params$Resource$Disks$Createsnapshot, + options?: MethodOptions + ): GaxiosPromise; + createSnapshot( + params: Params$Resource$Disks$Createsnapshot, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSnapshot( + params: Params$Resource$Disks$Createsnapshot, + callback: BodyResponseCallback + ): void; + createSnapshot(callback: BodyResponseCallback): void; + createSnapshot( + paramsOrCallback?: + | Params$Resource$Disks$Createsnapshot + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Createsnapshot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Createsnapshot; + 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}/disks/{disk}/createSnapshot' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.disks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk Name of the persistent disk to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Disks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Disks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Disks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Disks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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}/zones/{zone}/disks/{disk}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.get + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. + * @alias compute.disks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk Name of the persistent disk to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Disks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Disks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Disks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Disks$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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}/zones/{zone}/disks/{disk}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.disks.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 {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Disks$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Disks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Disks$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Disks$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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/alpha/projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.disks.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.sourceImage Optional. Source image to restore onto a disk. + * @param {string} params.zone The name of the zone for this request. + * @param {().Disk} params.resource Request body data + * @param {object} [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$Disks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Disks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Disks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Disks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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}/zones/{zone}/disks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.list + * @desc Retrieves a list of persistent disks contained within the specified zone. + * @alias compute.disks.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Disks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Disks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Disks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Disks$List + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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}/zones/{zone}/disks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.removeResourcePolicies + * @desc Removes resource policies from a disk. + * @alias compute.disks.removeResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().DisksRemoveResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeResourcePolicies( + params?: Params$Resource$Disks$Removeresourcepolicies, + options?: MethodOptions + ): GaxiosPromise; + removeResourcePolicies( + params: Params$Resource$Disks$Removeresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + params: Params$Resource$Disks$Removeresourcepolicies, + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + paramsOrCallback?: + | Params$Resource$Disks$Removeresourcepolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Removeresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Removeresourcepolicies; + 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}/disks/{disk}/removeResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.resize + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. + * @alias compute.disks.resize + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The name of the persistent disk. + * @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 {().DisksResizeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resize( + params?: Params$Resource$Disks$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Disks$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Disks$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Disks$Resize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Resize; + 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}/disks/{disk}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.disks.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 {string} params.zone The name of the zone for this request. + * @param {().ZoneSetPolicyRequest} params.resource Request body data + * @param {object} [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$Disks$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Disks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Disks$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Disks$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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/alpha/projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.setLabels + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.disks.setLabels + * @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.resource_ Name or id of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {().ZoneSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Disks$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Disks$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Disks$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Disks$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Setlabels; + 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}/disks/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.disks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.disks.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Disks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Disks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Disks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Disks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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/alpha/projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Disks$Addresourcepolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: 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$DisksAddResourcePoliciesRequest; + } + export interface Params$Resource$Disks$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Disks$Createsnapshot + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the persistent disk to snapshot. + */ + disk?: string; + /** + * [Input Only] Specifies to create an application consistent snapshot 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; + /** + * 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$Snapshot; + } + export interface Params$Resource$Disks$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the persistent disk to delete. + */ + disk?: 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; + } + export interface Params$Resource$Disks$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the persistent disk to return. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Disks$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; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Disks$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; + /** + * Optional. Source image to restore onto a disk. + */ + sourceImage?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Disk; + } + export interface Params$Resource$Disks$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Disks$Removeresourcepolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: 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$DisksRemoveResourcePoliciesRequest; + } + export interface Params$Resource$Disks$Resize extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the persistent disk. + */ + disk?: 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$DisksResizeRequest; + } + export interface Params$Resource$Disks$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Disks$Setlabels 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; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetLabelsRequest; + } + export interface Params$Resource$Disks$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Disktypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.diskTypes.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Disktypes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Disktypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Disktypes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Disktypes$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disktypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disktypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/aggregated/diskTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.diskTypes.get + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. + * @alias compute.diskTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.diskType Name of the disk type to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Disktypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Disktypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Disktypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Disktypes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disktypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disktypes$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}/zones/{zone}/diskTypes/{diskType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'diskType'], + pathParams: ['diskType', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.diskTypes.list + * @desc Retrieves a list of disk types available to the specified project. + * @alias compute.diskTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Disktypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Disktypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Disktypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Disktypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disktypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disktypes$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}/zones/{zone}/diskTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Disktypes$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Disktypes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the disk type to return. + */ + diskType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Disktypes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Externalvpngateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.externalVpnGateways.delete + * @desc Deletes the specified externalVpnGateway. + * @alias compute.externalVpnGateways.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.externalVpnGateway Name of the externalVpnGateways 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$Externalvpngateways$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Externalvpngateways$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Externalvpngateways$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Externalvpngateways$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Externalvpngateways$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Externalvpngateways$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}/global/externalVpnGateways/{externalVpnGateway}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'externalVpnGateway'], + pathParams: ['externalVpnGateway', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.externalVpnGateways.get + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. + * @alias compute.externalVpnGateways.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.externalVpnGateway Name of the externalVpnGateway to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Externalvpngateways$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Externalvpngateways$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Externalvpngateways$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Externalvpngateways$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Externalvpngateways$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Externalvpngateways$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}/global/externalVpnGateways/{externalVpnGateway}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'externalVpnGateway'], + pathParams: ['externalVpnGateway', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.externalVpnGateways.insert + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. + * @alias compute.externalVpnGateways.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 {().ExternalVpnGateway} params.resource Request body data + * @param {object} [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$Externalvpngateways$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Externalvpngateways$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Externalvpngateways$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Externalvpngateways$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Externalvpngateways$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Externalvpngateways$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}/global/externalVpnGateways' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.externalVpnGateways.list + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. + * @alias compute.externalVpnGateways.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$Externalvpngateways$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Externalvpngateways$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Externalvpngateways$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Externalvpngateways$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Externalvpngateways$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Externalvpngateways$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}/global/externalVpnGateways' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.externalVpnGateways.setLabels + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.externalVpnGateways.setLabels + * @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 {().GlobalSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Externalvpngateways$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Externalvpngateways$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Externalvpngateways$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Externalvpngateways$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Externalvpngateways$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Externalvpngateways$Setlabels; + 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}/global/externalVpnGateways/{resource}/setLabels' + ).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.externalVpnGateways.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.externalVpnGateways.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.resource Request body data + * @param {object} [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$Externalvpngateways$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Externalvpngateways$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Externalvpngateways$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Externalvpngateways$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Externalvpngateways$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Externalvpngateways$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/alpha/projects/{project}/global/externalVpnGateways/{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$Externalvpngateways$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the externalVpnGateways to delete. + */ + externalVpnGateway?: 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$Externalvpngateways$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the externalVpnGateway to return. + */ + externalVpnGateway?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Externalvpngateways$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExternalVpnGateway; + } + export interface Params$Resource$Externalvpngateways$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$Externalvpngateways$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Externalvpngateways$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$Firewalls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.firewalls.delete + * @desc Deletes the specified firewall. + * @alias compute.firewalls.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.firewall Name of the firewall rule 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$Firewalls$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Firewalls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Firewalls$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Firewalls$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Firewalls$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$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}/global/firewalls/{firewall}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'firewall'], + pathParams: ['firewall', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.firewalls.get + * @desc Returns the specified firewall. + * @alias compute.firewalls.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.firewall Name of the firewall rule to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Firewalls$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Firewalls$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Firewalls$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Firewalls$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Firewalls$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$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}/global/firewalls/{firewall}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'firewall'], + pathParams: ['firewall', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.firewalls.insert + * @desc Creates a firewall rule in the specified project using the data included in the request. + * @alias compute.firewalls.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 {().Firewall} params.resource Request body data + * @param {object} [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$Firewalls$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Firewalls$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Firewalls$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Firewalls$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Firewalls$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$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}/global/firewalls' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.firewalls.list + * @desc Retrieves the list of firewall rules available to the specified project. + * @alias compute.firewalls.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$Firewalls$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Firewalls$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Firewalls$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Firewalls$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Firewalls$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$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}/global/firewalls' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.firewalls.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.firewall Name of the firewall rule to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Firewall} params.resource Request body data + * @param {object} [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$Firewalls$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Firewalls$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Firewalls$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Firewalls$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Firewalls$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$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}/global/firewalls/{firewall}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'firewall'], + pathParams: ['firewall', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.firewalls.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.firewalls.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.resource Request body data + * @param {object} [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$Firewalls$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Firewalls$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Firewalls$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Firewalls$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewalls$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$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/alpha/projects/{project}/global/firewalls/{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); + } + } + + /** + * compute.firewalls.update + * @desc Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags. + * @alias compute.firewalls.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.firewall Name of the firewall rule 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 {().Firewall} params.resource Request body data + * @param {object} [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$Firewalls$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Firewalls$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Firewalls$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Firewalls$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Firewalls$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$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}/global/firewalls/{firewall}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'firewall'], + pathParams: ['firewall', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Firewalls$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the firewall rule to delete. + */ + firewall?: 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$Firewalls$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the firewall rule to return. + */ + firewall?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Firewalls$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Firewall; + } + export interface Params$Resource$Firewalls$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$Firewalls$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the firewall rule to patch. + */ + firewall?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Firewall; + } + export interface Params$Resource$Firewalls$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Firewalls$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the firewall rule to update. + */ + firewall?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Firewall; + } + + export class Resource$Forwardingrules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.forwardingRules.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Forwardingrules$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Forwardingrules$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Forwardingrules$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/forwardingRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.forwardingRules.delete + * @desc Deletes the specified ForwardingRule resource. + * @alias compute.forwardingRules.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Forwardingrules$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Forwardingrules$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Forwardingrules$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$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}/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'forwardingRule'], + pathParams: ['forwardingRule', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.forwardingRules.get + * @desc Returns the specified ForwardingRule resource. + * @alias compute.forwardingRules.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Forwardingrules$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Forwardingrules$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Forwardingrules$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$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}/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'forwardingRule'], + pathParams: ['forwardingRule', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.forwardingRules.insert + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. + * @alias compute.forwardingRules.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().ForwardingRule} params.resource Request body data + * @param {object} [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$Forwardingrules$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Forwardingrules$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Forwardingrules$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$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}/forwardingRules' + ).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.forwardingRules.list + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. + * @alias compute.forwardingRules.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Forwardingrules$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Forwardingrules$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Forwardingrules$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Forwardingrules$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$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}/forwardingRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.forwardingRules.patch + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. + * @alias compute.forwardingRules.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().ForwardingRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Forwardingrules$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Forwardingrules$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Forwardingrules$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'forwardingRule'], + pathParams: ['forwardingRule', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.forwardingRules.setLabels + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.forwardingRules.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Forwardingrules$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Forwardingrules$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Forwardingrules$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$Setlabels; + 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}/forwardingRules/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.forwardingRules.setTarget + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource in which target is to be set. + * @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 {().TargetReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setTarget( + params?: Params$Resource$Forwardingrules$Settarget, + options?: MethodOptions + ): GaxiosPromise; + setTarget( + params: Params$Resource$Forwardingrules$Settarget, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTarget( + params: Params$Resource$Forwardingrules$Settarget, + callback: BodyResponseCallback + ): void; + setTarget(callback: BodyResponseCallback): void; + setTarget( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Settarget + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Settarget; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$Settarget; + 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}/forwardingRules/{forwardingRule}/setTarget' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'forwardingRule'], + pathParams: ['forwardingRule', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.forwardingRules.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.forwardingRules.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Forwardingrules$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Forwardingrules$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Forwardingrules$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$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/alpha/projects/{project}/regions/{region}/forwardingRules/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Forwardingrules$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Forwardingrules$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource to delete. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Forwardingrules$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource to return. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Forwardingrules$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ForwardingRule; + } + export interface Params$Resource$Forwardingrules$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Forwardingrules$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource to patch. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ForwardingRule; + } + export interface Params$Resource$Forwardingrules$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Forwardingrules$Settarget + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource in which target is to be set. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetReference; + } + export interface Params$Resource$Forwardingrules$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Globaladdresses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.globalAddresses.delete + * @desc Deletes the specified address resource. + * @alias compute.globalAddresses.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.address Name of the address resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Globaladdresses$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Globaladdresses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globaladdresses$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Globaladdresses$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaladdresses$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaladdresses$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}/global/addresses/{address}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'address'], + pathParams: ['address', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalAddresses.get + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. + * @alias compute.globalAddresses.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.address Name of the address 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 + */ + get( + params?: Params$Resource$Globaladdresses$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Globaladdresses$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globaladdresses$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globaladdresses$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaladdresses$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaladdresses$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}/global/addresses/{address}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'address'], + pathParams: ['address', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalAddresses.insert + * @desc Creates an address resource in the specified project by using the data included in the request. + * @alias compute.globalAddresses.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 {().Address} params.resource Request body data + * @param {object} [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$Globaladdresses$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Globaladdresses$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Globaladdresses$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Globaladdresses$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaladdresses$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaladdresses$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}/global/addresses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalAddresses.list + * @desc Retrieves a list of global addresses. + * @alias compute.globalAddresses.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$Globaladdresses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Globaladdresses$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Globaladdresses$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Globaladdresses$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaladdresses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaladdresses$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}/global/addresses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalAddresses.setLabels + * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.globalAddresses.setLabels + * @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 {().GlobalSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Globaladdresses$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Globaladdresses$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Globaladdresses$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Globaladdresses$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaladdresses$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaladdresses$Setlabels; + 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}/global/addresses/{resource}/setLabels' + ).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.globalAddresses.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.globalAddresses.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.resource Request body data + * @param {object} [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$Globaladdresses$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Globaladdresses$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Globaladdresses$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Globaladdresses$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaladdresses$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaladdresses$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/alpha/projects/{project}/global/addresses/{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$Globaladdresses$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the address resource to delete. + */ + address?: 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$Globaladdresses$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the address resource to return. + */ + address?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Globaladdresses$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Address; + } + export interface Params$Resource$Globaladdresses$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$Globaladdresses$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Globaladdresses$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$Globalforwardingrules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.globalForwardingRules.delete + * @desc Deletes the specified GlobalForwardingRule resource. + * @alias compute.globalForwardingRules.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Globalforwardingrules$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Globalforwardingrules$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globalforwardingrules$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$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}/global/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'forwardingRule'], + pathParams: ['forwardingRule', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalForwardingRules.get + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. + * @alias compute.globalForwardingRules.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule 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 + */ + get( + params?: Params$Resource$Globalforwardingrules$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Globalforwardingrules$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalforwardingrules$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$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}/global/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'forwardingRule'], + pathParams: ['forwardingRule', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalForwardingRules.insert + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. + * @alias compute.globalForwardingRules.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 {().ForwardingRule} params.resource Request body data + * @param {object} [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$Globalforwardingrules$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Globalforwardingrules$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Globalforwardingrules$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$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}/global/forwardingRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalForwardingRules.list + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. + * @alias compute.globalForwardingRules.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$Globalforwardingrules$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Globalforwardingrules$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Globalforwardingrules$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$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}/global/forwardingRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalForwardingRules.patch + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. + * @alias compute.globalForwardingRules.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().ForwardingRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Globalforwardingrules$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Globalforwardingrules$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Globalforwardingrules$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'forwardingRule'], + pathParams: ['forwardingRule', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalForwardingRules.setLabels + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.globalForwardingRules.setLabels + * @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 {().GlobalSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Globalforwardingrules$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Globalforwardingrules$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Globalforwardingrules$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$Setlabels; + 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}/global/forwardingRules/{resource}/setLabels' + ).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.globalForwardingRules.setTarget + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource in which target is to be set. + * @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 {().TargetReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setTarget( + params?: Params$Resource$Globalforwardingrules$Settarget, + options?: MethodOptions + ): GaxiosPromise; + setTarget( + params: Params$Resource$Globalforwardingrules$Settarget, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTarget( + params: Params$Resource$Globalforwardingrules$Settarget, + callback: BodyResponseCallback + ): void; + setTarget(callback: BodyResponseCallback): void; + setTarget( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Settarget + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Settarget; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$Settarget; + 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}/global/forwardingRules/{forwardingRule}/setTarget' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'forwardingRule'], + pathParams: ['forwardingRule', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalForwardingRules.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.globalForwardingRules.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.resource Request body data + * @param {object} [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$Globalforwardingrules$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Globalforwardingrules$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Globalforwardingrules$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$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/alpha/projects/{project}/global/forwardingRules/{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$Globalforwardingrules$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource to delete. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Globalforwardingrules$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource to return. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Globalforwardingrules$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ForwardingRule; + } + export interface Params$Resource$Globalforwardingrules$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$Globalforwardingrules$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource to patch. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ForwardingRule; + } + export interface Params$Resource$Globalforwardingrules$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Globalforwardingrules$Settarget + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the ForwardingRule resource in which target is to be set. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetReference; + } + export interface Params$Resource$Globalforwardingrules$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Globalnetworkendpointgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.globalNetworkEndpointGroups.attachNetworkEndpoints + * @desc Attach a network endpoint to the specified network endpoint group. + * @alias compute.globalNetworkEndpointGroups.attachNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().GlobalNetworkEndpointGroupsAttachEndpointsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + attachNetworkEndpoints( + params?: Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + attachNetworkEndpoints( + params: Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + params: Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints, + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalNetworkEndpointGroups.delete + * @desc Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. + * @alias compute.globalNetworkEndpointGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group to delete. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Globalnetworkendpointgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Globalnetworkendpointgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globalnetworkendpointgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Globalnetworkendpointgroups$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalnetworkendpointgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalNetworkEndpointGroups.detachNetworkEndpoints + * @desc Detach the network endpoint from the specified network endpoint group. + * @alias compute.globalNetworkEndpointGroups.detachNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().GlobalNetworkEndpointGroupsDetachEndpointsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + detachNetworkEndpoints( + params?: Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + detachNetworkEndpoints( + params: Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + params: Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints, + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalNetworkEndpointGroups.get + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. + * @alias compute.globalNetworkEndpointGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Globalnetworkendpointgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Globalnetworkendpointgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalnetworkendpointgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globalnetworkendpointgroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalnetworkendpointgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalNetworkEndpointGroups.insert + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @alias compute.globalNetworkEndpointGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NetworkEndpointGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Globalnetworkendpointgroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Globalnetworkendpointgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Globalnetworkendpointgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Globalnetworkendpointgroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalnetworkendpointgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalNetworkEndpointGroups.list + * @desc Retrieves the list of network endpoint groups that are located in the specified project. + * @alias compute.globalNetworkEndpointGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Globalnetworkendpointgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Globalnetworkendpointgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Globalnetworkendpointgroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Globalnetworkendpointgroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalnetworkendpointgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalNetworkEndpointGroups.listNetworkEndpoints + * @desc Lists the network endpoints in the specified network endpoint group. + * @alias compute.globalNetworkEndpointGroups.listNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.networkEndpointGroup The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listNetworkEndpoints( + params?: Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + listNetworkEndpoints( + params: Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints, + options: + | MethodOptions + | BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void; + listNetworkEndpoints( + params: Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints, + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void; + listNetworkEndpoints( + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void; + listNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints + | BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + callback?: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >(parameters); + } + } + } + + export interface Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalNetworkEndpointGroupsAttachEndpointsRequest; + } + export interface Params$Resource$Globalnetworkendpointgroups$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group to delete. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalNetworkEndpointGroupsDetachEndpointsRequest; + } + export interface Params$Resource$Globalnetworkendpointgroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Globalnetworkendpointgroups$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroup; + } + export interface Params$Resource$Globalnetworkendpointgroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + + export class Resource$Globaloperations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.globalOperations.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Globaloperations$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Globaloperations$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Globaloperations$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Globaloperations$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaloperations$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaloperations$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/operations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalOperations.delete + * @desc Deletes the specified Operations resource. + * @alias compute.globalOperations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to delete. + * @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 + */ + delete( + params?: Params$Resource$Globaloperations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Globaloperations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globaloperations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Globaloperations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaloperations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaloperations$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}/global/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'operation'], + pathParams: ['operation', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalOperations.get + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. + * @alias compute.globalOperations.get + * @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 + */ + get( + params?: Params$Resource$Globaloperations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Globaloperations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globaloperations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globaloperations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaloperations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaloperations$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}/global/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'operation'], + pathParams: ['operation', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalOperations.list + * @desc Retrieves a list of Operation resources contained within the specified project. + * @alias compute.globalOperations.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$Globaloperations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Globaloperations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Globaloperations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Globaloperations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaloperations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaloperations$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}/global/operations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + 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/alpha/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 + 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$Globaloperations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to delete. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Globaloperations$Get + 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 interface Params$Resource$Globaloperations$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$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$Globalorganizationoperations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.globalOrganizationOperations.delete + * @desc Deletes the specified Operations resource. + * @alias compute.globalOrganizationOperations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to delete. + * @param {string=} params.parentId Parent 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 + */ + delete( + params?: Params$Resource$Globalorganizationoperations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Globalorganizationoperations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globalorganizationoperations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Globalorganizationoperations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalorganizationoperations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$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/locations/global/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['operation'], + pathParams: ['operation'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalOrganizationOperations.get + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. + * @alias compute.globalOrganizationOperations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string=} params.parentId Parent 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$Globalorganizationoperations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Globalorganizationoperations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalorganizationoperations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globalorganizationoperations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalorganizationoperations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$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/locations/global/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['operation'], + pathParams: ['operation'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalOrganizationOperations.list + * @desc Retrieves a list of Operation resources contained within the specified organization. + * @alias compute.globalOrganizationOperations.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.parentId Parent 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$Globalorganizationoperations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Globalorganizationoperations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Globalorganizationoperations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Globalorganizationoperations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalorganizationoperations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$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/locations/global/operations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.globalOrganizationOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string=} params.parentId Parent 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$Globalorganizationoperations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Globalorganizationoperations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Globalorganizationoperations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Globalorganizationoperations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalorganizationoperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$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/alpha/projects/locations/global/operations/{operation}/wait' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['operation'], + pathParams: ['operation'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Globalorganizationoperations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to delete. + */ + operation?: string; + /** + * Parent ID for this request. + */ + parentId?: string; + } + export interface Params$Resource$Globalorganizationoperations$Get + 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; + /** + * Parent ID for this request. + */ + parentId?: string; + } + export interface Params$Resource$Globalorganizationoperations$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; + /** + * Parent ID for this request. + */ + parentId?: string; + } + export interface Params$Resource$Globalorganizationoperations$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; + /** + * Parent ID for this request. + */ + parentId?: string; + } + + export class Resource$Globalpublicdelegatedprefixes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.globalPublicDelegatedPrefixes.delete + * @desc Deletes the specified global PublicDelegatedPrefix. + * @alias compute.globalPublicDelegatedPrefixes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicDelegatedPrefix Name of the PublicDelegatedPrefix resource to delete. + * @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$Globalpublicdelegatedprefixes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Globalpublicdelegatedprefixes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Globalpublicdelegatedprefixes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Globalpublicdelegatedprefixes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalpublicdelegatedprefixes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalpublicdelegatedprefixes$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}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalPublicDelegatedPrefixes.get + * @desc Returns the specified global PublicDelegatedPrefix resource. + * @alias compute.globalPublicDelegatedPrefixes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicDelegatedPrefix Name of the PublicDelegatedPrefix resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Globalpublicdelegatedprefixes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Globalpublicdelegatedprefixes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalpublicdelegatedprefixes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globalpublicdelegatedprefixes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalpublicdelegatedprefixes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalpublicdelegatedprefixes$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}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalPublicDelegatedPrefixes.insert + * @desc Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request. + * @alias compute.globalPublicDelegatedPrefixes.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 {().PublicDelegatedPrefix} params.resource Request body data + * @param {object} [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$Globalpublicdelegatedprefixes$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Globalpublicdelegatedprefixes$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Globalpublicdelegatedprefixes$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Globalpublicdelegatedprefixes$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalpublicdelegatedprefixes$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalpublicdelegatedprefixes$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}/global/publicDelegatedPrefixes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.globalPublicDelegatedPrefixes.list + * @desc Lists the global PublicDelegatedPrefixes for a project. + * @alias compute.globalPublicDelegatedPrefixes.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$Globalpublicdelegatedprefixes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Globalpublicdelegatedprefixes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Globalpublicdelegatedprefixes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Globalpublicdelegatedprefixes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalpublicdelegatedprefixes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalpublicdelegatedprefixes$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}/global/publicDelegatedPrefixes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.globalPublicDelegatedPrefixes.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicDelegatedPrefix Name of the PublicDelegatedPrefix resource to patch. + * @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 {().PublicDelegatedPrefix} params.resource Request body data + * @param {object} [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$Globalpublicdelegatedprefixes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Globalpublicdelegatedprefixes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Globalpublicdelegatedprefixes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Globalpublicdelegatedprefixes$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalpublicdelegatedprefixes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalpublicdelegatedprefixes$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}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Globalpublicdelegatedprefixes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to delete. + */ + publicDelegatedPrefix?: 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$Globalpublicdelegatedprefixes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to return. + */ + publicDelegatedPrefix?: string; + } + export interface Params$Resource$Globalpublicdelegatedprefixes$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublicDelegatedPrefix; + } + export interface Params$Resource$Globalpublicdelegatedprefixes$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$Globalpublicdelegatedprefixes$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to patch. + */ + publicDelegatedPrefix?: 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$PublicDelegatedPrefix; + } + + export class Resource$Healthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.healthChecks.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Healthchecks$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Healthchecks$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/healthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.delete + * @desc Deletes the specified HealthCheck resource. + * @alias compute.healthChecks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Healthchecks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Healthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Healthchecks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Healthchecks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$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}/global/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.get + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @alias compute.healthChecks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck 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 + */ + get( + params?: Params$Resource$Healthchecks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Healthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Healthchecks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Healthchecks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Healthchecks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$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}/global/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.insert + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.healthChecks.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 {().HealthCheck} params.resource Request body data + * @param {object} [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$Healthchecks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Healthchecks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Healthchecks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Healthchecks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$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}/global/healthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.list + * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @alias compute.healthChecks.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$Healthchecks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Healthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Healthchecks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Healthchecks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$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}/global/healthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.healthChecks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheck} params.resource Request body data + * @param {object} [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$Healthchecks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Healthchecks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Healthchecks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Healthchecks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$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}/global/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.healthChecks.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.resource Request body data + * @param {object} [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$Healthchecks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Healthchecks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Healthchecks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Healthchecks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$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/alpha/projects/{project}/global/healthChecks/{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); + } + } + + /** + * compute.healthChecks.update + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.healthChecks.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck 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 {().HealthCheck} params.resource Request body data + * @param {object} [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$Healthchecks$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Healthchecks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Healthchecks$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Healthchecks$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$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}/global/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Healthchecks$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } + export interface Params$Resource$Healthchecks$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to delete. + */ + healthCheck?: 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$Healthchecks$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to return. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Healthchecks$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + export interface Params$Resource$Healthchecks$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$Healthchecks$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to patch. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + export interface Params$Resource$Healthchecks$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Healthchecks$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to update. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + + export class Resource$Httphealthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.httpHealthChecks.delete + * @desc Deletes the specified HttpHealthCheck resource. + * @alias compute.httpHealthChecks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpHealthCheck Name of the HttpHealthCheck resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Httphealthchecks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Httphealthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Httphealthchecks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Httphealthchecks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httphealthchecks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httphealthchecks$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}/global/httpHealthChecks/{httpHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpHealthChecks.get + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. + * @alias compute.httpHealthChecks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpHealthCheck Name of the HttpHealthCheck 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 + */ + get( + params?: Params$Resource$Httphealthchecks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Httphealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Httphealthchecks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Httphealthchecks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httphealthchecks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httphealthchecks$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}/global/httpHealthChecks/{httpHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpHealthChecks.insert + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. + * @alias compute.httpHealthChecks.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 {().HttpHealthCheck} params.resource Request body data + * @param {object} [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$Httphealthchecks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Httphealthchecks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Httphealthchecks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Httphealthchecks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httphealthchecks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httphealthchecks$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}/global/httpHealthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpHealthChecks.list + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. + * @alias compute.httpHealthChecks.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$Httphealthchecks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Httphealthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Httphealthchecks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Httphealthchecks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httphealthchecks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httphealthchecks$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}/global/httpHealthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.httpHealthChecks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpHealthCheck Name of the HttpHealthCheck resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HttpHealthCheck} params.resource Request body data + * @param {object} [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$Httphealthchecks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Httphealthchecks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Httphealthchecks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Httphealthchecks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httphealthchecks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httphealthchecks$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}/global/httpHealthChecks/{httpHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpHealthChecks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.httpHealthChecks.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.resource Request body data + * @param {object} [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$Httphealthchecks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Httphealthchecks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Httphealthchecks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Httphealthchecks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httphealthchecks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httphealthchecks$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/alpha/projects/{project}/global/httpHealthChecks/{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); + } + } + + /** + * compute.httpHealthChecks.update + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. + * @alias compute.httpHealthChecks.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpHealthCheck Name of the HttpHealthCheck 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 {().HttpHealthCheck} params.resource Request body data + * @param {object} [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$Httphealthchecks$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Httphealthchecks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Httphealthchecks$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Httphealthchecks$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httphealthchecks$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httphealthchecks$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}/global/httpHealthChecks/{httpHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'httpHealthCheck'], + pathParams: ['httpHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Httphealthchecks$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpHealthCheck resource to delete. + */ + httpHealthCheck?: 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$Httphealthchecks$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpHealthCheck resource to return. + */ + httpHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Httphealthchecks$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpHealthCheck; + } + export interface Params$Resource$Httphealthchecks$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$Httphealthchecks$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpHealthCheck resource to patch. + */ + httpHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpHealthCheck; + } + export interface Params$Resource$Httphealthchecks$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Httphealthchecks$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpHealthCheck resource to update. + */ + httpHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpHealthCheck; + } + + export class Resource$Httpshealthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.httpsHealthChecks.delete + * @desc Deletes the specified HttpsHealthCheck resource. + * @alias compute.httpsHealthChecks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpsHealthCheck Name of the HttpsHealthCheck resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Httpshealthchecks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Httpshealthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Httpshealthchecks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Httpshealthchecks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httpshealthchecks$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}/global/httpsHealthChecks/{httpsHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpsHealthChecks.get + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. + * @alias compute.httpsHealthChecks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpsHealthCheck Name of the HttpsHealthCheck 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 + */ + get( + params?: Params$Resource$Httpshealthchecks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Httpshealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Httpshealthchecks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Httpshealthchecks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httpshealthchecks$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}/global/httpsHealthChecks/{httpsHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpsHealthChecks.insert + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @alias compute.httpsHealthChecks.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 {().HttpsHealthCheck} params.resource Request body data + * @param {object} [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$Httpshealthchecks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Httpshealthchecks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Httpshealthchecks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Httpshealthchecks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httpshealthchecks$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}/global/httpsHealthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpsHealthChecks.list + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. + * @alias compute.httpsHealthChecks.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$Httpshealthchecks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Httpshealthchecks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Httpshealthchecks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Httpshealthchecks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httpshealthchecks$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}/global/httpsHealthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.httpsHealthChecks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpsHealthCheck Name of the HttpsHealthCheck resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HttpsHealthCheck} params.resource Request body data + * @param {object} [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$Httpshealthchecks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Httpshealthchecks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Httpshealthchecks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Httpshealthchecks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httpshealthchecks$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}/global/httpsHealthChecks/{httpsHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.httpsHealthChecks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.httpsHealthChecks.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.resource Request body data + * @param {object} [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$Httpshealthchecks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Httpshealthchecks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Httpshealthchecks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Httpshealthchecks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httpshealthchecks$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/alpha/projects/{project}/global/httpsHealthChecks/{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); + } + } + + /** + * compute.httpsHealthChecks.update + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @alias compute.httpsHealthChecks.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.httpsHealthCheck Name of the HttpsHealthCheck 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 {().HttpsHealthCheck} params.resource Request body data + * @param {object} [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$Httpshealthchecks$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Httpshealthchecks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Httpshealthchecks$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Httpshealthchecks$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Httpshealthchecks$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Httpshealthchecks$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}/global/httpsHealthChecks/{httpsHealthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'httpsHealthCheck'], + pathParams: ['httpsHealthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Httpshealthchecks$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpsHealthCheck resource to delete. + */ + httpsHealthCheck?: 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$Httpshealthchecks$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpsHealthCheck resource to return. + */ + httpsHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Httpshealthchecks$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpsHealthCheck; + } + export interface Params$Resource$Httpshealthchecks$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$Httpshealthchecks$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpsHealthCheck resource to patch. + */ + httpsHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpsHealthCheck; + } + export interface Params$Resource$Httpshealthchecks$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Httpshealthchecks$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HttpsHealthCheck resource to update. + */ + httpsHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpsHealthCheck; + } + + export class Resource$Images { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.images.delete + * @desc Deletes the specified image. + * @alias compute.images.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.image Name of the image resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Images$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Images$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Images$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Images$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Images$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$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}/global/images/{image}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'image'], + pathParams: ['image', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.images.deprecate + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.image Image name. + * @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 {().DeprecationStatus} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deprecate( + params?: Params$Resource$Images$Deprecate, + options?: MethodOptions + ): GaxiosPromise; + deprecate( + params: Params$Resource$Images$Deprecate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deprecate( + params: Params$Resource$Images$Deprecate, + callback: BodyResponseCallback + ): void; + deprecate(callback: BodyResponseCallback): void; + deprecate( + paramsOrCallback?: + | Params$Resource$Images$Deprecate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Images$Deprecate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Deprecate; + 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}/global/images/{image}/deprecate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'image'], + pathParams: ['image', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.images.get + * @desc Returns the specified image. Gets a list of available images by making a list() request. + * @alias compute.images.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.image Name of the image 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 + */ + get( + params?: Params$Resource$Images$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Images$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Images$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Images$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Images$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$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}/global/images/{image}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'image'], + pathParams: ['image', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.images.getFromFamily + * @desc Returns the latest image that is part of an image family and is not deprecated. + * @alias compute.images.getFromFamily + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.family Name of the image family to search for. + * @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 + */ + getFromFamily( + params?: Params$Resource$Images$Getfromfamily, + options?: MethodOptions + ): GaxiosPromise; + getFromFamily( + params: Params$Resource$Images$Getfromfamily, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getFromFamily( + params: Params$Resource$Images$Getfromfamily, + callback: BodyResponseCallback + ): void; + getFromFamily(callback: BodyResponseCallback): void; + getFromFamily( + paramsOrCallback?: + | Params$Resource$Images$Getfromfamily + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Images$Getfromfamily; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Getfromfamily; + 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}/global/images/family/{family}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'family'], + pathParams: ['family', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.images.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.images.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$Images$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Images$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Images$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$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/alpha/projects/{project}/global/images/{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.images.insert + * @desc Creates an image in the specified project using the data included in the request. + * @alias compute.images.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.forceCreate Force image creation if true. + * @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 {().Image} params.resource Request body data + * @param {object} [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$Images$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Images$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Images$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Images$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Images$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$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}/global/images' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.images.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$Images$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Images$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Images$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Images$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Images$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$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}/global/images' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.images.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.images.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.resource Request body data + * @param {object} [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$Images$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Images$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Images$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$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/alpha/projects/{project}/global/images/{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.images.setLabels + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.images.setLabels + * @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 {().GlobalSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Images$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Images$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Images$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Images$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Images$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Setlabels; + 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}/global/images/{resource}/setLabels' + ).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.images.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.images.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.resource Request body data + * @param {object} [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$Images$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Images$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Images$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Images$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Images$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$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/alpha/projects/{project}/global/images/{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$Images$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the image resource to delete. + */ + image?: 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$Images$Deprecate extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Image name. + */ + image?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeprecationStatus; + } + export interface Params$Resource$Images$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the image resource to return. + */ + image?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Images$Getfromfamily + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the image family to search for. + */ + family?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Images$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$Images$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Force image creation if true. + */ + forceCreate?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Image; + } + export interface Params$Resource$Images$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$Images$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$Images$Setlabels extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Images$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$Instancegroupmanagers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.instanceGroupManagers.abandonInstances + * @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 {().InstanceGroupManagersAbandonInstancesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + abandonInstances( + params?: Params$Resource$Instancegroupmanagers$Abandoninstances, + options?: MethodOptions + ): GaxiosPromise; + abandonInstances( + params: Params$Resource$Instancegroupmanagers$Abandoninstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abandonInstances( + params: Params$Resource$Instancegroupmanagers$Abandoninstances, + callback: BodyResponseCallback + ): void; + abandonInstances(callback: BodyResponseCallback): void; + abandonInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Abandoninstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Abandoninstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Abandoninstances; + 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}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' + ).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.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Instancegroupmanagers$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Instancegroupmanagers$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instancegroupmanagers$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/instanceGroupManagers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.instanceGroupManagers.applyUpdatesToInstances + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. + * @alias compute.instanceGroupManagers.applyUpdatesToInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group, 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. Should conform to RFC1035. + * @param {().InstanceGroupManagersApplyUpdatesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + applyUpdatesToInstances( + params?: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + options?: MethodOptions + ): GaxiosPromise; + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Applyupdatestoinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' + ).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.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. 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. 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.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createInstances( + params?: Params$Resource$Instancegroupmanagers$Createinstances, + options?: MethodOptions + ): GaxiosPromise; + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, + callback: BodyResponseCallback + ): void; + createInstances(callback: BodyResponseCallback): void; + createInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Createinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Createinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances' + ).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.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. + * @alias compute.instanceGroupManagers.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @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 {object} [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, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instancegroupmanagers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instancegroupmanagers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @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.resource Request body data + * @param {object} [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/alpha/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.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.resource Request body data + * @param {object} [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/alpha/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. + * @alias compute.instanceGroupManagers.get + * @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.zone The name of the zone where the managed instance group is located. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Instancegroupmanagers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instancegroupmanagers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancegroupmanagers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' + ).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.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. + * @alias compute.instanceGroupManagers.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.zone The name of the zone where you want to create the managed instance group. + * @param {().InstanceGroupManager} params.resource Request body data + * @param {object} [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$Instancegroupmanagers$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instancegroupmanagers$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instancegroupmanagers$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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}/zones/{zone}/instanceGroupManagers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroupManagers.list + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. + * @alias compute.instanceGroupManagers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone where the managed instance group is located. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Instancegroupmanagers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instancegroupmanagers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instancegroupmanagers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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}/zones/{zone}/instanceGroupManagers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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/alpha/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. + * @alias compute.instanceGroupManagers.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.zone The name of the zone where the managed instance group is located. + * @param {object} [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$Instancegroupmanagers$Listmanagedinstances, + options?: MethodOptions + ): GaxiosPromise; + listManagedInstances( + params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, + options: + | MethodOptions + | BodyResponseCallback< + Schema$InstanceGroupManagersListManagedInstancesResponse + >, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListManagedInstancesResponse + > + ): void; + listManagedInstances( + params: Params$Resource$Instancegroupmanagers$Listmanagedinstances, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListManagedInstancesResponse + > + ): void; + listManagedInstances( + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListManagedInstancesResponse + > + ): void; + listManagedInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Listmanagedinstances + | BodyResponseCallback< + Schema$InstanceGroupManagersListManagedInstancesResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$InstanceGroupManagersListManagedInstancesResponse + >, + callback?: BodyResponseCallback< + Schema$InstanceGroupManagersListManagedInstancesResponse + > + ): void | GaxiosPromise< + Schema$InstanceGroupManagersListManagedInstancesResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Listmanagedinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$InstanceGroupManagersListManagedInstancesResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$InstanceGroupManagersListManagedInstancesResponse + >(parameters); + } + } + + /** + * 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/alpha/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. + * @alias compute.instanceGroupManagers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the instance group manager. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where you want to create the managed instance group. + * @param {().InstanceGroupManager} params.resource Request body data + * @param {object} [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$Instancegroupmanagers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Instancegroupmanagers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Instancegroupmanagers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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}/instanceGroupManagers/{instanceGroupManager}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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.resource Request body data + * @param {object} [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/alpha/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. + * @alias compute.instanceGroupManagers.recreateInstances + * @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 {().InstanceGroupManagersRecreateInstancesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + recreateInstances( + params?: Params$Resource$Instancegroupmanagers$Recreateinstances, + options?: MethodOptions + ): GaxiosPromise; + recreateInstances( + params: Params$Resource$Instancegroupmanagers$Recreateinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recreateInstances( + params: Params$Resource$Instancegroupmanagers$Recreateinstances, + callback: BodyResponseCallback + ): void; + recreateInstances(callback: BodyResponseCallback): void; + recreateInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Recreateinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Recreateinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Recreateinstances; + 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}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' + ).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.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. + * @alias compute.instanceGroupManagers.resize + * @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 {integer} params.size The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. + * @param {string} params.zone The name of the zone where the managed instance group is located. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resize( + params?: Params$Resource$Instancegroupmanagers$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Instancegroupmanagers$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Instancegroupmanagers$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Resize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Resize; + 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}/instanceGroupManagers/{instanceGroupManager}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager', 'size'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instanceGroupManagers.resizeAdvanced + * @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 {().InstanceGroupManagersResizeAdvancedRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resizeAdvanced( + params?: Params$Resource$Instancegroupmanagers$Resizeadvanced, + options?: MethodOptions + ): GaxiosPromise; + resizeAdvanced( + params: Params$Resource$Instancegroupmanagers$Resizeadvanced, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resizeAdvanced( + params: Params$Resource$Instancegroupmanagers$Resizeadvanced, + callback: BodyResponseCallback + ): void; + resizeAdvanced(callback: BodyResponseCallback): void; + resizeAdvanced( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Resizeadvanced + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Resizeadvanced; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Resizeadvanced; + 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}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' + ).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.setAutoHealingPolicies + * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. + * @alias compute.instanceGroupManagers.setAutoHealingPolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the instance group manager. + * @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 {().InstanceGroupManagersSetAutoHealingRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setAutoHealingPolicies( + params?: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + options?: MethodOptions + ): GaxiosPromise; + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Setautohealingpolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; + 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}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + ).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.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. + * @alias compute.instanceGroupManagers.setInstanceTemplate + * @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 {().InstanceGroupManagersSetInstanceTemplateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setInstanceTemplate( + params?: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + options?: MethodOptions + ): GaxiosPromise; + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + callback: BodyResponseCallback + ): void; + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Setinstancetemplate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + 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}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + ).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.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. + * @alias compute.instanceGroupManagers.setTargetPools + * @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 {().InstanceGroupManagersSetTargetPoolsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setTargetPools( + params?: Params$Resource$Instancegroupmanagers$Settargetpools, + options?: MethodOptions + ): GaxiosPromise; + setTargetPools( + params: Params$Resource$Instancegroupmanagers$Settargetpools, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTargetPools( + params: Params$Resource$Instancegroupmanagers$Settargetpools, + callback: BodyResponseCallback + ): void; + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Settargetpools + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Settargetpools; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Settargetpools; + 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}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + ).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.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.instanceGroupManagers.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Instancegroupmanagers$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Instancegroupmanagers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instancegroupmanagers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instanceGroupManagers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the instance group manager. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where you want to create the managed instance group. + * @param {().InstanceGroupManager} params.resource Request body data + * @param {object} [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$Instancegroupmanagers$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Instancegroupmanagers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Instancegroupmanagers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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}/instanceGroupManagers/{instanceGroupManager}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + 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.resource Request body data + * @param {object} [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/alpha/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 + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + 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. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersAbandonInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group, should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. Should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersApplyUpdatesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Createinstances + extends StandardParameters { + /** + * 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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group to delete. + */ + 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. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Deleteinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + 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. + */ + zone?: string; + + /** + * Request body metadata + */ + 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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$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; + /** + * The name of the zone where you want to create the managed instance group. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManager; + } + export interface Params$Resource$Instancegroupmanagers$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. + */ + 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 { + /** + * 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. + */ + 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. + */ + order_by?: 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. + */ + 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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group manager. + */ + 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 you want to create the managed instance group. + */ + zone?: string; + + /** + * Request body metadata + */ + 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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + 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. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersRecreateInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Resize + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + 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 number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. + */ + size?: number; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagers$Resizeadvanced + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + 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. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersResizeAdvancedRequest; + } + export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group manager. + */ + 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. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSetAutoHealingRequest; + } + export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + 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. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSetInstanceTemplateRequest; + } + export interface Params$Resource$Instancegroupmanagers$Settargetpools + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + 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. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSetTargetPoolsRequest; + } + export interface Params$Resource$Instancegroupmanagers$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Instancegroupmanagers$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group manager. + */ + 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 you want to create the managed instance group. + */ + zone?: string; + + /** + * Request body metadata + */ + 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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.instanceGroups.addInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup The name of the instance group where you are adding instances. + * @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 instance group is located. + * @param {().InstanceGroupsAddInstancesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addInstances( + params?: Params$Resource$Instancegroups$Addinstances, + options?: MethodOptions + ): GaxiosPromise; + addInstances( + params: Params$Resource$Instancegroups$Addinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addInstances( + params: Params$Resource$Instancegroups$Addinstances, + callback: BodyResponseCallback + ): void; + addInstances(callback: BodyResponseCallback): void; + addInstances( + paramsOrCallback?: + | Params$Resource$Instancegroups$Addinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Addinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$Addinstances; + 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}/instanceGroups/{instanceGroup}/addInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroups.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Instancegroups$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Instancegroups$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instancegroups$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Instancegroups$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/instanceGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instanceGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup The name of the 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 instance group is located. + * @param {object} [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$Instancegroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instancegroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instancegroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instancegroups$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$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}/zones/{zone}/instanceGroups/{instanceGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroups.get + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. + * @alias compute.instanceGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup The name of the instance group. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone where the instance group is located. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Instancegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instancegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instancegroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$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}/zones/{zone}/instanceGroups/{instanceGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroups.insert + * @desc Creates an instance group in the specified project using the parameters that are included in the request. + * @alias compute.instanceGroups.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.zone The name of the zone where you want to create the instance group. + * @param {().InstanceGroup} params.resource Request body data + * @param {object} [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$Instancegroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instancegroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instancegroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instancegroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$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}/zones/{zone}/instanceGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroups.list + * @desc Retrieves the list of instance groups that are located in the specified project and zone. + * @alias compute.instanceGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone where the instance group is located. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Instancegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instancegroups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instancegroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Instancegroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$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}/zones/{zone}/instanceGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroups.listInstances + * @desc Lists the instances in the specified instance group. + * @alias compute.instanceGroups.listInstances + * @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.instanceGroup The name of the instance group from which you want to generate a list of included instances. + * @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 instance group is located. + * @param {().InstanceGroupsListInstancesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listInstances( + params?: Params$Resource$Instancegroups$Listinstances, + options?: MethodOptions + ): GaxiosPromise; + listInstances( + params: Params$Resource$Instancegroups$Listinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listInstances( + params: Params$Resource$Instancegroups$Listinstances, + callback: BodyResponseCallback + ): void; + listInstances( + callback: BodyResponseCallback + ): void; + listInstances( + paramsOrCallback?: + | Params$Resource$Instancegroups$Listinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Listinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$Listinstances; + 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}/instanceGroups/{instanceGroup}/listInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instanceGroups.removeInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup The name of the instance group where the specified instances will be removed. + * @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 instance group is located. + * @param {().InstanceGroupsRemoveInstancesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeInstances( + params?: Params$Resource$Instancegroups$Removeinstances, + options?: MethodOptions + ): GaxiosPromise; + removeInstances( + params: Params$Resource$Instancegroups$Removeinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeInstances( + params: Params$Resource$Instancegroups$Removeinstances, + callback: BodyResponseCallback + ): void; + removeInstances(callback: BodyResponseCallback): void; + removeInstances( + paramsOrCallback?: + | Params$Resource$Instancegroups$Removeinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Removeinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$Removeinstances; + 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}/instanceGroups/{instanceGroup}/removeInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroups.setNamedPorts + * @desc Sets the named ports for the specified instance group. + * @alias compute.instanceGroups.setNamedPorts + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup The name of the instance group where the named ports are updated. + * @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 instance group is located. + * @param {().InstanceGroupsSetNamedPortsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setNamedPorts( + params?: Params$Resource$Instancegroups$Setnamedports, + options?: MethodOptions + ): GaxiosPromise; + setNamedPorts( + params: Params$Resource$Instancegroups$Setnamedports, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setNamedPorts( + params: Params$Resource$Instancegroups$Setnamedports, + callback: BodyResponseCallback + ): void; + setNamedPorts(callback: BodyResponseCallback): void; + setNamedPorts( + paramsOrCallback?: + | Params$Resource$Instancegroups$Setnamedports + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Setnamedports; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$Setnamedports; + 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}/instanceGroups/{instanceGroup}/setNamedPorts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroups.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.instanceGroups.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Instancegroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instancegroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instancegroups$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroups$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/alpha/projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instancegroups$Addinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group where you are adding instances. + */ + instanceGroup?: 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 instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsAddInstancesRequest; + } + export interface Params$Resource$Instancegroups$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Instancegroups$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group to delete. + */ + instanceGroup?: 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 instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroups$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; + /** + * The name of the zone where you want to create the instance group. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroup; + } + export interface Params$Resource$Instancegroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the instance group is located. + */ + zone?: string; + } + export interface Params$Resource$Instancegroups$Listinstances + 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 instance group from which you want to generate a list of included instances. + */ + instanceGroup?: 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 instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsListInstancesRequest; + } + export interface Params$Resource$Instancegroups$Removeinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group where the specified instances will be removed. + */ + instanceGroup?: 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 instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsRemoveInstancesRequest; + } + export interface Params$Resource$Instancegroups$Setnamedports + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group where the named ports are updated. + */ + instanceGroup?: 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 instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupsSetNamedPortsRequest; + } + export interface Params$Resource$Instancegroups$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.instances.addAccessConfig + * @desc Adds an access config to an instance's network interface. + * @alias compute.instances.addAccessConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The instance name for this request. + * @param {string} params.networkInterface The name of the network interface to add to this instance. + * @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 {().AccessConfig} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addAccessConfig( + params?: Params$Resource$Instances$Addaccessconfig, + options?: MethodOptions + ): GaxiosPromise; + addAccessConfig( + params: Params$Resource$Instances$Addaccessconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addAccessConfig( + params: Params$Resource$Instances$Addaccessconfig, + callback: BodyResponseCallback + ): void; + addAccessConfig(callback: BodyResponseCallback): void; + addAccessConfig( + paramsOrCallback?: + | Params$Resource$Instances$Addaccessconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addaccessconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Addaccessconfig; + 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}/addAccessConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.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. + * @alias compute.instances.addResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The instance name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().InstancesAddResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addResourcePolicies( + params?: Params$Resource$Instances$Addresourcepolicies, + options?: MethodOptions + ): GaxiosPromise; + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addResourcePolicies( + params: Params$Resource$Instances$Addresourcepolicies, + callback: BodyResponseCallback + ): void; + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( + paramsOrCallback?: + | Params$Resource$Instances$Addresourcepolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Addresourcepolicies; + 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}/addResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Instances$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instances$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Instances$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/aggregated/instances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.attachDisk + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.forceAttach Whether to force attach the disk even if it's currently attached to another instance. + * @param {string} params.instance The instance name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().AttachedDisk} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + attachDisk( + params?: Params$Resource$Instances$Attachdisk, + options?: MethodOptions + ): GaxiosPromise; + attachDisk( + params: Params$Resource$Instances$Attachdisk, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + attachDisk( + params: Params$Resource$Instances$Attachdisk, + callback: BodyResponseCallback + ): void; + attachDisk(callback: BodyResponseCallback): void; + attachDisk( + paramsOrCallback?: + | Params$Resource$Instances$Attachdisk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Attachdisk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Attachdisk; + 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}/attachDisk' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.delete + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. + * @alias compute.instances.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Instances$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instances$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instances$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instances$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.deleteAccessConfig + * @desc Deletes an access config from an instance's network interface. + * @alias compute.instances.deleteAccessConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accessConfig The name of the access config to delete. + * @param {string} params.instance The instance name for this request. + * @param {string} params.networkInterface The name of the network interface. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteAccessConfig( + params?: Params$Resource$Instances$Deleteaccessconfig, + options?: MethodOptions + ): GaxiosPromise; + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteAccessConfig( + params: Params$Resource$Instances$Deleteaccessconfig, + callback: BodyResponseCallback + ): void; + deleteAccessConfig(callback: BodyResponseCallback): void; + deleteAccessConfig( + paramsOrCallback?: + | Params$Resource$Instances$Deleteaccessconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Deleteaccessconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Deleteaccessconfig; + 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}/deleteAccessConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'instance', + 'accessConfig', + 'networkInterface', + ], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.detachDisk + * @desc Detaches a disk from an instance. + * @alias compute.instances.detachDisk + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.deviceName The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. + * @param {string} params.instance Instance name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + detachDisk( + params?: Params$Resource$Instances$Detachdisk, + options?: MethodOptions + ): GaxiosPromise; + detachDisk( + params: Params$Resource$Instances$Detachdisk, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detachDisk( + params: Params$Resource$Instances$Detachdisk, + callback: BodyResponseCallback + ): void; + detachDisk(callback: BodyResponseCallback): void; + detachDisk( + paramsOrCallback?: + | Params$Resource$Instances$Detachdisk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Detachdisk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Detachdisk; + 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}/detachDisk' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'deviceName'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.get + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. + * @alias compute.instances.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Instances$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instances$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instances$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instances$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.getEffectiveFirewalls + * @desc Returns effective firewalls applied to an interface of the instance. + * @alias compute.instances.getEffectiveFirewalls + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.networkInterface The name of the network interface to get the effective firewalls. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getEffectiveFirewalls( + params?: Params$Resource$Instances$Geteffectivefirewalls, + options?: MethodOptions + ): GaxiosPromise; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse + > + ): void; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + callback: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse + > + ): void; + getEffectiveFirewalls( + callback: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse + > + ): void; + getEffectiveFirewalls( + paramsOrCallback?: + | Params$Resource$Instances$Geteffectivefirewalls + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Geteffectivefirewalls; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Geteffectivefirewalls; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.instances.getGuestAttributes + * @desc Returns the specified guest attributes entry. + * @alias compute.instances.getGuestAttributes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.queryPath Specifies the guest attributes path to be queried. + * @param {string=} params.variableKey Specifies the key for the guest attributes entry. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getGuestAttributes( + params?: Params$Resource$Instances$Getguestattributes, + options?: MethodOptions + ): GaxiosPromise; + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, + callback: BodyResponseCallback + ): void; + getGuestAttributes( + callback: BodyResponseCallback + ): void; + getGuestAttributes( + paramsOrCallback?: + | Params$Resource$Instances$Getguestattributes + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getguestattributes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getguestattributes; + 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}/getGuestAttributes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.instances.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 {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Instances$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instances$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$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/alpha/projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.getSerialPortOutput + * @desc Returns the last 1 MB of serial port output from the specified instance. + * @alias compute.instances.getSerialPortOutput + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {integer=} params.port Specifies which COM or serial port to retrieve data from. + * @param {string} params.project Project ID for this request. + * @param {string=} params.start Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getSerialPortOutput( + params?: Params$Resource$Instances$Getserialportoutput, + options?: MethodOptions + ): GaxiosPromise; + getSerialPortOutput( + params: Params$Resource$Instances$Getserialportoutput, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSerialPortOutput( + params: Params$Resource$Instances$Getserialportoutput, + callback: BodyResponseCallback + ): void; + getSerialPortOutput( + callback: BodyResponseCallback + ): void; + getSerialPortOutput( + paramsOrCallback?: + | Params$Resource$Instances$Getserialportoutput + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getserialportoutput; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getserialportoutput; + 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}/serialPort' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.getShieldedInstanceIdentity + * @desc Returns the Shielded Instance Identity of an instance + * @alias compute.instances.getShieldedInstanceIdentity + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name or id of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getShieldedInstanceIdentity( + params?: Params$Resource$Instances$Getshieldedinstanceidentity, + options?: MethodOptions + ): GaxiosPromise; + getShieldedInstanceIdentity( + params: Params$Resource$Instances$Getshieldedinstanceidentity, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getShieldedInstanceIdentity( + params: Params$Resource$Instances$Getshieldedinstanceidentity, + callback: BodyResponseCallback + ): void; + getShieldedInstanceIdentity( + callback: BodyResponseCallback + ): void; + getShieldedInstanceIdentity( + paramsOrCallback?: + | Params$Resource$Instances$Getshieldedinstanceidentity + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getshieldedinstanceidentity; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getshieldedinstanceidentity; + 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}/getShieldedInstanceIdentity' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.getShieldedVmIdentity + * @desc Returns the Shielded VM Identity of an instance + * @alias compute.instances.getShieldedVmIdentity + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getShieldedVmIdentity( + params?: Params$Resource$Instances$Getshieldedvmidentity, + options?: MethodOptions + ): GaxiosPromise; + getShieldedVmIdentity( + params: Params$Resource$Instances$Getshieldedvmidentity, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getShieldedVmIdentity( + params: Params$Resource$Instances$Getshieldedvmidentity, + callback: BodyResponseCallback + ): void; + getShieldedVmIdentity( + callback: BodyResponseCallback + ): void; + getShieldedVmIdentity( + paramsOrCallback?: + | Params$Resource$Instances$Getshieldedvmidentity + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getshieldedvmidentity; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getshieldedvmidentity; + 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}/getShieldedVmIdentity' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.insert + * @desc Creates an instance resource in the specified project using the data included in the request. + * @alias compute.instances.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.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.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Instances$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instances$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instances$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instances$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.list + * @desc Retrieves the list of instances contained within the specified zone. + * @alias compute.instances.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Instances$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instances$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instances$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Instances$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.listReferrers + * @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.instance Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listReferrers( + params?: Params$Resource$Instances$Listreferrers, + options?: MethodOptions + ): GaxiosPromise; + listReferrers( + params: Params$Resource$Instances$Listreferrers, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listReferrers( + params: Params$Resource$Instances$Listreferrers, + callback: BodyResponseCallback + ): void; + listReferrers( + callback: BodyResponseCallback + ): void; + listReferrers( + paramsOrCallback?: + | Params$Resource$Instances$Listreferrers + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Listreferrers; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Listreferrers; + 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}/referrers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.removeResourcePolicies + * @desc Removes resource policies from an instance. + * @alias compute.instances.removeResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The instance name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().InstancesRemoveResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeResourcePolicies( + params?: Params$Resource$Instances$Removeresourcepolicies, + options?: MethodOptions + ): GaxiosPromise; + removeResourcePolicies( + params: Params$Resource$Instances$Removeresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + params: Params$Resource$Instances$Removeresourcepolicies, + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + paramsOrCallback?: + | Params$Resource$Instances$Removeresourcepolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Removeresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Removeresourcepolicies; + 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}/removeResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.reset + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + reset( + params?: Params$Resource$Instances$Reset, + options?: MethodOptions + ): GaxiosPromise; + reset( + params: Params$Resource$Instances$Reset, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Instances$Reset, + callback: BodyResponseCallback + ): void; + reset(callback: BodyResponseCallback): void; + reset( + paramsOrCallback?: + | Params$Resource$Instances$Reset + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Reset; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Reset; + 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}/reset' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.resume + * @desc Resumes an instance that was suspended using the instances().suspend method. + * @alias compute.instances.resume + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to resume. + * @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 {().InstancesResumeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resume( + params?: Params$Resource$Instances$Resume, + options?: MethodOptions + ): GaxiosPromise; + resume( + params: Params$Resource$Instances$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Instances$Resume, + callback: BodyResponseCallback + ): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: + | Params$Resource$Instances$Resume + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Resume; + 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}/resume' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setDeletionProtection + * @desc Sets deletion protection on the instance. + * @alias compute.instances.setDeletionProtection + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.deletionProtection Whether the resource should be protected against deletion. + * @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.resource_ Name or id of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setDeletionProtection( + params?: Params$Resource$Instances$Setdeletionprotection, + options?: MethodOptions + ): GaxiosPromise; + setDeletionProtection( + params: Params$Resource$Instances$Setdeletionprotection, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setDeletionProtection( + params: Params$Resource$Instances$Setdeletionprotection, + callback: BodyResponseCallback + ): void; + setDeletionProtection( + callback: BodyResponseCallback + ): void; + setDeletionProtection( + paramsOrCallback?: + | Params$Resource$Instances$Setdeletionprotection + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setdeletionprotection; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setdeletionprotection; + 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/{resource}/setDeletionProtection' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setDiskAutoDelete + * @desc Sets the auto-delete flag for a disk attached to an instance. + * @alias compute.instances.setDiskAutoDelete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean} params.autoDelete Whether to auto-delete the disk when the instance is deleted. + * @param {string} params.deviceName The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. + * @param {string} params.instance The instance name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setDiskAutoDelete( + params?: Params$Resource$Instances$Setdiskautodelete, + options?: MethodOptions + ): GaxiosPromise; + setDiskAutoDelete( + params: Params$Resource$Instances$Setdiskautodelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setDiskAutoDelete( + params: Params$Resource$Instances$Setdiskautodelete, + callback: BodyResponseCallback + ): void; + setDiskAutoDelete(callback: BodyResponseCallback): void; + setDiskAutoDelete( + paramsOrCallback?: + | Params$Resource$Instances$Setdiskautodelete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setdiskautodelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setdiskautodelete; + 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}/setDiskAutoDelete' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'instance', + 'autoDelete', + 'deviceName', + ], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.instances.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 {string} params.zone The name of the zone for this request. + * @param {().ZoneSetPolicyRequest} params.resource Request body data + * @param {object} [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$Instances$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Instances$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$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/alpha/projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setLabels + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.instances.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().InstancesSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Instances$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Instances$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Instances$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Instances$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setlabels; + 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}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setMachineResources + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().InstancesSetMachineResourcesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setMachineResources( + params?: Params$Resource$Instances$Setmachineresources, + options?: MethodOptions + ): GaxiosPromise; + setMachineResources( + params: Params$Resource$Instances$Setmachineresources, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setMachineResources( + params: Params$Resource$Instances$Setmachineresources, + callback: BodyResponseCallback + ): void; + setMachineResources(callback: BodyResponseCallback): void; + setMachineResources( + paramsOrCallback?: + | Params$Resource$Instances$Setmachineresources + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setmachineresources; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setmachineresources; + 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}/setMachineResources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setMachineType + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. + * @alias compute.instances.setMachineType + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().InstancesSetMachineTypeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setMachineType( + params?: Params$Resource$Instances$Setmachinetype, + options?: MethodOptions + ): GaxiosPromise; + setMachineType( + params: Params$Resource$Instances$Setmachinetype, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setMachineType( + params: Params$Resource$Instances$Setmachinetype, + callback: BodyResponseCallback + ): void; + setMachineType(callback: BodyResponseCallback): void; + setMachineType( + paramsOrCallback?: + | Params$Resource$Instances$Setmachinetype + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setmachinetype; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setmachinetype; + 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}/setMachineType' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setMetadata + * @desc Sets metadata for the specified instance to the data included in the request. + * @alias compute.instances.setMetadata + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().Metadata} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setMetadata( + params?: Params$Resource$Instances$Setmetadata, + options?: MethodOptions + ): GaxiosPromise; + setMetadata( + params: Params$Resource$Instances$Setmetadata, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setMetadata( + params: Params$Resource$Instances$Setmetadata, + callback: BodyResponseCallback + ): void; + setMetadata(callback: BodyResponseCallback): void; + setMetadata( + paramsOrCallback?: + | Params$Resource$Instances$Setmetadata + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setmetadata; + 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}/setMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.setMinCpuPlatform + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().InstancesSetMinCpuPlatformRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setMinCpuPlatform( + params?: Params$Resource$Instances$Setmincpuplatform, + options?: MethodOptions + ): GaxiosPromise; + setMinCpuPlatform( + params: Params$Resource$Instances$Setmincpuplatform, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setMinCpuPlatform( + params: Params$Resource$Instances$Setmincpuplatform, + callback: BodyResponseCallback + ): void; + setMinCpuPlatform(callback: BodyResponseCallback): void; + setMinCpuPlatform( + paramsOrCallback?: + | Params$Resource$Instances$Setmincpuplatform + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setmincpuplatform; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setmincpuplatform; + 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}/setMinCpuPlatform' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setName + * @desc Sets name of an instance. + * @alias compute.instances.setName + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The instance name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().InstancesSetNameRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setName( + params?: Params$Resource$Instances$Setname, + options?: MethodOptions + ): GaxiosPromise; + setName( + params: Params$Resource$Instances$Setname, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setName( + params: Params$Resource$Instances$Setname, + callback: BodyResponseCallback + ): void; + setName(callback: BodyResponseCallback): void; + setName( + paramsOrCallback?: + | Params$Resource$Instances$Setname + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setname; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setname; + 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}/setName' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setScheduling + * @desc Sets an instance's scheduling options. + * @alias compute.instances.setScheduling + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Instance name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().Scheduling} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setScheduling( + params?: Params$Resource$Instances$Setscheduling, + options?: MethodOptions + ): GaxiosPromise; + setScheduling( + params: Params$Resource$Instances$Setscheduling, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setScheduling( + params: Params$Resource$Instances$Setscheduling, + callback: BodyResponseCallback + ): void; + setScheduling(callback: BodyResponseCallback): void; + setScheduling( + paramsOrCallback?: + | Params$Resource$Instances$Setscheduling + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setscheduling; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setscheduling; + 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}/setScheduling' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.setServiceAccount + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to start. + * @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 {().InstancesSetServiceAccountRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setServiceAccount( + params?: Params$Resource$Instances$Setserviceaccount, + options?: MethodOptions + ): GaxiosPromise; + setServiceAccount( + params: Params$Resource$Instances$Setserviceaccount, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setServiceAccount( + params: Params$Resource$Instances$Setserviceaccount, + callback: BodyResponseCallback + ): void; + setServiceAccount(callback: BodyResponseCallback): void; + setServiceAccount( + paramsOrCallback?: + | Params$Resource$Instances$Setserviceaccount + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setserviceaccount; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setserviceaccount; + 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}/setServiceAccount' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.setShieldedInstanceIntegrityPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name or id of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().ShieldedInstanceIntegrityPolicy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setShieldedInstanceIntegrityPolicy( + params?: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, + options?: MethodOptions + ): GaxiosPromise; + setShieldedInstanceIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setShieldedInstanceIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedinstanceintegritypolicy, + callback: BodyResponseCallback + ): void; + setShieldedInstanceIntegrityPolicy( + callback: BodyResponseCallback + ): void; + setShieldedInstanceIntegrityPolicy( + paramsOrCallback?: + | Params$Resource$Instances$Setshieldedinstanceintegritypolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setshieldedinstanceintegritypolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setshieldedinstanceintegritypolicy; + 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}/setShieldedInstanceIntegrityPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.setShieldedVmIntegrityPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().ShieldedVmIntegrityPolicy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setShieldedVmIntegrityPolicy( + params?: Params$Resource$Instances$Setshieldedvmintegritypolicy, + options?: MethodOptions + ): GaxiosPromise; + setShieldedVmIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedvmintegritypolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setShieldedVmIntegrityPolicy( + params: Params$Resource$Instances$Setshieldedvmintegritypolicy, + callback: BodyResponseCallback + ): void; + setShieldedVmIntegrityPolicy( + callback: BodyResponseCallback + ): void; + setShieldedVmIntegrityPolicy( + paramsOrCallback?: + | Params$Resource$Instances$Setshieldedvmintegritypolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setshieldedvmintegritypolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setshieldedvmintegritypolicy; + 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}/setShieldedVmIntegrityPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.setTags + * @desc Sets network tags for the specified instance to the data included in the request. + * @alias compute.instances.setTags + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().Tags} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setTags( + params?: Params$Resource$Instances$Settags, + options?: MethodOptions + ): GaxiosPromise; + setTags( + params: Params$Resource$Instances$Settags, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTags( + params: Params$Resource$Instances$Settags, + callback: BodyResponseCallback + ): void; + setTags(callback: BodyResponseCallback): void; + setTags( + paramsOrCallback?: + | Params$Resource$Instances$Settags + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Settags; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Settags; + 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}/setTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.simulateMaintenanceEvent + * @desc Simulates a maintenance event on the instance. + * @alias compute.instances.simulateMaintenanceEvent + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + simulateMaintenanceEvent( + params?: Params$Resource$Instances$Simulatemaintenanceevent, + options?: MethodOptions + ): GaxiosPromise; + simulateMaintenanceEvent( + params: Params$Resource$Instances$Simulatemaintenanceevent, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + simulateMaintenanceEvent( + params: Params$Resource$Instances$Simulatemaintenanceevent, + callback: BodyResponseCallback + ): void; + simulateMaintenanceEvent( + callback: BodyResponseCallback + ): void; + simulateMaintenanceEvent( + paramsOrCallback?: + | Params$Resource$Instances$Simulatemaintenanceevent + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Simulatemaintenanceevent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Simulatemaintenanceevent; + 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}/simulateMaintenanceEvent' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.start + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @alias compute.instances.start + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to start. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + start( + params?: Params$Resource$Instances$Start, + options?: MethodOptions + ): GaxiosPromise; + start( + params: Params$Resource$Instances$Start, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + start( + params: Params$Resource$Instances$Start, + callback: BodyResponseCallback + ): void; + start(callback: BodyResponseCallback): void; + start( + paramsOrCallback?: + | Params$Resource$Instances$Start + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Start; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Start; + 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}/start' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.startWithEncryptionKey + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @alias compute.instances.startWithEncryptionKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to start. + * @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 {().InstancesStartWithEncryptionKeyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + startWithEncryptionKey( + params?: Params$Resource$Instances$Startwithencryptionkey, + options?: MethodOptions + ): GaxiosPromise; + startWithEncryptionKey( + params: Params$Resource$Instances$Startwithencryptionkey, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startWithEncryptionKey( + params: Params$Resource$Instances$Startwithencryptionkey, + callback: BodyResponseCallback + ): void; + startWithEncryptionKey( + callback: BodyResponseCallback + ): void; + startWithEncryptionKey( + paramsOrCallback?: + | Params$Resource$Instances$Startwithencryptionkey + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Startwithencryptionkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Startwithencryptionkey; + 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}/startWithEncryptionKey' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.stop + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.discardLocalSsd If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). + * @param {string} params.instance Name of the instance resource to stop. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + stop( + params?: Params$Resource$Instances$Stop, + options?: MethodOptions + ): GaxiosPromise; + stop( + params: Params$Resource$Instances$Stop, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stop( + params: Params$Resource$Instances$Stop, + callback: BodyResponseCallback + ): void; + stop(callback: BodyResponseCallback): void; + stop( + paramsOrCallback?: + | Params$Resource$Instances$Stop + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Stop; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Stop; + 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}/stop' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.suspend + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.discardLocalSsd If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). + * @param {string} params.instance Name of the instance resource to suspend. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + suspend( + params?: Params$Resource$Instances$Suspend, + options?: MethodOptions + ): GaxiosPromise; + suspend( + params: Params$Resource$Instances$Suspend, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspend( + params: Params$Resource$Instances$Suspend, + callback: BodyResponseCallback + ): void; + suspend(callback: BodyResponseCallback): void; + suspend( + paramsOrCallback?: + | Params$Resource$Instances$Suspend + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Suspend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Suspend; + 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}/suspend' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.instances.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Instances$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Instances$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instances$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instances$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$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/alpha/projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', '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. + * @alias compute.instances.updateAccessConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The instance name for this request. + * @param {string} params.networkInterface The name of the network interface where the access config is attached. + * @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 {().AccessConfig} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateAccessConfig( + params?: Params$Resource$Instances$Updateaccessconfig, + options?: MethodOptions + ): GaxiosPromise; + updateAccessConfig( + params: Params$Resource$Instances$Updateaccessconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAccessConfig( + params: Params$Resource$Instances$Updateaccessconfig, + callback: BodyResponseCallback + ): void; + updateAccessConfig(callback: BodyResponseCallback): void; + updateAccessConfig( + paramsOrCallback?: + | Params$Resource$Instances$Updateaccessconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updateaccessconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updateaccessconfig; + 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}/updateAccessConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.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. + * @alias compute.instances.updateDisplayDevice + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().DisplayDevice} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateDisplayDevice( + params?: Params$Resource$Instances$Updatedisplaydevice, + options?: MethodOptions + ): GaxiosPromise; + updateDisplayDevice( + params: Params$Resource$Instances$Updatedisplaydevice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateDisplayDevice( + params: Params$Resource$Instances$Updatedisplaydevice, + callback: BodyResponseCallback + ): void; + updateDisplayDevice(callback: BodyResponseCallback): void; + updateDisplayDevice( + paramsOrCallback?: + | Params$Resource$Instances$Updatedisplaydevice + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updatedisplaydevice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updatedisplaydevice; + 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}/updateDisplayDevice' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.updateNetworkInterface + * @desc Updates an instance's network interface. This method follows PATCH semantics. + * @alias compute.instances.updateNetworkInterface + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The instance name for this request. + * @param {string} params.networkInterface The name of the network interface 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 {().NetworkInterface} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateNetworkInterface( + params?: Params$Resource$Instances$Updatenetworkinterface, + options?: MethodOptions + ): GaxiosPromise; + updateNetworkInterface( + params: Params$Resource$Instances$Updatenetworkinterface, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateNetworkInterface( + params: Params$Resource$Instances$Updatenetworkinterface, + callback: BodyResponseCallback + ): void; + updateNetworkInterface( + callback: BodyResponseCallback + ): void; + updateNetworkInterface( + paramsOrCallback?: + | Params$Resource$Instances$Updatenetworkinterface + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updatenetworkinterface; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updatenetworkinterface; + 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}/updateNetworkInterface' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instances.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. + * @alias compute.instances.updateShieldedInstanceConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name or id of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().ShieldedInstanceConfig} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateShieldedInstanceConfig( + params?: Params$Resource$Instances$Updateshieldedinstanceconfig, + options?: MethodOptions + ): GaxiosPromise; + updateShieldedInstanceConfig( + params: Params$Resource$Instances$Updateshieldedinstanceconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateShieldedInstanceConfig( + params: Params$Resource$Instances$Updateshieldedinstanceconfig, + callback: BodyResponseCallback + ): void; + updateShieldedInstanceConfig( + callback: BodyResponseCallback + ): void; + updateShieldedInstanceConfig( + paramsOrCallback?: + | Params$Resource$Instances$Updateshieldedinstanceconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updateshieldedinstanceconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updateshieldedinstanceconfig; + 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}/updateShieldedInstanceConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.instances.updateShieldedVmConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.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 {().ShieldedVmConfig} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateShieldedVmConfig( + params?: Params$Resource$Instances$Updateshieldedvmconfig, + options?: MethodOptions + ): GaxiosPromise; + updateShieldedVmConfig( + params: Params$Resource$Instances$Updateshieldedvmconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateShieldedVmConfig( + params: Params$Resource$Instances$Updateshieldedvmconfig, + callback: BodyResponseCallback + ): void; + updateShieldedVmConfig( + callback: BodyResponseCallback + ): void; + updateShieldedVmConfig( + paramsOrCallback?: + | Params$Resource$Instances$Updateshieldedvmconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Updateshieldedvmconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Updateshieldedvmconfig; + 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}/updateShieldedVmConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instances$Addaccessconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface to add to this instance. + */ + networkInterface?: 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$AccessConfig; + } + export interface Params$Resource$Instances$Addresourcepolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance name for this request. + */ + instance?: 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$InstancesAddResourcePoliciesRequest; + } + export interface Params$Resource$Instances$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Instances$Attachdisk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Whether to force attach the disk even if it's currently attached to another instance. + */ + forceAttach?: boolean; + /** + * The instance name for this request. + */ + instance?: 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$AttachedDisk; + } + export interface Params$Resource$Instances$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance resource to delete. + */ + instance?: 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; + } + export interface Params$Resource$Instances$Deleteaccessconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the access config to delete. + */ + accessConfig?: string; + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface. + */ + networkInterface?: 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; + } + export interface Params$Resource$Instances$Detachdisk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. + */ + deviceName?: string; + /** + * Instance name for this request. + */ + instance?: 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; + } + export interface Params$Resource$Instances$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance resource to return. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Geteffectivefirewalls + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * The name of the network interface to get the effective firewalls. + */ + networkInterface?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getguestattributes + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Specifies the guest attributes path to be queried. + */ + queryPath?: string; + /** + * Specifies the key for the guest attributes entry. + */ + variableKey?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$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; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getserialportoutput + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Specifies which COM or serial port to retrieve data from. + */ + port?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call. + */ + start?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getshieldedinstanceidentity + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name or id of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Getshieldedvmidentity + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$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; + /** + * 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. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Instance; + } + export interface Params$Resource$Instances$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Listreferrers + 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; + /** + * Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. + */ + instance?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Removeresourcepolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance name for this request. + */ + instance?: 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$InstancesRemoveResourcePoliciesRequest; + } + export interface Params$Resource$Instances$Reset extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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; + } + export interface Params$Resource$Instances$Resume extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance resource to resume. + */ + instance?: 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$InstancesResumeRequest; + } + export interface Params$Resource$Instances$Setdeletionprotection + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Whether the resource should be protected against deletion. + */ + deletionProtection?: boolean; + /** + * 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; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Setdiskautodelete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Whether to auto-delete the disk when the instance is deleted. + */ + autoDelete?: boolean; + /** + * The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. + */ + deviceName?: string; + /** + * The instance name for this request. + */ + instance?: 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; + } + export interface Params$Resource$Instances$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Instances$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$InstancesSetLabelsRequest; + } + export interface Params$Resource$Instances$Setmachineresources + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$InstancesSetMachineResourcesRequest; + } + export interface Params$Resource$Instances$Setmachinetype + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$InstancesSetMachineTypeRequest; + } + export interface Params$Resource$Instances$Setmetadata + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$Metadata; + } + export interface Params$Resource$Instances$Setmincpuplatform + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$InstancesSetMinCpuPlatformRequest; + } + export interface Params$Resource$Instances$Setname + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance name for this request. + */ + instance?: 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$InstancesSetNameRequest; + } + export interface Params$Resource$Instances$Setscheduling + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Instance name for this request. + */ + instance?: 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$Scheduling; + } + export interface Params$Resource$Instances$Setserviceaccount + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance resource to start. + */ + instance?: 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$InstancesSetServiceAccountRequest; + } + export interface Params$Resource$Instances$Setshieldedinstanceintegritypolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name or id of the instance scoping this request. + */ + instance?: 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$ShieldedInstanceIntegrityPolicy; + } + export interface Params$Resource$Instances$Setshieldedvmintegritypolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$ShieldedVmIntegrityPolicy; + } + export interface Params$Resource$Instances$Settags + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$Tags; + } + export interface Params$Resource$Instances$Simulatemaintenanceevent + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Start extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance resource to start. + */ + instance?: 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; + } + export interface Params$Resource$Instances$Startwithencryptionkey + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance resource to start. + */ + instance?: 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$InstancesStartWithEncryptionKeyRequest; + } + export interface Params$Resource$Instances$Stop extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). + */ + discardLocalSsd?: boolean; + /** + * Name of the instance resource to stop. + */ + instance?: 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; + } + export interface Params$Resource$Instances$Suspend + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). + */ + discardLocalSsd?: boolean; + /** + * Name of the instance resource to suspend. + */ + instance?: 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; + } + export interface Params$Resource$Instances$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Instances$Updateaccessconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface where the access config is attached. + */ + networkInterface?: 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$AccessConfig; + } + export interface Params$Resource$Instances$Updatedisplaydevice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$DisplayDevice; + } + export interface Params$Resource$Instances$Updatenetworkinterface + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance name for this request. + */ + instance?: string; + /** + * The name of the network interface to update. + */ + networkInterface?: 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$NetworkInterface; + } + export interface Params$Resource$Instances$Updateshieldedinstanceconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name or id of the instance scoping this request. + */ + instance?: 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$ShieldedInstanceConfig; + } + export interface Params$Resource$Instances$Updateshieldedvmconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * 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$ShieldedVmConfig; + } + + export class Resource$Instancetemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.instanceTemplates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceTemplate The name of the instance template 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$Instancetemplates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instancetemplates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instancetemplates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$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}/global/instanceTemplates/{instanceTemplate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'instanceTemplate'], + pathParams: ['instanceTemplate', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceTemplates.get + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. + * @alias compute.instanceTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceTemplate The name of the instance template. + * @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$Instancetemplates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instancetemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancetemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$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}/global/instanceTemplates/{instanceTemplate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instanceTemplate'], + pathParams: ['instanceTemplate', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceTemplates.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.instanceTemplates.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$Instancetemplates$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$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/alpha/projects/{project}/global/instanceTemplates/{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.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. + * @alias compute.instanceTemplates.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 {().InstanceTemplate} params.resource Request body data + * @param {object} [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$Instancetemplates$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instancetemplates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instancetemplates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$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}/global/instanceTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceTemplates.list + * @desc Retrieves a list of instance templates that are contained within the specified project. + * @alias compute.instanceTemplates.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$Instancetemplates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instancetemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instancetemplates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Instancetemplates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$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}/global/instanceTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceTemplates.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.instanceTemplates.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.resource Request body data + * @param {object} [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$Instancetemplates$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$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/alpha/projects/{project}/global/instanceTemplates/{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.instanceTemplates.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.instanceTemplates.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.resource Request body data + * @param {object} [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$Instancetemplates$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Instancetemplates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instancetemplates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instancetemplates$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancetemplates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$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/alpha/projects/{project}/global/instanceTemplates/{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$Instancetemplates$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance template to delete. + */ + instanceTemplate?: 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$Instancetemplates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance template. + */ + instanceTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Instancetemplates$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$Instancetemplates$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceTemplate; + } + export interface Params$Resource$Instancetemplates$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$Instancetemplates$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$Instancetemplates$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$Interconnectattachments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.interconnectAttachments.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Interconnectattachments$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Interconnectattachments$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$InterconnectAttachmentAggregatedList + > + ): void; + aggregatedList( + params: Params$Resource$Interconnectattachments$Aggregatedlist, + callback: BodyResponseCallback< + Schema$InterconnectAttachmentAggregatedList + > + ): void; + aggregatedList( + callback: BodyResponseCallback< + Schema$InterconnectAttachmentAggregatedList + > + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$InterconnectAttachmentAggregatedList + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/interconnectAttachments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.interconnectAttachments.delete + * @desc Deletes the specified interconnect attachment. + * @alias compute.interconnectAttachments.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnectAttachment Name of the interconnect attachment to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Interconnectattachments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Interconnectattachments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Interconnectattachments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$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}/interconnectAttachments/{interconnectAttachment}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'interconnectAttachment'], + pathParams: ['interconnectAttachment', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectAttachments.get + * @desc Returns the specified interconnect attachment. + * @alias compute.interconnectAttachments.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnectAttachment Name of the interconnect attachment to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Interconnectattachments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Interconnectattachments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Interconnectattachments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$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}/interconnectAttachments/{interconnectAttachment}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'interconnectAttachment'], + pathParams: ['interconnectAttachment', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectAttachments.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.interconnectAttachments.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.region The name of the region 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$Interconnectattachments$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Interconnectattachments$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Interconnectattachments$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$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/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectAttachments.insert + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. + * @alias compute.interconnectAttachments.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {boolean=} params.validateOnly If true, the request will not be committed. + * @param {().InterconnectAttachment} params.resource Request body data + * @param {object} [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$Interconnectattachments$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Interconnectattachments$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Interconnectattachments$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$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}/interconnectAttachments' + ).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.interconnectAttachments.list + * @desc Retrieves the list of interconnect attachments contained within the specified region. + * @alias compute.interconnectAttachments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Interconnectattachments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Interconnectattachments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Interconnectattachments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$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}/interconnectAttachments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.interconnectAttachments.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnectAttachment Name of the interconnect attachment to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().InterconnectAttachment} params.resource Request body data + * @param {object} [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$Interconnectattachments$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Interconnectattachments$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Interconnectattachments$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'interconnectAttachment'], + pathParams: ['interconnectAttachment', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectAttachments.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.interconnectAttachments.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetPolicyRequest} params.resource Request body data + * @param {object} [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$Interconnectattachments$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Interconnectattachments$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Interconnectattachments$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$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/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectAttachments.setLabels + * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.interconnectAttachments.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Interconnectattachments$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Interconnectattachments$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Interconnectattachments$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$Setlabels; + 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}/interconnectAttachments/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectAttachments.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.interconnectAttachments.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Interconnectattachments$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Interconnectattachments$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Interconnectattachments$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Interconnectattachments$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachments$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectattachments$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/alpha/projects/{project}/regions/{region}/interconnectAttachments/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Interconnectattachments$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnectattachments$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect attachment to delete. + */ + interconnectAttachment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Interconnectattachments$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect attachment to return. + */ + interconnectAttachment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Interconnectattachments$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; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Interconnectattachments$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectAttachment; + } + export interface Params$Resource$Interconnectattachments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Interconnectattachments$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect attachment to patch. + */ + interconnectAttachment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectAttachment; + } + export interface Params$Resource$Interconnectattachments$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Interconnectattachments$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Interconnectattachments$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Interconnectlocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.interconnectLocations.get + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnectLocation Name of the interconnect location to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Interconnectlocations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Interconnectlocations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Interconnectlocations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Interconnectlocations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectlocations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectlocations$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}/global/interconnectLocations/{interconnectLocation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'interconnectLocation'], + pathParams: ['interconnectLocation', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectLocations.list + * @desc Retrieves the list of interconnect locations available to the specified project. + * @alias compute.interconnectLocations.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$Interconnectlocations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Interconnectlocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Interconnectlocations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Interconnectlocations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectlocations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectlocations$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}/global/interconnectLocations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnectLocations.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.interconnectLocations.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.resource Request body data + * @param {object} [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$Interconnectlocations$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Interconnectlocations$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Interconnectlocations$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Interconnectlocations$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectlocations$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectlocations$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/alpha/projects/{project}/global/interconnectLocations/{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$Interconnectlocations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect location to return. + */ + interconnectLocation?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnectlocations$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$Interconnectlocations$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$Interconnects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.interconnects.delete + * @desc Deletes the specified interconnect. + * @alias compute.interconnects.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnect Name of the interconnect 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$Interconnects$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Interconnects$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Interconnects$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Interconnects$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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}/global/interconnects/{interconnect}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnects.get + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. + * @alias compute.interconnects.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnect Name of the interconnect to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Interconnects$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Interconnects$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Interconnects$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Interconnects$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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}/global/interconnects/{interconnect}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnects.getDiagnostics + * @desc Returns the interconnectDiagnostics for the specified interconnect. + * @alias compute.interconnects.getDiagnostics + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnect Name of the interconnect resource to query. + * @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 + */ + getDiagnostics( + params?: Params$Resource$Interconnects$Getdiagnostics, + options?: MethodOptions + ): GaxiosPromise; + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, + callback: BodyResponseCallback + ): void; + getDiagnostics( + callback: BodyResponseCallback + ): void; + getDiagnostics( + paramsOrCallback?: + | Params$Resource$Interconnects$Getdiagnostics + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$InterconnectsGetDiagnosticsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Getdiagnostics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$Getdiagnostics; + 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}/global/interconnects/{interconnect}/getDiagnostics' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.interconnects.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.interconnects.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$Interconnects$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Interconnects$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Interconnects$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Interconnects$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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/alpha/projects/{project}/global/interconnects/{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.interconnects.insert + * @desc Creates a Interconnect in the specified project using the data included in the request. + * @alias compute.interconnects.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 {().Interconnect} params.resource Request body data + * @param {object} [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$Interconnects$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Interconnects$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Interconnects$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Interconnects$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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}/global/interconnects' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnects.list + * @desc Retrieves the list of interconnect available to the specified project. + * @alias compute.interconnects.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$Interconnects$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Interconnects$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Interconnects$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Interconnects$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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}/global/interconnects' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.interconnects.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnect Name of the interconnect 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 {().Interconnect} params.resource Request body data + * @param {object} [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$Interconnects$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Interconnects$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Interconnects$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Interconnects$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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}/global/interconnects/{interconnect}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.interconnects.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.interconnects.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.resource Request body data + * @param {object} [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$Interconnects$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Interconnects$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Interconnects$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Interconnects$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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/alpha/projects/{project}/global/interconnects/{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.interconnects.setLabels + * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.interconnects.setLabels + * @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 {().GlobalSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Interconnects$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Interconnects$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Interconnects$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Interconnects$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$Setlabels; + 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}/global/interconnects/{resource}/setLabels' + ).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.interconnects.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.interconnects.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.resource Request body data + * @param {object} [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$Interconnects$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Interconnects$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Interconnects$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Interconnects$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$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/alpha/projects/{project}/global/interconnects/{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$Interconnects$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect to delete. + */ + interconnect?: 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$Interconnects$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect to return. + */ + interconnect?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnects$Getdiagnostics + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect resource to query. + */ + interconnect?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnects$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$Interconnects$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Interconnect; + } + export interface Params$Resource$Interconnects$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$Interconnects$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the interconnect to update. + */ + interconnect?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Interconnect; + } + export interface Params$Resource$Interconnects$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$Interconnects$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Interconnects$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$Licensecodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.licenseCodes.get + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.licenseCode Number corresponding to the License code 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 + */ + get( + params?: Params$Resource$Licensecodes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Licensecodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Licensecodes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Licensecodes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Licensecodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licensecodes$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}/global/licenseCodes/{licenseCode}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'licenseCode'], + pathParams: ['licenseCode', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.licenseCodes.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.licenseCodes.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$Licensecodes$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Licensecodes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Licensecodes$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Licensecodes$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Licensecodes$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licensecodes$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/alpha/projects/{project}/global/licenseCodes/{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.licenseCodes.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.licenseCodes.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.resource Request body data + * @param {object} [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$Licensecodes$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Licensecodes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Licensecodes$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Licensecodes$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Licensecodes$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licensecodes$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/alpha/projects/{project}/global/licenseCodes/{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.licenseCodes.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.licenseCodes.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.resource Request body data + * @param {object} [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$Licensecodes$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Licensecodes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Licensecodes$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Licensecodes$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Licensecodes$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licensecodes$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/alpha/projects/{project}/global/licenseCodes/{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$Licensecodes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Number corresponding to the License code resource to return. + */ + licenseCode?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Licensecodes$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$Licensecodes$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$Licensecodes$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$Licenses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.licenses.delete + * @desc Deletes the specified license. + * @alias compute.licenses.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.license Name of the license resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Licenses$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Licenses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Licenses$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Licenses$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$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}/global/licenses/{license}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'license'], + pathParams: ['license', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.licenses.get + * @desc Returns the specified License resource. + * @alias compute.licenses.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.license Name of the License 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 + */ + get( + params?: Params$Resource$Licenses$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Licenses$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Licenses$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Licenses$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$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}/global/licenses/{license}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'license'], + pathParams: ['license', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.licenses.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.licenses.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$Licenses$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Licenses$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Licenses$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Licenses$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Licenses$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$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/alpha/projects/{project}/global/licenses/{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.licenses.insert + * @desc Create a License resource in the specified project. + * @alias compute.licenses.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 {().License} params.resource Request body data + * @param {object} [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$Licenses$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Licenses$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Licenses$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Licenses$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$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}/global/licenses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.licenses.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$Licenses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Licenses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Licenses$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Licenses$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Licenses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$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}/global/licenses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.licenses.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.licenses.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.resource Request body data + * @param {object} [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$Licenses$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Licenses$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Licenses$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Licenses$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Licenses$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$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/alpha/projects/{project}/global/licenses/{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.licenses.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.licenses.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.resource Request body data + * @param {object} [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$Licenses$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Licenses$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Licenses$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Licenses$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Licenses$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Licenses$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/alpha/projects/{project}/global/licenses/{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$Licenses$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the license resource to delete. + */ + license?: 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$Licenses$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the License resource to return. + */ + license?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Licenses$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$Licenses$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$License; + } + export interface Params$Resource$Licenses$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$Licenses$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$Licenses$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$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/alpha/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/alpha/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/alpha/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.resource Request body data + * @param {object} [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/alpha/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/alpha/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.resource Request body data + * @param {object} [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/alpha/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.resource Request body data + * @param {object} [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/alpha/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) { + this.context = context; + } + + /** + * compute.machineTypes.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Machinetypes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Machinetypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Machinetypes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Machinetypes$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machinetypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machinetypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/machineTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineTypes.get + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. + * @alias compute.machineTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.machineType Name of the machine type to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Machinetypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Machinetypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Machinetypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Machinetypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Machinetypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machinetypes$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}/zones/{zone}/machineTypes/{machineType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'machineType'], + pathParams: ['machineType', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineTypes.list + * @desc Retrieves a list of machine types available to the specified project. + * @alias compute.machineTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Machinetypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Machinetypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Machinetypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Machinetypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machinetypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machinetypes$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}/zones/{zone}/machineTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Machinetypes$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Machinetypes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the machine type to return. + */ + machineType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Machinetypes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Networkendpointgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.networkEndpointGroups.aggregatedList + * @desc Retrieves the list of network endpoint groups and sorts them by zone. + * @alias compute.networkEndpointGroups.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Networkendpointgroups$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Networkendpointgroups$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Networkendpointgroups$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/networkEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.networkEndpointGroups.attachNetworkEndpoints + * @desc Attach a list of network endpoints to the specified network endpoint group. + * @alias compute.networkEndpointGroups.attachNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {().NetworkEndpointGroupsAttachEndpointsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + attachNetworkEndpoints( + params?: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + attachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Attachnetworkendpoints, + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Attachnetworkendpoints + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Attachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$Attachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networkEndpointGroups.delete + * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. + * @alias compute.networkEndpointGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group to delete. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Networkendpointgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Networkendpointgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Networkendpointgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$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}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networkEndpointGroups.detachNetworkEndpoints + * @desc Detach a list of network endpoints from the specified network endpoint group. + * @alias compute.networkEndpointGroups.detachNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {().NetworkEndpointGroupsDetachEndpointsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + detachNetworkEndpoints( + params?: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + detachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Detachnetworkendpoints, + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Detachnetworkendpoints + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Detachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$Detachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networkEndpointGroups.get + * @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! () + * + * @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.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Networkendpointgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Networkendpointgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Networkendpointgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$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}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networkEndpointGroups.insert + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @alias compute.networkEndpointGroups.insert + * @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.zone The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. + * @param {().NetworkEndpointGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Networkendpointgroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Networkendpointgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Networkendpointgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$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}/zones/{zone}/networkEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networkEndpointGroups.list + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. + * @alias compute.networkEndpointGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone 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$Networkendpointgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Networkendpointgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Networkendpointgroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$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}/zones/{zone}/networkEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networkEndpointGroups.listNetworkEndpoints + * @desc Lists the network endpoints in the specified network endpoint group. + * @alias compute.networkEndpointGroups.listNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.networkEndpointGroup The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {().NetworkEndpointGroupsListEndpointsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listNetworkEndpoints( + params?: Params$Resource$Networkendpointgroups$Listnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + listNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, + options: + | MethodOptions + | BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void; + listNetworkEndpoints( + params: Params$Resource$Networkendpointgroups$Listnetworkendpoints, + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void; + listNetworkEndpoints( + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void; + listNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Listnetworkendpoints + | BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + callback?: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Listnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$Listnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >(parameters); + } + } + + /** + * compute.networkEndpointGroups.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.networkEndpointGroups.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Networkendpointgroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Networkendpointgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Networkendpointgroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Networkendpointgroups$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkendpointgroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkendpointgroups$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/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Networkendpointgroups$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroupsAttachEndpointsRequest; + } + export interface Params$Resource$Networkendpointgroups$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group to delete. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Networkendpointgroups$Detachnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroupsDetachEndpointsRequest; + } + export interface Params$Resource$Networkendpointgroups$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 zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Networkendpointgroups$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; + /** + * The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroup; + } + export interface Params$Resource$Networkendpointgroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Networkendpointgroups$Listnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroupsListEndpointsRequest; + } + export interface Params$Resource$Networkendpointgroups$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Networks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.networks.addPeering + * @desc Adds a peering to the specified network. + * @alias compute.networks.addPeering + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network resource to add peering to. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NetworksAddPeeringRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addPeering( + params?: Params$Resource$Networks$Addpeering, + options?: MethodOptions + ): GaxiosPromise; + addPeering( + params: Params$Resource$Networks$Addpeering, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPeering( + params: Params$Resource$Networks$Addpeering, + callback: BodyResponseCallback + ): void; + addPeering(callback: BodyResponseCallback): void; + addPeering( + paramsOrCallback?: + | Params$Resource$Networks$Addpeering + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Addpeering; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Addpeering; + 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}/global/networks/{network}/addPeering' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networks.delete + * @desc Deletes the specified network. + * @alias compute.networks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Networks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Networks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Networks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Networks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$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}/global/networks/{network}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networks.get + * @desc Returns the specified network. Gets a list of available networks by making a list() request. + * @alias compute.networks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Networks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Networks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Networks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Networks$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$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}/global/networks/{network}' + ).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.getEffectiveFirewalls + * @desc Returns the effective firewalls on a given network. + * @alias compute.networks.getEffectiveFirewalls + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network for this request. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getEffectiveFirewalls( + params?: Params$Resource$Networks$Geteffectivefirewalls, + options?: MethodOptions + ): GaxiosPromise; + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$NetworksGetEffectiveFirewallsResponse + > + ): void; + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, + callback: BodyResponseCallback< + Schema$NetworksGetEffectiveFirewallsResponse + > + ): void; + getEffectiveFirewalls( + callback: BodyResponseCallback< + Schema$NetworksGetEffectiveFirewallsResponse + > + ): void; + getEffectiveFirewalls( + paramsOrCallback?: + | Params$Resource$Networks$Geteffectivefirewalls + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$NetworksGetEffectiveFirewallsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Geteffectivefirewalls; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Geteffectivefirewalls; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networks/{network}/getEffectiveFirewalls' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.networks.insert + * @desc Creates a network in the specified project using the data included in the request. + * @alias compute.networks.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 {().Network} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Networks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Networks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Networks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Networks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$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}/global/networks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networks.list + * @desc Retrieves the list of networks available to the specified project. + * @alias compute.networks.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.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$Networks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Networks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Networks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Networks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Networks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$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}/global/networks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networks.listIpAddresses + * @desc Lists the internal IP addresses in the specified network. + * @alias compute.networks.listIpAddresses + * @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.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.project Project ID for this request. + * @param {string=} params.types (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listIpAddresses( + params?: Params$Resource$Networks$Listipaddresses, + options?: MethodOptions + ): GaxiosPromise; + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, + callback: BodyResponseCallback + ): void; + listIpAddresses( + callback: BodyResponseCallback + ): void; + listIpAddresses( + paramsOrCallback?: + | Params$Resource$Networks$Listipaddresses + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Listipaddresses; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Listipaddresses; + 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}/global/networks/{network}/listIpAddresses' + ).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.listIpOwners + * @desc Lists the internal IP owners in the specified network. + * @alias compute.networks.listIpOwners + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {string=} params.ipCidrRange (Optional) IP CIDR range filter, example: "10.128.10.0/30". + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.network Name of the network to return. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.ownerProjects (Optional) Project IDs filter, example: "project-1,project-2". + * @param {string=} params.ownerTypes (Optional) Owner types filter, example: "instance,forwardingRule". + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string=} params.subnetName (Optional) Subnetwork name filter. + * @param {string=} params.subnetRegion (Optional) Subnetwork region filter. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listIpOwners( + params?: Params$Resource$Networks$Listipowners, + options?: MethodOptions + ): GaxiosPromise; + listIpOwners( + params: Params$Resource$Networks$Listipowners, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listIpOwners( + params: Params$Resource$Networks$Listipowners, + callback: BodyResponseCallback + ): void; + listIpOwners(callback: BodyResponseCallback): void; + listIpOwners( + paramsOrCallback?: + | Params$Resource$Networks$Listipowners + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Listipowners; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Listipowners; + 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}/global/networks/{network}/listIpOwners' + ).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.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/alpha/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. + * @alias compute.networks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network to update. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Network} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Networks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Networks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Networks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Networks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Networks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$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}/global/networks/{network}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networks.removePeering + * @desc Removes a peering from the specified network. + * @alias compute.networks.removePeering + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network resource to remove peering from. + * @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 {().NetworksRemovePeeringRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removePeering( + params?: Params$Resource$Networks$Removepeering, + options?: MethodOptions + ): GaxiosPromise; + removePeering( + params: Params$Resource$Networks$Removepeering, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePeering( + params: Params$Resource$Networks$Removepeering, + callback: BodyResponseCallback + ): void; + removePeering(callback: BodyResponseCallback): void; + removePeering( + paramsOrCallback?: + | Params$Resource$Networks$Removepeering + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Removepeering; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Removepeering; + 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}/global/networks/{network}/removePeering' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networks.switchToCustomMode + * @desc Switches the network mode from auto subnet mode to custom subnet mode. + * @alias compute.networks.switchToCustomMode + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network to be updated. + * @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 + */ + switchToCustomMode( + params?: Params$Resource$Networks$Switchtocustommode, + options?: MethodOptions + ): GaxiosPromise; + switchToCustomMode( + params: Params$Resource$Networks$Switchtocustommode, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + switchToCustomMode( + params: Params$Resource$Networks$Switchtocustommode, + callback: BodyResponseCallback + ): void; + switchToCustomMode(callback: BodyResponseCallback): void; + switchToCustomMode( + paramsOrCallback?: + | Params$Resource$Networks$Switchtocustommode + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Switchtocustommode; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Switchtocustommode; + 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}/global/networks/{network}/switchToCustomMode' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.networks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.networks.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Networks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Networks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Networks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Networks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$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/alpha/projects/{project}/global/networks/{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); + } + } + + /** + * 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 + * @alias compute.networks.updatePeering + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network resource which the updated peering is belonging to. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NetworksUpdatePeeringRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updatePeering( + params?: Params$Resource$Networks$Updatepeering, + options?: MethodOptions + ): GaxiosPromise; + updatePeering( + params: Params$Resource$Networks$Updatepeering, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updatePeering( + params: Params$Resource$Networks$Updatepeering, + callback: BodyResponseCallback + ): void; + updatePeering(callback: BodyResponseCallback): void; + updatePeering( + paramsOrCallback?: + | Params$Resource$Networks$Updatepeering + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Updatepeering; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Updatepeering; + 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}/global/networks/{network}/updatePeering' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Networks$Addpeering + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network resource to add peering to. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksAddPeeringRequest; + } + export interface Params$Resource$Networks$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network to delete. + */ + network?: 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$Networks$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network to return. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networks$Geteffectivefirewalls + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network for this request. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networks$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Network; + } + export interface Params$Resource$Networks$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$Networks$Listipaddresses + 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; + /** + * 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; + /** + * Project ID for this request. + */ + project?: string; + /** + * (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. + */ + types?: string; + } + export interface Params$Resource$Networks$Listipowners + 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; + /** + * (Optional) IP CIDR range filter, example: "10.128.10.0/30". + */ + ipCidrRange?: 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 to return. + */ + 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; + /** + * (Optional) Project IDs filter, example: "project-1,project-2". + */ + ownerProjects?: string; + /** + * (Optional) Owner types filter, example: "instance,forwardingRule". + */ + ownerTypes?: 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; + /** + * (Optional) Subnetwork name filter. + */ + subnetName?: string; + /** + * (Optional) Subnetwork region filter. + */ + subnetRegion?: 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 + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network to update. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Network; + } + export interface Params$Resource$Networks$Removepeering + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network resource to remove peering from. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksRemovePeeringRequest; + } + export interface Params$Resource$Networks$Switchtocustommode + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network to be updated. + */ + network?: 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$Networks$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Networks$Updatepeering + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the network resource which the updated peering is belonging to. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksUpdatePeeringRequest; + } + + export class Resource$Nodegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.nodeGroups.addNodes + * @desc Adds specified number of nodes to the node group. + * @alias compute.nodeGroups.addNodes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource. + * @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 {().NodeGroupsAddNodesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addNodes( + params?: Params$Resource$Nodegroups$Addnodes, + options?: MethodOptions + ): GaxiosPromise; + addNodes( + params: Params$Resource$Nodegroups$Addnodes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addNodes( + params: Params$Resource$Nodegroups$Addnodes, + callback: BodyResponseCallback + ): void; + addNodes(callback: BodyResponseCallback): void; + addNodes( + paramsOrCallback?: + | Params$Resource$Nodegroups$Addnodes + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Addnodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Addnodes; + 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}/addNodes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Nodegroups$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Nodegroups$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/nodeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.delete + * @desc Deletes the specified NodeGroup resource. + * @alias compute.nodeGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Nodegroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Nodegroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Nodegroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Nodegroups$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$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}/zones/{zone}/nodeGroups/{nodeGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.deleteNodes + * @desc Deletes specified nodes from the node group. + * @alias compute.nodeGroups.deleteNodes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource whose nodes will be deleted. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsDeleteNodesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteNodes( + params?: Params$Resource$Nodegroups$Deletenodes, + options?: MethodOptions + ): GaxiosPromise; + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, + callback: BodyResponseCallback + ): void; + deleteNodes(callback: BodyResponseCallback): void; + deleteNodes( + paramsOrCallback?: + | Params$Resource$Nodegroups$Deletenodes + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Deletenodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Deletenodes; + 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}/deleteNodes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.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. + * @alias compute.nodeGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the node group to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodegroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$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}/zones/{zone}/nodeGroups/{nodeGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.nodeGroups.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {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 {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Nodegroups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Nodegroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Nodegroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Nodegroups$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$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/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.insert + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. + * @alias compute.nodeGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer} params.initialNodeCount Initial count of nodes in the node group. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Nodegroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Nodegroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Nodegroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Nodegroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$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}/zones/{zone}/nodeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'initialNodeCount'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.nodeGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Nodegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodegroups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodegroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Nodegroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$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}/zones/{zone}/nodeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.listNodes + * @desc Lists nodes in the node group. + * @alias compute.nodeGroups.listNodes + * @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.nodeGroup Name of the NodeGroup resource whose nodes you want to list. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listNodes( + params?: Params$Resource$Nodegroups$Listnodes, + options?: MethodOptions + ): GaxiosPromise; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + callback: BodyResponseCallback + ): void; + listNodes(callback: BodyResponseCallback): void; + listNodes( + paramsOrCallback?: + | Params$Resource$Nodegroups$Listnodes + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Listnodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Listnodes; + 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}/listNodes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.setAutoscalingPolicy + * @desc Sets the autoscaling policy of the node group. + * @alias compute.nodeGroups.setAutoscalingPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to update. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsSetAutoscalingPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setAutoscalingPolicy( + params?: Params$Resource$Nodegroups$Setautoscalingpolicy, + options?: MethodOptions + ): GaxiosPromise; + setAutoscalingPolicy( + params: Params$Resource$Nodegroups$Setautoscalingpolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAutoscalingPolicy( + params: Params$Resource$Nodegroups$Setautoscalingpolicy, + callback: BodyResponseCallback + ): void; + setAutoscalingPolicy( + callback: BodyResponseCallback + ): void; + setAutoscalingPolicy( + paramsOrCallback?: + | Params$Resource$Nodegroups$Setautoscalingpolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Setautoscalingpolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Setautoscalingpolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setAutoscalingPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.nodeGroups.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {().ZoneSetPolicyRequest} params.resource Request body data + * @param {object} [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$Nodegroups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Nodegroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Nodegroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Nodegroups$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$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/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.setNodeTemplate + * @desc Updates the node template of the node group. + * @alias compute.nodeGroups.setNodeTemplate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.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 {().NodeGroupsSetNodeTemplateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setNodeTemplate( + params?: Params$Resource$Nodegroups$Setnodetemplate, + options?: MethodOptions + ): GaxiosPromise; + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, + callback: BodyResponseCallback + ): void; + setNodeTemplate(callback: BodyResponseCallback): void; + setNodeTemplate( + paramsOrCallback?: + | Params$Resource$Nodegroups$Setnodetemplate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Setnodetemplate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Setnodetemplate; + 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}/setNodeTemplate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeGroups.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.nodeGroups.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Nodegroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Nodegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Nodegroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Nodegroups$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$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/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodegroups$Addnodes + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NodeGroup resource. + */ + 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$NodeGroupsAddNodesRequest; + } + export interface Params$Resource$Nodegroups$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Nodegroups$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NodeGroup resource to delete. + */ + 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; + } + export interface Params$Resource$Nodegroups$Deletenodes + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NodeGroup resource whose nodes will be deleted. + */ + 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$NodeGroupsDeleteNodesRequest; + } + export interface Params$Resource$Nodegroups$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the node group to return. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$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; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Initial count of nodes in the node group. + */ + initialNodeCount?: number; + /** + * 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$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$Listnodes + 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; + /** + * Name of the NodeGroup resource whose nodes you want to list. + */ + nodeGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$Setautoscalingpolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NodeGroup resource to update. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroupsSetAutoscalingPolicyRequest; + } + export interface Params$Resource$Nodegroups$Setiampolicy + extends StandardParameters { + /** + * 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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Nodegroups$Setnodetemplate + 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$NodeGroupsSetNodeTemplateRequest; + } + export interface Params$Resource$Nodegroups$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Nodetemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.nodeTemplates.aggregatedList + * @desc Retrieves an aggregated list of node templates. + * @alias compute.nodeTemplates.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Nodetemplates$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Nodetemplates$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/nodeTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTemplates.delete + * @desc Deletes the specified NodeTemplate resource. + * @alias compute.nodeTemplates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeTemplate Name of the NodeTemplate resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Nodetemplates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Nodetemplates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Nodetemplates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Nodetemplates$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$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}/nodeTemplates/{nodeTemplate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTemplates.get + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. + * @alias compute.nodeTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeTemplate Name of the node template to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodetemplates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodetemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodetemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodetemplates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$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}/nodeTemplates/{nodeTemplate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTemplates.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.nodeTemplates.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.optionsRequestedPolicyVersion Requested IAM Policy version. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {object} [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$Nodetemplates$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Nodetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Nodetemplates$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Nodetemplates$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$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/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTemplates.insert + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. + * @alias compute.nodeTemplates.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NodeTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Nodetemplates$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Nodetemplates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Nodetemplates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Nodetemplates$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$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}/nodeTemplates' + ).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.nodeTemplates.list + * @desc Retrieves a list of node templates available to the specified project. + * @alias compute.nodeTemplates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Nodetemplates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodetemplates$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodetemplates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Nodetemplates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$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}/nodeTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTemplates.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.nodeTemplates.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetPolicyRequest} params.resource Request body data + * @param {object} [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$Nodetemplates$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Nodetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Nodetemplates$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Nodetemplates$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$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/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTemplates.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.nodeTemplates.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Nodetemplates$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Nodetemplates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Nodetemplates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Nodetemplates$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetemplates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$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/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodetemplates$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Nodetemplates$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NodeTemplate resource to delete. + */ + nodeTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Nodetemplates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the node template to return. + */ + nodeTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Nodetemplates$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; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Nodetemplates$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 for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeTemplate; + } + export interface Params$Resource$Nodetemplates$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 for this request. + */ + region?: string; + } + export interface Params$Resource$Nodetemplates$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Nodetemplates$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Nodetypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.nodeTypes.aggregatedList + * @desc Retrieves an aggregated list of node types. + * @alias compute.nodeTypes.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Nodetypes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Nodetypes$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/aggregated/nodeTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTypes.get + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. + * @alias compute.nodeTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeType Name of the node type to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodetypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodetypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodetypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodetypes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes/{nodeType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeType'], + pathParams: ['nodeType', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTypes.list + * @desc Retrieves a list of node types available to the specified project. + * @alias compute.nodeTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Nodetypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodetypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodetypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Nodetypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodetypes$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Nodetypes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the node type to return. + */ + nodeType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodetypes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Organizationsecuritypolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.organizationSecurityPolicies.addAssociation + * @desc Inserts an association for the specified security policy. + * @alias compute.organizationSecurityPolicies.addAssociation + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.replaceExistingAssociation Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an assocation already exists. + * @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.securityPolicy Name of the security policy to update. + * @param {().SecurityPolicyAssociation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Addassociation, + options?: MethodOptions + ): GaxiosPromise; + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addAssociation( + params: Params$Resource$Organizationsecuritypolicies$Addassociation, + callback: BodyResponseCallback + ): void; + addAssociation(callback: BodyResponseCallback): void; + addAssociation( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Addassociation + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Addassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Addassociation; + 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/locations/global/securityPolicies/{securityPolicy}/addAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.addRule + * @desc Inserts a rule into a security policy. + * @alias compute.organizationSecurityPolicies.addRule + * @memberOf! () + * + * @param {object} params Parameters for 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.securityPolicy Name of the security policy to update. + * @param {().SecurityPolicyRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addRule( + params?: Params$Resource$Organizationsecuritypolicies$Addrule, + options?: MethodOptions + ): GaxiosPromise; + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addRule( + params: Params$Resource$Organizationsecuritypolicies$Addrule, + callback: BodyResponseCallback + ): void; + addRule(callback: BodyResponseCallback): void; + addRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Addrule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Addrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Addrule; + 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/locations/global/securityPolicies/{securityPolicy}/addRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.copyRules + * @desc Copies rules to the specified security policy. + * @alias compute.organizationSecurityPolicies.copyRules + * @memberOf! () + * + * @param {object} params Parameters for 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.securityPolicy Name of the security policy to update. + * @param {string=} params.sourceSecurityPolicy The security policy from which to copy rules. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + copyRules( + params?: Params$Resource$Organizationsecuritypolicies$Copyrules, + options?: MethodOptions + ): GaxiosPromise; + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + copyRules( + params: Params$Resource$Organizationsecuritypolicies$Copyrules, + callback: BodyResponseCallback + ): void; + copyRules(callback: BodyResponseCallback): void; + copyRules( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Copyrules + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Copyrules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Copyrules; + 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/locations/global/securityPolicies/{securityPolicy}/copyRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.delete + * @desc Deletes the specified policy. + * @alias compute.organizationSecurityPolicies.delete + * @memberOf! () + * + * @param {object} params Parameters for 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.securityPolicy Name of the security policy 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$Organizationsecuritypolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizationsecuritypolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$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/locations/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.get + * @desc List all of the ordered rules present in a single specified policy. + * @alias compute.organizationSecurityPolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.securityPolicy Name of the security policy 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$Organizationsecuritypolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizationsecuritypolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizationsecuritypolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$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/locations/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.getAssociation + * @desc Gets an association with the specified name. + * @alias compute.organizationSecurityPolicies.getAssociation + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.name The name of the association to get from the security policy. + * @param {string} params.securityPolicy Name of the security policy to which the queried rule 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 + */ + getAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Getassociation, + options?: MethodOptions + ): GaxiosPromise; + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAssociation( + params: Params$Resource$Organizationsecuritypolicies$Getassociation, + callback: BodyResponseCallback + ): void; + getAssociation( + callback: BodyResponseCallback + ): void; + getAssociation( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Getassociation + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Getassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Getassociation; + 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/locations/global/securityPolicies/{securityPolicy}/getAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.getRule + * @desc Gets a rule at the specified priority. + * @alias compute.organizationSecurityPolicies.getRule + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.priority The priority of the rule to get from the security policy. + * @param {string} params.securityPolicy Name of the security policy to which the queried rule 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 + */ + getRule( + params?: Params$Resource$Organizationsecuritypolicies$Getrule, + options?: MethodOptions + ): GaxiosPromise; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Organizationsecuritypolicies$Getrule, + callback: BodyResponseCallback + ): void; + getRule(callback: BodyResponseCallback): void; + getRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Getrule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Getrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Getrule; + 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/locations/global/securityPolicies/{securityPolicy}/getRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.insert + * @desc Creates a new policy in the specified project using the data included in the request. + * @alias compute.organizationSecurityPolicies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.parentId Parent 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 {().SecurityPolicy} params.resource Request body data + * @param {object} [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$Organizationsecuritypolicies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Organizationsecuritypolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Organizationsecuritypolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$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/locations/global/securityPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.list + * @desc List all the policies that have been configured for the specified project. + * @alias compute.organizationSecurityPolicies.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.parentId Parent 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$Organizationsecuritypolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizationsecuritypolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizationsecuritypolicies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$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/locations/global/securityPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.listAssociations + * @desc Lists associations of a specified target, i.e., organization or folder. + * @alias compute.organizationSecurityPolicies.listAssociations + * @memberOf! () + * + * @param {object=} params Parameters for request + * @param {string=} params.targetResource The target resource to list associations. It is an organization, or a folder. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listAssociations( + params?: Params$Resource$Organizationsecuritypolicies$Listassociations, + options?: MethodOptions + ): GaxiosPromise< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + >; + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + options: + | MethodOptions + | BodyResponseCallback< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + >, + callback: BodyResponseCallback< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + > + ): void; + listAssociations( + params: Params$Resource$Organizationsecuritypolicies$Listassociations, + callback: BodyResponseCallback< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + > + ): void; + listAssociations( + callback: BodyResponseCallback< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + > + ): void; + listAssociations( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Listassociations + | BodyResponseCallback< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + >, + callback?: BodyResponseCallback< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + > + ): void | GaxiosPromise< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Listassociations; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Listassociations; + 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/locations/global/securityPolicies/listAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$OrganizationSecurityPoliciesListAssociationsResponse + >(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.move + * @desc Moves the specified security policy. + * @alias compute.organizationSecurityPolicies.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.parentId The new parent of the security policy. + * @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.securityPolicy Name of the security policy to update. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Organizationsecuritypolicies$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Organizationsecuritypolicies$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Organizationsecuritypolicies$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Move; + 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/locations/global/securityPolicies/{securityPolicy}/move' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.patch + * @desc Patches the specified policy with the data included in the request. + * @alias compute.organizationSecurityPolicies.patch + * @memberOf! () + * + * @param {object} params Parameters for 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.securityPolicy Name of the security policy to update. + * @param {().SecurityPolicy} params.resource Request body data + * @param {object} [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$Organizationsecuritypolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizationsecuritypolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$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/locations/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.patchRule + * @desc Patches a rule at the specified priority. + * @alias compute.organizationSecurityPolicies.patchRule + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.priority The priority of the rule to patch. + * @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.securityPolicy Name of the security policy to update. + * @param {().SecurityPolicyRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patchRule( + params?: Params$Resource$Organizationsecuritypolicies$Patchrule, + options?: MethodOptions + ): GaxiosPromise; + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Organizationsecuritypolicies$Patchrule, + callback: BodyResponseCallback + ): void; + patchRule(callback: BodyResponseCallback): void; + patchRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Patchrule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Patchrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Patchrule; + 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/locations/global/securityPolicies/{securityPolicy}/patchRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.removeAssociation + * @desc Removes an association for the specified security policy. + * @alias compute.organizationSecurityPolicies.removeAssociation + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.name Name for the attachment that will be removed. + * @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.securityPolicy Name of the security policy to update. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeAssociation( + params?: Params$Resource$Organizationsecuritypolicies$Removeassociation, + options?: MethodOptions + ): GaxiosPromise; + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAssociation( + params: Params$Resource$Organizationsecuritypolicies$Removeassociation, + callback: BodyResponseCallback + ): void; + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Removeassociation + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Removeassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Removeassociation; + 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/locations/global/securityPolicies/{securityPolicy}/removeAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.organizationSecurityPolicies.removeRule + * @desc Deletes a rule at the specified priority. + * @alias compute.organizationSecurityPolicies.removeRule + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.priority The priority of the rule to remove from the security policy. + * @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.securityPolicy Name of the security policy to update. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeRule( + params?: Params$Resource$Organizationsecuritypolicies$Removerule, + options?: MethodOptions + ): GaxiosPromise; + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Organizationsecuritypolicies$Removerule, + callback: BodyResponseCallback + ): void; + removeRule(callback: BodyResponseCallback): void; + removeRule( + paramsOrCallback?: + | Params$Resource$Organizationsecuritypolicies$Removerule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizationsecuritypolicies$Removerule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizationsecuritypolicies$Removerule; + 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/locations/global/securityPolicies/{securityPolicy}/removeRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['securityPolicy'], + pathParams: ['securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Organizationsecuritypolicies$Addassociation + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an assocation already exists. + */ + replaceExistingAssociation?: boolean; + /** + * 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyAssociation; + } + export interface Params$Resource$Organizationsecuritypolicies$Addrule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } + export interface Params$Resource$Organizationsecuritypolicies$Copyrules + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + /** + * The security policy from which to copy rules. + */ + sourceSecurityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * 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; + /** + * Name of the security policy to delete. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the security policy to get. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Getassociation + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the association to get from the security policy. + */ + name?: string; + /** + * Name of the security policy to which the queried rule belongs. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Getrule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The priority of the rule to get from the security policy. + */ + priority?: number; + /** + * Name of the security policy to which the queried rule belongs. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Parent ID for this request. + */ + parentId?: 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$SecurityPolicy; + } + export interface Params$Resource$Organizationsecuritypolicies$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; + /** + * Parent ID for this request. + */ + parentId?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Listassociations + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The target resource to list associations. It is an organization, or a folder. + */ + targetResource?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The new parent of the security policy. + */ + parentId?: 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicy; + } + export interface Params$Resource$Organizationsecuritypolicies$Patchrule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } + export interface Params$Resource$Organizationsecuritypolicies$Removeassociation + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name for the attachment that will be removed. + */ + name?: 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } + export interface Params$Resource$Organizationsecuritypolicies$Removerule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The priority of the rule to remove from the security policy. + */ + priority?: number; + /** + * 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } + + export class Resource$Packetmirrorings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.packetMirrorings.aggregatedList + * @desc Retrieves an aggregated list of packetMirrorings. + * @alias compute.packetMirrorings.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Packetmirrorings$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.packetMirrorings.delete + * @desc Deletes the specified PacketMirroring resource. + * @alias compute.packetMirrorings.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Packetmirrorings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Packetmirrorings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Packetmirrorings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.get + * @desc Returns the specified PacketMirroring resource. + * @alias compute.packetMirrorings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Packetmirrorings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Packetmirrorings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Packetmirrorings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.insert + * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. + * @alias compute.packetMirrorings.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().PacketMirroring} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Packetmirrorings$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Packetmirrorings$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Packetmirrorings$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.list + * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. + * @alias compute.packetMirrorings.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Packetmirrorings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Packetmirrorings$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Packetmirrorings$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.patch + * @desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @alias compute.packetMirrorings.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().PacketMirroring} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Packetmirrorings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Packetmirrorings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Packetmirrorings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.packetMirrorings.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Packetmirrorings$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Packetmirrorings$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Packetmirrorings$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to delete. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Packetmirrorings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to return. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Packetmirrorings$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Packetmirrorings$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to patch. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Projects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.projects.disableXpnHost + * @desc Disable this project as a shared VPC host project. + * @alias compute.projects.disableXpnHost + * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + disableXpnHost( + params?: Params$Resource$Projects$Disablexpnhost, + options?: MethodOptions + ): GaxiosPromise; + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, + callback: BodyResponseCallback + ): void; + disableXpnHost(callback: BodyResponseCallback): void; + disableXpnHost( + paramsOrCallback?: + | Params$Resource$Projects$Disablexpnhost + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Disablexpnhost; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Disablexpnhost; + 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}/disableXpnHost' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.disableXpnResource + * @desc Disable a service resource (also known as service project) associated with this host project. + * @alias compute.projects.disableXpnResource + * @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 {().ProjectsDisableXpnResourceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + disableXpnResource( + params?: Params$Resource$Projects$Disablexpnresource, + options?: MethodOptions + ): GaxiosPromise; + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, + callback: BodyResponseCallback + ): void; + disableXpnResource(callback: BodyResponseCallback): void; + disableXpnResource( + paramsOrCallback?: + | Params$Resource$Projects$Disablexpnresource + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Disablexpnresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Disablexpnresource; + 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}/disableXpnResource' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.enableXpnHost + * @desc Enable this project as a shared VPC host project. + * @alias compute.projects.enableXpnHost + * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + enableXpnHost( + params?: Params$Resource$Projects$Enablexpnhost, + options?: MethodOptions + ): GaxiosPromise; + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, + callback: BodyResponseCallback + ): void; + enableXpnHost(callback: BodyResponseCallback): void; + enableXpnHost( + paramsOrCallback?: + | Params$Resource$Projects$Enablexpnhost + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Enablexpnhost; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Enablexpnhost; + 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}/enableXpnHost' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.projects.enableXpnResource + * @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 {().ProjectsEnableXpnResourceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + enableXpnResource( + params?: Params$Resource$Projects$Enablexpnresource, + options?: MethodOptions + ): GaxiosPromise; + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, + callback: BodyResponseCallback + ): void; + enableXpnResource(callback: BodyResponseCallback): void; + enableXpnResource( + paramsOrCallback?: + | Params$Resource$Projects$Enablexpnresource + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Enablexpnresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Enablexpnresource; + 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}/enableXpnResource' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.get + * @desc Returns the specified Project resource. + * @alias compute.projects.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/compute/alpha/projects/{project}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.getXpnHost + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. + * @alias compute.projects.getXpnHost + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getXpnHost( + params?: Params$Resource$Projects$Getxpnhost, + options?: MethodOptions + ): GaxiosPromise; + getXpnHost( + params: Params$Resource$Projects$Getxpnhost, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getXpnHost( + params: Params$Resource$Projects$Getxpnhost, + callback: BodyResponseCallback + ): void; + getXpnHost(callback: BodyResponseCallback): void; + getXpnHost( + paramsOrCallback?: + | Params$Resource$Projects$Getxpnhost + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getxpnhost; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getxpnhost; + 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}/getXpnHost' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.getXpnResources + * @desc Gets service resources (a.k.a service project) associated with this host project. + * @alias compute.projects.getXpnResources + * @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.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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getXpnResources( + params?: Params$Resource$Projects$Getxpnresources, + options?: MethodOptions + ): GaxiosPromise; + getXpnResources( + params: Params$Resource$Projects$Getxpnresources, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getXpnResources( + params: Params$Resource$Projects$Getxpnresources, + callback: BodyResponseCallback + ): void; + getXpnResources( + callback: BodyResponseCallback + ): void; + getXpnResources( + paramsOrCallback?: + | Params$Resource$Projects$Getxpnresources + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getxpnresources; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getxpnresources; + 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}/getXpnResources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.listXpnHosts + * @desc Lists all shared VPC host projects visible to the user in an organization. + * @alias compute.projects.listXpnHosts + * @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.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 {().ProjectsListXpnHostsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listXpnHosts( + params?: Params$Resource$Projects$Listxpnhosts, + options?: MethodOptions + ): GaxiosPromise; + listXpnHosts( + params: Params$Resource$Projects$Listxpnhosts, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listXpnHosts( + params: Params$Resource$Projects$Listxpnhosts, + callback: BodyResponseCallback + ): void; + listXpnHosts(callback: BodyResponseCallback): void; + listXpnHosts( + paramsOrCallback?: + | Params$Resource$Projects$Listxpnhosts + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Listxpnhosts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Listxpnhosts; + 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}/listXpnHosts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.moveDisk + * @desc Moves a persistent disk from one zone to another. + * @alias compute.projects.moveDisk + * @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 {().DiskMoveRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + moveDisk( + params?: Params$Resource$Projects$Movedisk, + options?: MethodOptions + ): GaxiosPromise; + moveDisk( + params: Params$Resource$Projects$Movedisk, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + moveDisk( + params: Params$Resource$Projects$Movedisk, + callback: BodyResponseCallback + ): void; + moveDisk(callback: BodyResponseCallback): void; + moveDisk( + paramsOrCallback?: + | Params$Resource$Projects$Movedisk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Movedisk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Movedisk; + 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}/moveDisk' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.moveInstance + * @desc Moves an instance and its attached persistent disks from one zone to another. + * @alias compute.projects.moveInstance + * @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 {().InstanceMoveRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + moveInstance( + params?: Params$Resource$Projects$Moveinstance, + options?: MethodOptions + ): GaxiosPromise; + moveInstance( + params: Params$Resource$Projects$Moveinstance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + moveInstance( + params: Params$Resource$Projects$Moveinstance, + callback: BodyResponseCallback + ): void; + moveInstance(callback: BodyResponseCallback): void; + moveInstance( + paramsOrCallback?: + | Params$Resource$Projects$Moveinstance + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Moveinstance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Moveinstance; + 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}/moveInstance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.projects.setCommonInstanceMetadata + * @desc Sets metadata common to all instances within the specified project using the data included in the request. + * @alias compute.projects.setCommonInstanceMetadata + * @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 {().Metadata} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setCommonInstanceMetadata( + params?: Params$Resource$Projects$Setcommoninstancemetadata, + options?: MethodOptions + ): GaxiosPromise; + setCommonInstanceMetadata( + params: Params$Resource$Projects$Setcommoninstancemetadata, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setCommonInstanceMetadata( + params: Params$Resource$Projects$Setcommoninstancemetadata, + callback: BodyResponseCallback + ): void; + setCommonInstanceMetadata( + callback: BodyResponseCallback + ): void; + setCommonInstanceMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Setcommoninstancemetadata + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Setcommoninstancemetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Setcommoninstancemetadata; + 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}/setCommonInstanceMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.projects.setDefaultNetworkTier + * @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 {().ProjectsSetDefaultNetworkTierRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setDefaultNetworkTier( + params?: Params$Resource$Projects$Setdefaultnetworktier, + options?: MethodOptions + ): GaxiosPromise; + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, + callback: BodyResponseCallback + ): void; + setDefaultNetworkTier( + callback: BodyResponseCallback + ): void; + setDefaultNetworkTier( + paramsOrCallback?: + | Params$Resource$Projects$Setdefaultnetworktier + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Setdefaultnetworktier; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Setdefaultnetworktier; + 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}/setDefaultNetworkTier' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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". + * @alias compute.projects.setDefaultServiceAccount + * @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 {().ProjectsSetDefaultServiceAccountRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setDefaultServiceAccount( + params?: Params$Resource$Projects$Setdefaultserviceaccount, + options?: MethodOptions + ): GaxiosPromise; + setDefaultServiceAccount( + params: Params$Resource$Projects$Setdefaultserviceaccount, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setDefaultServiceAccount( + params: Params$Resource$Projects$Setdefaultserviceaccount, + callback: BodyResponseCallback + ): void; + setDefaultServiceAccount( + callback: BodyResponseCallback + ): void; + setDefaultServiceAccount( + paramsOrCallback?: + | Params$Resource$Projects$Setdefaultserviceaccount + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Setdefaultserviceaccount; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Setdefaultserviceaccount; + 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}/setDefaultServiceAccount' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.projects.setUsageExportBucket + * @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 {().UsageExportLocation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUsageExportBucket( + params?: Params$Resource$Projects$Setusageexportbucket, + options?: MethodOptions + ): GaxiosPromise; + setUsageExportBucket( + params: Params$Resource$Projects$Setusageexportbucket, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUsageExportBucket( + params: Params$Resource$Projects$Setusageexportbucket, + callback: BodyResponseCallback + ): void; + setUsageExportBucket( + callback: BodyResponseCallback + ): void; + setUsageExportBucket( + paramsOrCallback?: + | Params$Resource$Projects$Setusageexportbucket + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Setusageexportbucket; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Setusageexportbucket; + 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}/setUsageExportBucket' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Disablexpnhost + 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; + } + export interface Params$Resource$Projects$Disablexpnresource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectsDisableXpnResourceRequest; + } + export interface Params$Resource$Projects$Enablexpnhost + 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; + } + export interface Params$Resource$Projects$Enablexpnresource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectsEnableXpnResourceRequest; + } + export interface Params$Resource$Projects$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Projects$Getxpnhost + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Projects$Getxpnresources + 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. + */ + order_by?: 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$Projects$Listxpnhosts + 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. + */ + order_by?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectsListXpnHostsRequest; + } + export interface Params$Resource$Projects$Movedisk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DiskMoveRequest; + } + export interface Params$Resource$Projects$Moveinstance + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceMoveRequest; + } + export interface Params$Resource$Projects$Setcommoninstancemetadata + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Metadata; + } + export interface Params$Resource$Projects$Setdefaultnetworktier + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectsSetDefaultNetworkTierRequest; + } + export interface Params$Resource$Projects$Setdefaultserviceaccount + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectsSetDefaultServiceAccountRequest; + } + export interface Params$Resource$Projects$Setusageexportbucket + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UsageExportLocation; + } + + export class Resource$Publicadvertisedprefixes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.publicAdvertisedPrefixes.delete + * @desc Deletes the specified PublicAdvertisedPrefix + * @alias compute.publicAdvertisedPrefixes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicAdvertisedPrefix Name of the PublicAdvertisedPrefix resource to delete. + * @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$Publicadvertisedprefixes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Publicadvertisedprefixes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Publicadvertisedprefixes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Publicadvertisedprefixes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicadvertisedprefixes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicadvertisedprefixes$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}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.publicAdvertisedPrefixes.get + * @desc Returns the specified PublicAdvertisedPrefix resource. + * @alias compute.publicAdvertisedPrefixes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicAdvertisedPrefix Name of the PublicAdvertisedPrefix resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Publicadvertisedprefixes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Publicadvertisedprefixes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Publicadvertisedprefixes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Publicadvertisedprefixes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicadvertisedprefixes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicadvertisedprefixes$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}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.publicAdvertisedPrefixes.insert + * @desc Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. + * @alias compute.publicAdvertisedPrefixes.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 {().PublicAdvertisedPrefix} params.resource Request body data + * @param {object} [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$Publicadvertisedprefixes$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Publicadvertisedprefixes$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Publicadvertisedprefixes$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Publicadvertisedprefixes$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicadvertisedprefixes$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicadvertisedprefixes$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}/global/publicAdvertisedPrefixes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.publicAdvertisedPrefixes.list + * @desc Lists the PublicAdvertisedPrefixes for a project. + * @alias compute.publicAdvertisedPrefixes.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$Publicadvertisedprefixes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Publicadvertisedprefixes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Publicadvertisedprefixes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Publicadvertisedprefixes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicadvertisedprefixes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicadvertisedprefixes$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}/global/publicAdvertisedPrefixes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.publicAdvertisedPrefixes.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicAdvertisedPrefix Name of the PublicAdvertisedPrefix resource to patch. + * @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 {().PublicAdvertisedPrefix} params.resource Request body data + * @param {object} [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$Publicadvertisedprefixes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Publicadvertisedprefixes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Publicadvertisedprefixes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Publicadvertisedprefixes$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicadvertisedprefixes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicadvertisedprefixes$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}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'publicAdvertisedPrefix'], + pathParams: ['project', 'publicAdvertisedPrefix'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Publicadvertisedprefixes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicAdvertisedPrefix resource to delete. + */ + publicAdvertisedPrefix?: 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$Publicadvertisedprefixes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicAdvertisedPrefix resource to return. + */ + publicAdvertisedPrefix?: string; + } + export interface Params$Resource$Publicadvertisedprefixes$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublicAdvertisedPrefix; + } + export interface Params$Resource$Publicadvertisedprefixes$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$Publicadvertisedprefixes$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicAdvertisedPrefix resource to patch. + */ + publicAdvertisedPrefix?: 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$PublicAdvertisedPrefix; + } + + export class Resource$Publicdelegatedprefixes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.publicDelegatedPrefixes.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Publicdelegatedprefixes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Publicdelegatedprefixes$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$PublicDelegatedPrefixAggregatedList + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicdelegatedprefixes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicdelegatedprefixes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/publicDelegatedPrefixes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.publicDelegatedPrefixes.delete + * @desc Deletes the specified PublicDelegatedPrefix in the given region. + * @alias compute.publicDelegatedPrefixes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicDelegatedPrefix Name of the PublicDelegatedPrefix resource to delete. + * @param {string} params.region Name of the region of 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$Publicdelegatedprefixes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Publicdelegatedprefixes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Publicdelegatedprefixes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Publicdelegatedprefixes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicdelegatedprefixes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicdelegatedprefixes$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}/publicDelegatedPrefixes/{publicDelegatedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.publicDelegatedPrefixes.get + * @desc Returns the specified PublicDelegatedPrefix resource in the given region. + * @alias compute.publicDelegatedPrefixes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicDelegatedPrefix Name of the PublicDelegatedPrefix resource to return. + * @param {string} params.region Name of the region of this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Publicdelegatedprefixes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Publicdelegatedprefixes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Publicdelegatedprefixes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Publicdelegatedprefixes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicdelegatedprefixes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicdelegatedprefixes$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}/publicDelegatedPrefixes/{publicDelegatedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.publicDelegatedPrefixes.insert + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region of 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 {().PublicDelegatedPrefix} params.resource Request body data + * @param {object} [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$Publicdelegatedprefixes$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Publicdelegatedprefixes$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Publicdelegatedprefixes$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Publicdelegatedprefixes$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicdelegatedprefixes$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicdelegatedprefixes$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}/publicDelegatedPrefixes' + ).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.publicDelegatedPrefixes.list + * @desc Lists the PublicDelegatedPrefixes for a project in the given region. + * @alias compute.publicDelegatedPrefixes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region of this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Publicdelegatedprefixes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Publicdelegatedprefixes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Publicdelegatedprefixes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Publicdelegatedprefixes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicdelegatedprefixes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicdelegatedprefixes$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}/publicDelegatedPrefixes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.publicDelegatedPrefixes.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.publicDelegatedPrefix Name of the PublicDelegatedPrefix resource to patch. + * @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 {().PublicDelegatedPrefix} params.resource Request body data + * @param {object} [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$Publicdelegatedprefixes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Publicdelegatedprefixes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Publicdelegatedprefixes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Publicdelegatedprefixes$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publicdelegatedprefixes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publicdelegatedprefixes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'publicDelegatedPrefix'], + pathParams: ['project', 'publicDelegatedPrefix', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Publicdelegatedprefixes$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to delete. + */ + publicDelegatedPrefix?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to return. + */ + publicDelegatedPrefix?: string; + /** + * Name of the region of this request. + */ + region?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region of this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublicDelegatedPrefix; + } + export interface Params$Resource$Publicdelegatedprefixes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region of this request. + */ + region?: string; + } + export interface Params$Resource$Publicdelegatedprefixes$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the PublicDelegatedPrefix resource to patch. + */ + publicDelegatedPrefix?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublicDelegatedPrefix; + } + + export class Resource$Regionautoscalers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionAutoscalers.delete + * @desc Deletes the specified autoscaler. + * @alias compute.regionAutoscalers.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.autoscaler Name of the autoscaler to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionautoscalers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionautoscalers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionautoscalers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$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}/autoscalers/{autoscaler}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'autoscaler'], + pathParams: ['autoscaler', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionAutoscalers.get + * @desc Returns the specified autoscaler. + * @alias compute.regionAutoscalers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.autoscaler Name of the autoscaler to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionautoscalers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionautoscalers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionautoscalers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$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}/autoscalers/{autoscaler}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'autoscaler'], + pathParams: ['autoscaler', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionAutoscalers.insert + * @desc Creates an autoscaler in the specified project using the data included in the request. + * @alias compute.regionAutoscalers.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Autoscaler} params.resource Request body data + * @param {object} [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$Regionautoscalers$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionautoscalers$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionautoscalers$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$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}/autoscalers' + ).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.regionAutoscalers.list + * @desc Retrieves a list of autoscalers contained within the specified region. + * @alias compute.regionAutoscalers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionautoscalers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionautoscalers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionautoscalers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$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}/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.regionAutoscalers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.autoscaler Name of the autoscaler to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Autoscaler} params.resource Request body data + * @param {object} [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$Regionautoscalers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionautoscalers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionautoscalers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionAutoscalers.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionAutoscalers.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionautoscalers$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionautoscalers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionautoscalers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$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/alpha/projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionAutoscalers.update + * @desc Updates an autoscaler in the specified project using the data included in the request. + * @alias compute.regionAutoscalers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.autoscaler Name of the autoscaler to update. + * @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 {().Autoscaler} params.resource Request body data + * @param {object} [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$Regionautoscalers$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regionautoscalers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regionautoscalers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regionautoscalers$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionautoscalers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionautoscalers$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}/regions/{region}/autoscalers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionautoscalers$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to delete. + */ + autoscaler?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionautoscalers$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to return. + */ + autoscaler?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionautoscalers$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Autoscaler; + } + export interface Params$Resource$Regionautoscalers$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionautoscalers$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to patch. + */ + autoscaler?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Autoscaler; + } + export interface Params$Resource$Regionautoscalers$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regionautoscalers$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the autoscaler to update. + */ + autoscaler?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Autoscaler; + } + + export class Resource$Regionbackendservices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionBackendServices.delete + * @desc Deletes the specified regional BackendService resource. + * @alias compute.regionBackendServices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionbackendservices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionbackendservices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionbackendservices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$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}/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionBackendServices.get + * @desc Returns the specified regional BackendService resource. + * @alias compute.regionBackendServices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionbackendservices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionbackendservices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionbackendservices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$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}/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionBackendServices.getHealth + * @desc Gets the most recent health check results for this regional BackendService. + * @alias compute.regionBackendServices.getHealth + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource for which to get health. + * @param {string} params.project + * @param {string} params.region Name of the region scoping this request. + * @param {().ResourceGroupReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getHealth( + params?: Params$Resource$Regionbackendservices$Gethealth, + options?: MethodOptions + ): GaxiosPromise; + getHealth( + params: Params$Resource$Regionbackendservices$Gethealth, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHealth( + params: Params$Resource$Regionbackendservices$Gethealth, + callback: BodyResponseCallback + ): void; + getHealth( + callback: BodyResponseCallback + ): void; + getHealth( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Gethealth + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Gethealth; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$Gethealth; + 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}/backendServices/{backendService}/getHealth' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionBackendServices.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().BackendService} params.resource Request body data + * @param {object} [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$Regionbackendservices$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionbackendservices$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionbackendservices$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$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}/backendServices' + ).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.regionBackendServices.list + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. + * @alias compute.regionBackendServices.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionbackendservices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionbackendservices$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionbackendservices$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$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}/backendServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.regionBackendServices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().BackendService} params.resource Request body data + * @param {object} [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$Regionbackendservices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionbackendservices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionbackendservices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionBackendServices.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionBackendServices.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionbackendservices$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionbackendservices$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionbackendservices$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$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/alpha/projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionBackendServices.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to update. + * @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 {().BackendService} params.resource Request body data + * @param {object} [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$Regionbackendservices$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regionbackendservices$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regionbackendservices$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$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}/regions/{region}/backendServices/{backendService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendService'], + pathParams: ['backendService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionbackendservices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to delete. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionbackendservices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to return. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionbackendservices$Gethealth + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource for which to get health. + */ + backendService?: string; + /** + * + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResourceGroupReference; + } + export interface Params$Resource$Regionbackendservices$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendService; + } + export interface Params$Resource$Regionbackendservices$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionbackendservices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to patch. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendService; + } + export interface Params$Resource$Regionbackendservices$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regionbackendservices$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the BackendService resource to update. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendService; + } + + export class Resource$Regioncommitments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionCommitments.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Regioncommitments$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Regioncommitments$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Regioncommitments$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Regioncommitments$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncommitments$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncommitments$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/commitments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionCommitments.get + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. + * @alias compute.regionCommitments.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.commitment Name of the commitment to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regioncommitments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioncommitments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioncommitments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regioncommitments$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncommitments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncommitments$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}/commitments/{commitment}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'commitment'], + pathParams: ['commitment', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionCommitments.insert + * @desc Creates a commitment in the specified project using the data included in the request. + * @alias compute.regionCommitments.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Commitment} params.resource Request body data + * @param {object} [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$Regioncommitments$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regioncommitments$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioncommitments$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioncommitments$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncommitments$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncommitments$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}/commitments' + ).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.regionCommitments.list + * @desc Retrieves a list of commitments contained within the specified region. + * @alias compute.regionCommitments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regioncommitments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regioncommitments$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioncommitments$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regioncommitments$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncommitments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncommitments$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}/commitments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionCommitments.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionCommitments.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regioncommitments$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regioncommitments$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioncommitments$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regioncommitments$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncommitments$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncommitments$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/alpha/projects/{project}/regions/{region}/commitments/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionCommitments.updateReservations + * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. + * @alias compute.regionCommitments.updateReservations + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.commitment Name of the commitment for which the reservation is being updated. + * @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 {().RegionCommitmentsUpdateReservationsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateReservations( + params?: Params$Resource$Regioncommitments$Updatereservations, + options?: MethodOptions + ): GaxiosPromise; + updateReservations( + params: Params$Resource$Regioncommitments$Updatereservations, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateReservations( + params: Params$Resource$Regioncommitments$Updatereservations, + callback: BodyResponseCallback + ): void; + updateReservations(callback: BodyResponseCallback): void; + updateReservations( + paramsOrCallback?: + | Params$Resource$Regioncommitments$Updatereservations + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncommitments$Updatereservations; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioncommitments$Updatereservations; + 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}/commitments/{commitment}/updateReservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'commitment'], + pathParams: ['commitment', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioncommitments$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Regioncommitments$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the commitment to return. + */ + commitment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regioncommitments$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Commitment; + } + export interface Params$Resource$Regioncommitments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regioncommitments$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regioncommitments$Updatereservations + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the commitment for which the reservation is being updated. + */ + commitment?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionCommitmentsUpdateReservationsRequest; + } + + export class Resource$Regiondisks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.regionDisks.addResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.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 {().RegionDisksAddResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addResourcePolicies( + params?: Params$Resource$Regiondisks$Addresourcepolicies, + options?: MethodOptions + ): GaxiosPromise; + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + callback: BodyResponseCallback + ): void; + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( + paramsOrCallback?: + | Params$Resource$Regiondisks$Addresourcepolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Addresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Addresourcepolicies; + 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}/disks/{disk}/addResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.createSnapshot + * @desc Creates a snapshot of this regional disk. + * @alias compute.regionDisks.createSnapshot + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk Name of the regional persistent disk to snapshot. + * @param {boolean=} params.guestFlush [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). + * @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 {().Snapshot} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createSnapshot( + params?: Params$Resource$Regiondisks$Createsnapshot, + options?: MethodOptions + ): GaxiosPromise; + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, + callback: BodyResponseCallback + ): void; + createSnapshot(callback: BodyResponseCallback): void; + createSnapshot( + paramsOrCallback?: + | Params$Resource$Regiondisks$Createsnapshot + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Createsnapshot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Createsnapshot; + 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}/disks/{disk}/createSnapshot' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionDisks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk Name of the regional persistent disk to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regiondisks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regiondisks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regiondisks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regiondisks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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}/disks/{disk}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.get + * @desc Returns a specified regional persistent disk. + * @alias compute.regionDisks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk Name of the regional persistent disk to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regiondisks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiondisks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiondisks$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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}/disks/{disk}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.regionDisks.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.region The name of the region 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$Regiondisks$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Regiondisks$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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/alpha/projects/{project}/regions/{region}/disks/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.insert + * @desc Creates a persistent regional disk in the specified project using the data included in the request. + * @alias compute.regionDisks.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string=} params.sourceImage Optional. Source image to restore onto a disk. + * @param {().Disk} params.resource Request body data + * @param {object} [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$Regiondisks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regiondisks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regiondisks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regiondisks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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}/disks' + ).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.regionDisks.list + * @desc Retrieves the list of persistent disks contained within the specified region. + * @alias compute.regionDisks.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regiondisks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiondisks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiondisks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiondisks$List + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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}/disks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.removeResourcePolicies + * @desc Removes resource policies from a regional disk. + * @alias compute.regionDisks.removeResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.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 {().RegionDisksRemoveResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeResourcePolicies( + params?: Params$Resource$Regiondisks$Removeresourcepolicies, + options?: MethodOptions + ): GaxiosPromise; + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + callback: BodyResponseCallback + ): void; + removeResourcePolicies( + paramsOrCallback?: + | Params$Resource$Regiondisks$Removeresourcepolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Removeresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Removeresourcepolicies; + 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}/disks/{disk}/removeResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.resize + * @desc Resizes the specified regional persistent disk. + * @alias compute.regionDisks.resize + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk Name of the regional persistent disk. + * @param {string} params.project The 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 {().RegionDisksResizeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resize( + params?: Params$Resource$Regiondisks$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Regiondisks$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Regiondisks$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Regiondisks$Resize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Resize; + 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}/disks/{disk}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.regionDisks.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetPolicyRequest} params.resource Request body data + * @param {object} [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$Regiondisks$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Regiondisks$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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/alpha/projects/{project}/regions/{region}/disks/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.setLabels + * @desc Sets the labels on the target regional disk. + * @alias compute.regionDisks.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Regiondisks$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Regiondisks$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Regiondisks$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Regiondisks$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Setlabels; + 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}/disks/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDisks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionDisks.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regiondisks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regiondisks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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/alpha/projects/{project}/regions/{region}/disks/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regiondisks$Addresourcepolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; + } + export interface Params$Resource$Regiondisks$Createsnapshot + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the regional persistent disk to snapshot. + */ + disk?: string; + /** + * [Input Only] Specifies to create an application consistent snapshot 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; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Snapshot; + } + export interface Params$Resource$Regiondisks$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the regional persistent disk to delete. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regiondisks$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the regional persistent disk to return. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisks$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; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regiondisks$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Source image to restore onto a disk. + */ + sourceImage?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Disk; + } + export interface Params$Resource$Regiondisks$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisks$Removeresourcepolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; + } + export interface Params$Resource$Regiondisks$Resize + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the regional persistent disk. + */ + disk?: string; + /** + * The project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksResizeRequest; + } + export interface Params$Resource$Regiondisks$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regiondisks$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Regiondisks$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regiondisktypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionDiskTypes.get + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. + * @alias compute.regionDiskTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.diskType Name of the disk type to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regiondisktypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiondisktypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisktypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiondisktypes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisktypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisktypes$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}/diskTypes/{diskType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'diskType'], + pathParams: ['diskType', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionDiskTypes.list + * @desc Retrieves a list of regional disk types available to the specified project. + * @alias compute.regionDiskTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regiondisktypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiondisktypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiondisktypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiondisktypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisktypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisktypes$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}/diskTypes' + ).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$Regiondisktypes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the disk type to return. + */ + diskType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisktypes$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 for this request. + */ + region?: string; + } + + export class Resource$Regionhealthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionHealthChecks.delete + * @desc Deletes the specified HealthCheck resource. + * @alias compute.regionHealthChecks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionhealthchecks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionhealthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionhealthchecks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthChecks.get + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @alias compute.regionHealthChecks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionhealthchecks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionhealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthchecks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthChecks.insert + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.regionHealthChecks.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheck} params.resource Request body data + * @param {object} [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$Regionhealthchecks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionhealthchecks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthchecks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/healthChecks' + ).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.regionHealthChecks.list + * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @alias compute.regionHealthChecks.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionhealthchecks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionhealthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionhealthchecks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/healthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.regionHealthChecks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheck} params.resource Request body data + * @param {object} [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$Regionhealthchecks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionhealthchecks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthchecks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthChecks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionHealthChecks.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionhealthchecks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionhealthchecks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthchecks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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/alpha/projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthChecks.update + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.regionHealthChecks.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to update. + * @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 {().HealthCheck} params.resource Request body data + * @param {object} [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$Regionhealthchecks$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regionhealthchecks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regionhealthchecks$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/regions/{region}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionhealthchecks$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to delete. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionhealthchecks$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to return. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthchecks$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthchecks$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to patch. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regionhealthchecks$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to update. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + + export class Resource$Regionhealthcheckservices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionHealthCheckServices.delete + * @desc Deletes the specified regional HealthCheckService. + * @alias compute.regionHealthCheckServices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheckService Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionhealthcheckservices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.get + * @desc Returns the specified regional HealthCheckService resource. + * @alias compute.regionHealthCheckServices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheckService Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionhealthcheckservices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionhealthcheckservices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthcheckservices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.insert + * @desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. + * @alias compute.regionHealthCheckServices.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheckService} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Regionhealthcheckservices$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.list + * @desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region. + * @alias compute.regionHealthCheckServices.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionhealthcheckservices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionhealthcheckservices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionhealthcheckservices$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionHealthCheckServices.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionhealthcheckservices$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$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/alpha/projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionhealthcheckservices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheckService; + } + export interface Params$Resource$Regionhealthcheckservices$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regioninstancegroupmanagers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.regionInstanceGroupManagers.abandonInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersAbandonInstancesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + abandonInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + options?: MethodOptions + ): GaxiosPromise; + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + callback: BodyResponseCallback + ): void; + abandonInstances(callback: BodyResponseCallback): void; + abandonInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Abandoninstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + 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}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' + ).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.applyUpdatesToInstances + * @desc Apply updates to selected instances the managed instance group. + * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group, should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request, should conform to RFC1035. + * @param {().RegionInstanceGroupManagersApplyUpdatesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + applyUpdatesToInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + options?: MethodOptions + ): GaxiosPromise; + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroupManagers.createInstances + * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. + * @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.resource Request body data + * @param {object} [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/alpha/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. + * @alias compute.regionInstanceGroupManagers.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regioninstancegroupmanagers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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}/instanceGroupManagers/{instanceGroupManager}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionInstanceGroupManagers.deleteInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersDeleteInstancesRequest} params.resource Request body data + * @param {object} [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$Regioninstancegroupmanagers$Deleteinstances, + options?: MethodOptions + ): GaxiosPromise; + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + callback: BodyResponseCallback + ): void; + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Deleteinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + ).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.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.resource Request body data + * @param {object} [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/alpha/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. + * @alias compute.regionInstanceGroupManagers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regioninstancegroupmanagers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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}/instanceGroupManagers/{instanceGroupManager}' + ).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(parameters); + } + } + + /** + * 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. + * @alias compute.regionInstanceGroupManagers.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().InstanceGroupManager} params.resource Request body data + * @param {object} [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$Regioninstancegroupmanagers$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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}/instanceGroupManagers' + ).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.regionInstanceGroupManagers.list + * @desc Retrieves the list of managed instance groups that are contained within the specified region. + * @alias compute.regionInstanceGroupManagers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regioninstancegroupmanagers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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}/instanceGroupManagers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.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/alpha/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. + * @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/alpha/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/alpha/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. + * @alias compute.regionInstanceGroupManagers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @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.resource Request body data + * @param {object} [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, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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 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 {().RegionInstanceGroupManagerPatchInstanceConfigReq} params.resource Request body data + * @param {object} [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$Regioninstancegroupmanagers$Patchperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' + ).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.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. + * @alias compute.regionInstanceGroupManagers.recreateInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersRecreateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + recreateInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + options?: MethodOptions + ): GaxiosPromise; + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + callback: BodyResponseCallback + ): void; + recreateInstances(callback: BodyResponseCallback): void; + recreateInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Recreateinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + 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}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' + ).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.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. + * @alias compute.regionInstanceGroupManagers.resize + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {integer} params.size Number of instances that should exist in this instance group manager. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resize( + params?: Params$Resource$Regioninstancegroupmanagers$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Resize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + 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}/instanceGroupManagers/{instanceGroupManager}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionInstanceGroupManagers.setAutoHealingPolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersSetAutoHealingRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setAutoHealingPolicies( + params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options?: MethodOptions + ): GaxiosPromise; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + 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}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + ).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.setInstanceTemplate + * @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! () + * + * @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.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 {().RegionInstanceGroupManagersSetTemplateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setInstanceTemplate( + params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + options?: MethodOptions + ): GaxiosPromise; + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + callback: BodyResponseCallback + ): void; + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + 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}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + ).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.setTargetPools + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersSetTargetPoolsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setTargetPools( + params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options?: MethodOptions + ): GaxiosPromise; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + callback: BodyResponseCallback + ): void; + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + 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}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + ).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.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionInstanceGroupManagers.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionInstanceGroupManagers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @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.resource Request body data + * @param {object} [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$Regioninstancegroupmanagers$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$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}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + 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.resource Request body data + * @param {object} [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/alpha/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 + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group, should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Createinstances + extends StandardParameters { + /** + * 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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group to delete. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group to return. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroupmanagers$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManager; + } + export interface Params$Resource$Regioninstancegroupmanagers$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$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 { + /** + * 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. + */ + 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. + */ + order_by?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$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 { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersRecreateRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Resize + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Number of instances that should exist in this instance group manager. + */ + size?: number; + } + export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSetAutoHealingRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSetTemplateRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSetTargetPoolsRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionInstanceGroups.get + * @desc Returns the specified instance group resource. + * @alias compute.regionInstanceGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup Name of the instance group resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regioninstancegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$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}/instanceGroups/{instanceGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroups.list + * @desc Retrieves the list of instance group resources contained within the specified region. + * @alias compute.regionInstanceGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regioninstancegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstancegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstancegroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$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}/instanceGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.regionInstanceGroups.listInstances + * @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.instanceGroup Name of the regional instance group for which we want to list the instances. + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {().RegionInstanceGroupsListInstancesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listInstances( + params?: Params$Resource$Regioninstancegroups$Listinstances, + options?: MethodOptions + ): GaxiosPromise; + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, + callback: BodyResponseCallback + ): void; + listInstances( + callback: BodyResponseCallback + ): void; + listInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Listinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Listinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$Listinstances; + 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}/instanceGroups/{instanceGroup}/listInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.regionInstanceGroups.setNamedPorts + * @desc Sets the named ports for the specified regional instance group. + * @alias compute.regionInstanceGroups.setNamedPorts + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup The name of the regional instance group where the named ports are updated. + * @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 {().RegionInstanceGroupsSetNamedPortsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setNamedPorts( + params?: Params$Resource$Regioninstancegroups$Setnamedports, + options?: MethodOptions + ): GaxiosPromise; + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + callback: BodyResponseCallback + ): void; + setNamedPorts(callback: BodyResponseCallback): void; + setNamedPorts( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Setnamedports + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Setnamedports; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$Setnamedports; + 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}/instanceGroups/{instanceGroup}/setNamedPorts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroups.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionInstanceGroups.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regioninstancegroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$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/alpha/projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioninstancegroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance group resource to return. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroups$Listinstances + 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; + /** + * Name of the regional instance group for which we want to list the instances. + */ + instanceGroup?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; + } + export interface Params$Resource$Regioninstancegroups$Setnamedports + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the regional instance group where the named ports are updated. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupsSetNamedPortsRequest; + } + export interface Params$Resource$Regioninstancegroups$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionnotificationendpoints { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionNotificationEndpoints.delete + * @desc Deletes the specified NotificationEndpoint in the given region + * @alias compute.regionNotificationEndpoints.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.notificationEndpoint Name of the NotificationEndpoint resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionnotificationendpoints$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionnotificationendpoints$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionnotificationendpoints$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'notificationEndpoint'], + pathParams: ['notificationEndpoint', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNotificationEndpoints.get + * @desc Returns the specified NotificationEndpoint resource in the given region. + * @alias compute.regionNotificationEndpoints.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.notificationEndpoint Name of the NotificationEndpoint resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionnotificationendpoints$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionnotificationendpoints$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionnotificationendpoints$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'notificationEndpoint'], + pathParams: ['notificationEndpoint', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNotificationEndpoints.insert + * @desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. + * @alias compute.regionNotificationEndpoints.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NotificationEndpoint} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Regionnotificationendpoints$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionnotificationendpoints$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionnotificationendpoints$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/notificationEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNotificationEndpoints.list + * @desc Lists the NotificationEndpoints for a project in the given region. + * @alias compute.regionNotificationEndpoints.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionnotificationendpoints$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionnotificationendpoints$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionnotificationendpoints$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/notificationEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNotificationEndpoints.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionNotificationEndpoints.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionnotificationendpoints$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionnotificationendpoints$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionnotificationendpoints$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$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/alpha/projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionnotificationendpoints$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NotificationEndpoint resource to delete. + */ + notificationEndpoint?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnotificationendpoints$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NotificationEndpoint resource to return. + */ + notificationEndpoint?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnotificationendpoints$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NotificationEndpoint; + } + export interface Params$Resource$Regionnotificationendpoints$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnotificationendpoints$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionoperations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionOperations.delete + * @desc Deletes the specified region-specific Operations resource. + * @alias compute.regionOperations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to delete. + * @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 + */ + delete( + params?: Params$Resource$Regionoperations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionoperations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionoperations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionoperations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$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}/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'operation'], + pathParams: ['operation', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionOperations.get + * @desc Retrieves the specified region-specific Operations resource. + * @alias compute.regionOperations.get + * @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 + */ + get( + params?: Params$Resource$Regionoperations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionoperations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionoperations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionoperations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$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}/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'operation'], + pathParams: ['operation', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionOperations.list + * @desc Retrieves a list of Operation resources contained within the specified region. + * @alias compute.regionOperations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionoperations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionoperations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionoperations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionoperations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$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}/operations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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/alpha/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 + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to delete. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regionoperations$Get + 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 interface Params$Resource$Regionoperations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regions.get + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. + * @alias compute.regions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regions$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}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regions.list + * @desc Retrieves the list of region resources available to the specified project. + * @alias compute.regions.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$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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/regions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regions$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region resource to return. + */ + region?: string; + } + export interface Params$Resource$Regions$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 class Resource$Regionsslcertificates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionSslCertificates.delete + * @desc Deletes the specified SslCertificate resource in the region. + * @alias compute.regionSslCertificates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.sslCertificate Name of the SslCertificate resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionsslcertificates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionsslcertificates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionsslcertificates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$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}/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionSslCertificates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.sslCertificate Name of the SslCertificate resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionsslcertificates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionsslcertificates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionsslcertificates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$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}/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionSslCertificates.insert + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request + * @alias compute.regionSslCertificates.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().SslCertificate} params.resource Request body data + * @param {object} [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$Regionsslcertificates$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionsslcertificates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionsslcertificates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$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}/sslCertificates' + ).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.regionSslCertificates.list + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. + * @alias compute.regionSslCertificates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionsslcertificates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionsslcertificates$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionsslcertificates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$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}/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionSslCertificates.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource and region. + * @alias compute.regionSslCertificates.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionsslcertificates$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionsslcertificates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionsslcertificates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$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/alpha/projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionsslcertificates$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the SslCertificate resource to delete. + */ + sslCertificate?: string; + } + export interface Params$Resource$Regionsslcertificates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the SslCertificate resource to return. + */ + sslCertificate?: string; + } + export interface Params$Resource$Regionsslcertificates$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslCertificate; + } + export interface Params$Resource$Regionsslcertificates$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionsslcertificates$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regiontargethttpproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionTargetHttpProxies.delete + * @desc Deletes the specified TargetHttpProxy resource. + * @alias compute.regionTargetHttpProxies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regiontargethttpproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regiontargethttpproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regiontargethttpproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$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}/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionTargetHttpProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regiontargethttpproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiontargethttpproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiontargethttpproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$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}/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpProxies.insert + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. + * @alias compute.regionTargetHttpProxies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().TargetHttpProxy} params.resource Request body data + * @param {object} [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$Regiontargethttpproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regiontargethttpproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regiontargethttpproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$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}/targetHttpProxies' + ).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.regionTargetHttpProxies.list + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. + * @alias compute.regionTargetHttpProxies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regiontargethttpproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiontargethttpproxies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiontargethttpproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$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}/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpProxies.setUrlMap + * @desc Changes the URL map for TargetHttpProxy. + * @alias compute.regionTargetHttpProxies.setUrlMap + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy to set a URL map for. + * @param {().UrlMapReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUrlMap( + params?: Params$Resource$Regiontargethttpproxies$Seturlmap, + options?: MethodOptions + ): GaxiosPromise; + setUrlMap( + params: Params$Resource$Regiontargethttpproxies$Seturlmap, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUrlMap( + params: Params$Resource$Regiontargethttpproxies$Seturlmap, + callback: BodyResponseCallback + ): void; + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Seturlmap + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Seturlmap; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Seturlmap; + 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}/targetHttpProxies/{targetHttpProxy}/setUrlMap' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpProxies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionTargetHttpProxies.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regiontargethttpproxies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regiontargethttpproxies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regiontargethttpproxies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$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/alpha/projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regiontargethttpproxies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpProxy resource to delete. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the TargetHttpProxy resource to return. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpProxy; + } + export interface Params$Resource$Regiontargethttpproxies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Seturlmap + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpProxy to set a URL map for. + */ + targetHttpProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapReference; + } + export interface Params$Resource$Regiontargethttpproxies$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regiontargethttpsproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionTargetHttpsProxies.delete + * @desc Deletes the specified TargetHttpsProxy resource. + * @alias compute.regionTargetHttpsProxies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regiontargethttpsproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regiontargethttpsproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regiontargethttpsproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$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}/targetHttpsProxies/{targetHttpsProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionTargetHttpsProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regiontargethttpsproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiontargethttpsproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiontargethttpsproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$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}/targetHttpsProxies/{targetHttpsProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpsProxies.insert + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. + * @alias compute.regionTargetHttpsProxies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().TargetHttpsProxy} params.resource Request body data + * @param {object} [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$Regiontargethttpsproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regiontargethttpsproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regiontargethttpsproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$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}/targetHttpsProxies' + ).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.regionTargetHttpsProxies.list + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. + * @alias compute.regionTargetHttpsProxies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regiontargethttpsproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiontargethttpsproxies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiontargethttpsproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$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}/targetHttpsProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpsProxies.setSslCertificates + * @desc Replaces SslCertificates for TargetHttpsProxy. + * @alias compute.regionTargetHttpsProxies.setSslCertificates + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + * @param {().RegionTargetHttpsProxiesSetSslCertificatesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSslCertificates( + params?: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + options?: MethodOptions + ): GaxiosPromise; + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + callback: BodyResponseCallback + ): void; + setSslCertificates(callback: BodyResponseCallback): void; + setSslCertificates( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Setsslcertificates + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Setsslcertificates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Setsslcertificates; + 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}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpsProxies.setUrlMap + * @desc Changes the URL map for TargetHttpsProxy. + * @alias compute.regionTargetHttpsProxies.setUrlMap + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy to set a URL map for. + * @param {().UrlMapReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUrlMap( + params?: Params$Resource$Regiontargethttpsproxies$Seturlmap, + options?: MethodOptions + ): GaxiosPromise; + setUrlMap( + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUrlMap( + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, + callback: BodyResponseCallback + ): void; + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Seturlmap + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Seturlmap; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Seturlmap; + 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}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpsProxies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionTargetHttpsProxies.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regiontargethttpsproxies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regiontargethttpsproxies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regiontargethttpsproxies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$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/alpha/projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regiontargethttpsproxies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpsProxy resource to delete. + */ + targetHttpsProxy?: string; + } + export interface Params$Resource$Regiontargethttpsproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the TargetHttpsProxy resource to return. + */ + targetHttpsProxy?: string; + } + export interface Params$Resource$Regiontargethttpsproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpsProxy; + } + export interface Params$Resource$Regiontargethttpsproxies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regiontargethttpsproxies$Setsslcertificates + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest; + } + export interface Params$Resource$Regiontargethttpsproxies$Seturlmap + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpsProxy to set a URL map for. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapReference; + } + export interface Params$Resource$Regiontargethttpsproxies$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionurlmaps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionUrlMaps.delete + * @desc Deletes the specified UrlMap resource. + * @alias compute.regionUrlMaps.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionurlmaps$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionurlmaps$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionurlmaps$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$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}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.get + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @alias compute.regionUrlMaps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.urlMap Name of the UrlMap resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionurlmaps$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionurlmaps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionurlmaps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$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}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.insert + * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @alias compute.regionUrlMaps.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Regionurlmaps$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionurlmaps$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionurlmaps$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$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}/urlMaps' + ).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.regionUrlMaps.invalidateCache + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @alias compute.regionUrlMaps.invalidateCache + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap scoping this request. + * @param {().CacheInvalidationRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + invalidateCache( + params?: Params$Resource$Regionurlmaps$Invalidatecache, + options?: MethodOptions + ): GaxiosPromise; + invalidateCache( + params: Params$Resource$Regionurlmaps$Invalidatecache, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invalidateCache( + params: Params$Resource$Regionurlmaps$Invalidatecache, + callback: BodyResponseCallback + ): void; + invalidateCache(callback: BodyResponseCallback): void; + invalidateCache( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Invalidatecache + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Invalidatecache; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Invalidatecache; + 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}/urlMaps/{urlMap}/invalidateCache' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.list + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. + * @alias compute.regionUrlMaps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionurlmaps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionurlmaps$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionurlmaps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$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}/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.regionUrlMaps.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap resource to patch. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Regionurlmaps$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionurlmaps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionurlmaps$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionUrlMaps.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionurlmaps$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionurlmaps$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionurlmaps$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$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/alpha/projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.update + * @desc Updates the specified UrlMap resource with the data included in the request. + * @alias compute.regionUrlMaps.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap resource to update. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Regionurlmaps$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regionurlmaps$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regionurlmaps$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$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}/regions/{region}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionUrlMaps.validate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.urlMap Name of the UrlMap resource to be validated as. + * @param {().RegionUrlMapsValidateRequest} params.resource Request body data + * @param {object} [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$Regionurlmaps$Validate, + options?: MethodOptions + ): GaxiosPromise; + validate( + params: Params$Resource$Regionurlmaps$Validate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validate( + params: Params$Resource$Regionurlmaps$Validate, + callback: BodyResponseCallback + ): void; + validate( + callback: BodyResponseCallback + ): void; + validate( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Validate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Validate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Validate; + 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}/urlMaps/{urlMap}/validate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionurlmaps$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to delete. + */ + urlMap?: string; + } + export interface Params$Resource$Regionurlmaps$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the UrlMap resource to return. + */ + urlMap?: string; + } + export interface Params$Resource$Regionurlmaps$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Invalidatecache + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap scoping this request. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CacheInvalidationRule; + } + export interface Params$Resource$Regionurlmaps$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionurlmaps$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to patch. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regionurlmaps$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to update. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Validate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the UrlMap resource to be validated as. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionUrlMapsValidateRequest; + } + + export class Resource$Reservations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.reservations.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Reservations$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Reservations$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Reservations$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Reservations$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/reservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.delete + * @desc Deletes the specified reservation. + * @alias compute.reservations.delete + * @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.reservation Name of the reservation to delete. + * @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 + */ + delete( + params?: Params$Resource$Reservations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Reservations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Reservations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Reservations$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/zones/{zone}/reservations/{reservation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.get + * @desc Retrieves information about the specified reservation. + * @alias compute.reservations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.reservation Name of the reservation to retrieve. + * @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 + */ + get( + params?: Params$Resource$Reservations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Reservations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Reservations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reservations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/zones/{zone}/reservations/{reservation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.reservations.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 {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Reservations$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Reservations$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Reservations$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Reservations$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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/alpha/projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.insert + * @desc Creates a new reservation. For more information, read Reserving zonal resources. + * @alias compute.reservations.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.zone Name of the zone for this request. + * @param {().Reservation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Reservations$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Reservations$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Reservations$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Reservations$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/zones/{zone}/reservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.list + * @desc A list of all the reservations that have been configured for the specified project in specified zone. + * @alias compute.reservations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone Name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Reservations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Reservations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Reservations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/zones/{zone}/reservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.resize + * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. + * @alias compute.reservations.resize + * @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.reservation Name of the reservation to update. + * @param {string} params.zone Name of the zone for this request. + * @param {().ReservationsResizeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resize( + params?: Params$Resource$Reservations$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Reservations$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Reservations$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Reservations$Resize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$Resize; + 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}/reservations/{reservation}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.reservations.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 {string} params.zone The name of the zone for this request. + * @param {().ZoneSetPolicyRequest} params.resource Request body data + * @param {object} [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$Reservations$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Reservations$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Reservations$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Reservations$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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/alpha/projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.reservations.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Reservations$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Reservations$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Reservations$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Reservations$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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/alpha/projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reservations$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Reservations$Delete + 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; + /** + * Name of the reservation to delete. + */ + reservation?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the reservation to retrieve. + */ + reservation?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$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; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$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; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Reservation; + } + export interface Params$Resource$Reservations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$Resize + 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; + /** + * Name of the reservation to update. + */ + reservation?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReservationsResizeRequest; + } + export interface Params$Resource$Reservations$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Reservations$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Resourcepolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.resourcePolicies.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Resourcepolicies$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Resourcepolicies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Resourcepolicies$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/resourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.resourcePolicies.delete + * @desc Deletes the specified resource policy. + * @alias compute.resourcePolicies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resourcePolicy Name of the resource policy 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$Resourcepolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Resourcepolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Resourcepolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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}/resourcePolicies/{resourcePolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resourcePolicy'], + pathParams: ['project', 'region', 'resourcePolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.resourcePolicies.get + * @desc Retrieves all information of the specified resource policy. + * @alias compute.resourcePolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.resourcePolicy Name of the resource policy to retrieve. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Resourcepolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Resourcepolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Resourcepolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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}/resourcePolicies/{resourcePolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resourcePolicy'], + pathParams: ['project', 'region', 'resourcePolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.resourcePolicies.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.resourcePolicies.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.region The name of the region 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$Resourcepolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Resourcepolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Resourcepolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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/alpha/projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.resourcePolicies.insert + * @desc Creates a new resource policy. + * @alias compute.resourcePolicies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().ResourcePolicy} params.resource Request body data + * @param {object} [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$Resourcepolicies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Resourcepolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Resourcepolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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}/resourcePolicies' + ).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.resourcePolicies.list + * @desc A list all the resource policies that have been configured for the specified project in specified region. + * @alias compute.resourcePolicies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Resourcepolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Resourcepolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Resourcepolicies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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}/resourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.resourcePolicies.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.resourcePolicies.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetPolicyRequest} params.resource Request body data + * @param {object} [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$Resourcepolicies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Resourcepolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Resourcepolicies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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/alpha/projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.resourcePolicies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.resourcePolicies.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Resourcepolicies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Resourcepolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Resourcepolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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/alpha/projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Resourcepolicies$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Resourcepolicies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the resource policy to delete. + */ + resourcePolicy?: string; + } + export interface Params$Resource$Resourcepolicies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the resource policy to retrieve. + */ + resourcePolicy?: string; + } + export interface Params$Resource$Resourcepolicies$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; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Resourcepolicies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResourcePolicy; + } + export interface Params$Resource$Resourcepolicies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Resourcepolicies$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Resourcepolicies$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Routers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.routers.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Routers$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Routers$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Routers$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Routers$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/aggregated/routers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routers.delete + * @desc Deletes the specified Router resource. + * @alias compute.routers.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.router Name of the Router resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Routers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Routers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Routers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Routers$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$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}/routers/{router}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routers.get + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. + * @alias compute.routers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.router Name of the Router resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Routers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Routers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Routers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Routers$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$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}/routers/{router}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routers.getNatMappingInfo + * @desc Retrieves runtime Nat mapping information of VM endpoints. + * @alias compute.routers.getNatMappingInfo + * @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.natName Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.router Name of the Router resource to query for Nat Mapping information of VM endpoints. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getNatMappingInfo( + params?: Params$Resource$Routers$Getnatmappinginfo, + options?: MethodOptions + ): GaxiosPromise; + getNatMappingInfo( + params: Params$Resource$Routers$Getnatmappinginfo, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getNatMappingInfo( + params: Params$Resource$Routers$Getnatmappinginfo, + callback: BodyResponseCallback + ): void; + getNatMappingInfo( + callback: BodyResponseCallback + ): void; + getNatMappingInfo( + paramsOrCallback?: + | Params$Resource$Routers$Getnatmappinginfo + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Getnatmappinginfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Getnatmappinginfo; + 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}/routers/{router}/getNatMappingInfo' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routers.getRouterStatus + * @desc Retrieves runtime information of the specified router. + * @alias compute.routers.getRouterStatus + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.router Name of the Router resource to query. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getRouterStatus( + params?: Params$Resource$Routers$Getrouterstatus, + options?: MethodOptions + ): GaxiosPromise; + getRouterStatus( + params: Params$Resource$Routers$Getrouterstatus, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRouterStatus( + params: Params$Resource$Routers$Getrouterstatus, + callback: BodyResponseCallback + ): void; + getRouterStatus( + callback: BodyResponseCallback + ): void; + getRouterStatus( + paramsOrCallback?: + | Params$Resource$Routers$Getrouterstatus + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Getrouterstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Getrouterstatus; + 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}/routers/{router}/getRouterStatus' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routers.insert + * @desc Creates a Router resource in the specified project and region using the data included in the request. + * @alias compute.routers.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Router} params.resource Request body data + * @param {object} [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$Routers$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Routers$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Routers$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Routers$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$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}/routers' + ).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.routers.list + * @desc Retrieves a list of Router resources available to the specified project. + * @alias compute.routers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Routers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Routers$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Routers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Routers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$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}/routers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.routers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.router Name of the Router resource to patch. + * @param {().Router} params.resource Request body data + * @param {object} [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$Routers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Routers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Routers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Routers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/routers/{router}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routers.preview + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.router Name of the Router resource to query. + * @param {().Router} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + preview( + params?: Params$Resource$Routers$Preview, + options?: MethodOptions + ): GaxiosPromise; + preview( + params: Params$Resource$Routers$Preview, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + preview( + params: Params$Resource$Routers$Preview, + callback: BodyResponseCallback + ): void; + preview( + callback: BodyResponseCallback + ): void; + preview( + paramsOrCallback?: + | Params$Resource$Routers$Preview + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routers$Preview; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Preview; + 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}/routers/{router}/preview' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routers.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.routers.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Routers$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Routers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Routers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Routers$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$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/alpha/projects/{project}/regions/{region}/routers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.routers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.router Name of the Router resource to update. + * @param {().Router} params.resource Request body data + * @param {object} [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$Routers$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Routers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Routers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Routers$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$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}/regions/{region}/routers/{router}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Routers$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Routers$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Router resource to delete. + */ + router?: string; + } + export interface Params$Resource$Routers$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to return. + */ + router?: string; + } + export interface Params$Resource$Routers$Getnatmappinginfo + 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; + /** + * Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035. + */ + natName?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to query for Nat Mapping information of VM endpoints. + */ + router?: string; + } + export interface Params$Resource$Routers$Getrouterstatus + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to query. + */ + router?: string; + } + export interface Params$Resource$Routers$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Router; + } + export interface Params$Resource$Routers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Routers$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Router resource to patch. + */ + router?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Router; + } + export interface Params$Resource$Routers$Preview extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to query. + */ + router?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Router; + } + export interface Params$Resource$Routers$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Routers$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Router resource to update. + */ + router?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Router; + } + + export class Resource$Routes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.routes.delete + * @desc Deletes the specified Route resource. + * @alias compute.routes.delete + * @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.route Name of the Route resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Routes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Routes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Routes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Routes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routes$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}/global/routes/{route}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'route'], + pathParams: ['project', 'route'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routes.get + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. + * @alias compute.routes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.route Name of the Route resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Routes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Routes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Routes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Routes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routes$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}/global/routes/{route}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'route'], + pathParams: ['project', 'route'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routes.insert + * @desc Creates a Route resource in the specified project using the data included in the request. + * @alias compute.routes.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 {().Route} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Routes$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Routes$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Routes$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Routes$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routes$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routes$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}/global/routes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routes.list + * @desc Retrieves the list of Route resources available to the specified project. + * @alias compute.routes.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$Routes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Routes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Routes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routes$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}/global/routes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.routes.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.routes.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.resource Request body data + * @param {object} [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$Routes$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Routes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Routes$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Routes$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routes$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routes$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/alpha/projects/{project}/global/routes/{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$Routes$Delete 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; + /** + * Name of the Route resource to delete. + */ + route?: string; + } + export interface Params$Resource$Routes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the Route resource to return. + */ + route?: string; + } + export interface Params$Resource$Routes$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Route; + } + export interface Params$Resource$Routes$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$Routes$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$Securitypolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.securityPolicies.addRule + * @desc Inserts a rule into a security policy. + * @alias compute.securityPolicies.addRule + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.securityPolicy Name of the security policy to update. + * @param {boolean=} params.validateOnly If true, the request will not be committed. + * @param {().SecurityPolicyRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addRule( + params?: Params$Resource$Securitypolicies$Addrule, + options?: MethodOptions + ): GaxiosPromise; + addRule( + params: Params$Resource$Securitypolicies$Addrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addRule( + params: Params$Resource$Securitypolicies$Addrule, + callback: BodyResponseCallback + ): void; + addRule(callback: BodyResponseCallback): void; + addRule( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Addrule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Addrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$Addrule; + 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}/global/securityPolicies/{securityPolicy}/addRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'securityPolicy'], + pathParams: ['project', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.delete + * @desc Deletes the specified policy. + * @alias compute.securityPolicies.delete + * @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.securityPolicy Name of the security policy 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$Securitypolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Securitypolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Securitypolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$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}/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'securityPolicy'], + pathParams: ['project', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.get + * @desc List all of the ordered rules present in a single specified policy. + * @alias compute.securityPolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.securityPolicy Name of the security policy 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$Securitypolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Securitypolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Securitypolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$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}/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'securityPolicy'], + pathParams: ['project', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.getRule + * @desc Gets a rule at the specified priority. + * @alias compute.securityPolicies.getRule + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.priority The priority of the rule to get from the security policy. + * @param {string} params.project Project ID for this request. + * @param {string} params.securityPolicy Name of the security policy to which the queried rule 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 + */ + getRule( + params?: Params$Resource$Securitypolicies$Getrule, + options?: MethodOptions + ): GaxiosPromise; + getRule( + params: Params$Resource$Securitypolicies$Getrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Securitypolicies$Getrule, + callback: BodyResponseCallback + ): void; + getRule(callback: BodyResponseCallback): void; + getRule( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Getrule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Getrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$Getrule; + 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}/global/securityPolicies/{securityPolicy}/getRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'securityPolicy'], + pathParams: ['project', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.insert + * @desc Creates a new policy in the specified project using the data included in the request. + * @alias compute.securityPolicies.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 {boolean=} params.validateOnly If true, the request will not be committed. + * @param {().SecurityPolicy} params.resource Request body data + * @param {object} [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$Securitypolicies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Securitypolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Securitypolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$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}/global/securityPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.list + * @desc List all the policies that have been configured for the specified project. + * @alias compute.securityPolicies.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$Securitypolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Securitypolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Securitypolicies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Securitypolicies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$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}/global/securityPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.listPreconfiguredExpressionSets + * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. + * @alias compute.securityPolicies.listPreconfiguredExpressionSets + * @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 + */ + listPreconfiguredExpressionSets( + params?: Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets, + options?: MethodOptions + ): GaxiosPromise< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + >; + listPreconfiguredExpressionSets( + params: Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets, + options: + | MethodOptions + | BodyResponseCallback< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + >, + callback: BodyResponseCallback< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + > + ): void; + listPreconfiguredExpressionSets( + params: Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets, + callback: BodyResponseCallback< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + > + ): void; + listPreconfiguredExpressionSets( + callback: BodyResponseCallback< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + > + ): void; + listPreconfiguredExpressionSets( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets + | BodyResponseCallback< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + >, + callback?: BodyResponseCallback< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + > + ): void | GaxiosPromise< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets; + 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}/global/securityPolicies/listPreconfiguredExpressionSets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse + >(parameters); + } + } + + /** + * compute.securityPolicies.patch + * @desc Patches the specified policy with the data included in the request. + * @alias compute.securityPolicies.patch + * @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.securityPolicy Name of the security policy to update. + * @param {().SecurityPolicy} params.resource Request body data + * @param {object} [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$Securitypolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Securitypolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Securitypolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$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}/global/securityPolicies/{securityPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'securityPolicy'], + pathParams: ['project', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.patchRule + * @desc Patches a rule at the specified priority. + * @alias compute.securityPolicies.patchRule + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.priority The priority of the rule to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.securityPolicy Name of the security policy to update. + * @param {boolean=} params.validateOnly If true, the request will not be committed. + * @param {().SecurityPolicyRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patchRule( + params?: Params$Resource$Securitypolicies$Patchrule, + options?: MethodOptions + ): GaxiosPromise; + patchRule( + params: Params$Resource$Securitypolicies$Patchrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Securitypolicies$Patchrule, + callback: BodyResponseCallback + ): void; + patchRule(callback: BodyResponseCallback): void; + patchRule( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Patchrule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Patchrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$Patchrule; + 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}/global/securityPolicies/{securityPolicy}/patchRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'securityPolicy'], + pathParams: ['project', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.removeRule + * @desc Deletes a rule at the specified priority. + * @alias compute.securityPolicies.removeRule + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.priority The priority of the rule to remove from the security policy. + * @param {string} params.project Project ID for this request. + * @param {string} params.securityPolicy Name of the security policy to update. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeRule( + params?: Params$Resource$Securitypolicies$Removerule, + options?: MethodOptions + ): GaxiosPromise; + removeRule( + params: Params$Resource$Securitypolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Securitypolicies$Removerule, + callback: BodyResponseCallback + ): void; + removeRule(callback: BodyResponseCallback): void; + removeRule( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Removerule + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Removerule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$Removerule; + 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}/global/securityPolicies/{securityPolicy}/removeRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'securityPolicy'], + pathParams: ['project', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.securityPolicies.setLabels + * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.securityPolicies.setLabels + * @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 {().GlobalSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Securitypolicies$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Securitypolicies$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Securitypolicies$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$Setlabels; + 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}/global/securityPolicies/{resource}/setLabels' + ).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.securityPolicies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.securityPolicies.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.resource Request body data + * @param {object} [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$Securitypolicies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Securitypolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Securitypolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Securitypolicies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Securitypolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Securitypolicies$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/alpha/projects/{project}/global/securityPolicies/{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$Securitypolicies$Addrule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } + export interface Params$Resource$Securitypolicies$Delete + 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; + /** + * Name of the security policy to delete. + */ + securityPolicy?: string; + } + export interface Params$Resource$Securitypolicies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the security policy to get. + */ + securityPolicy?: string; + } + export interface Params$Resource$Securitypolicies$Getrule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The priority of the rule to get from the security policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the security policy to which the queried rule belongs. + */ + securityPolicy?: string; + } + export interface Params$Resource$Securitypolicies$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; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicy; + } + export interface Params$Resource$Securitypolicies$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$Securitypolicies$Listpreconfiguredexpressionsets + 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$Securitypolicies$Patch + 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; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicy; + } + export interface Params$Resource$Securitypolicies$Patchrule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } + export interface Params$Resource$Securitypolicies$Removerule + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The priority of the rule to remove from the security policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } + export interface Params$Resource$Securitypolicies$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Securitypolicies$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$Snapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.snapshots.delete + * @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.snapshot Name of the Snapshot resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Snapshots$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Snapshots$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Snapshots$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Snapshots$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{snapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'snapshot'], + pathParams: ['project', 'snapshot'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.snapshots.get + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. + * @alias compute.snapshots.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.snapshot Name of the Snapshot resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Snapshots$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Snapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Snapshots$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Snapshots$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{snapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'snapshot'], + pathParams: ['project', 'snapshot'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.snapshots.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.snapshots.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$Snapshots$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Snapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Snapshots$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Snapshots$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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/alpha/projects/{project}/global/snapshots/{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.snapshots.list + * @desc Retrieves the list of Snapshot resources contained within the specified project. + * @alias compute.snapshots.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$Snapshots$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Snapshots$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Snapshots$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Snapshots$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.snapshots.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.snapshots.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.resource Request body data + * @param {object} [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$Snapshots$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Snapshots$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Snapshots$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Snapshots$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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/alpha/projects/{project}/global/snapshots/{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.snapshots.setLabels + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.snapshots.setLabels + * @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 {().GlobalSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Snapshots$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Snapshots$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Snapshots$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Snapshots$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$Setlabels; + 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}/global/snapshots/{resource}/setLabels' + ).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.snapshots.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.snapshots.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.resource Request body data + * @param {object} [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$Snapshots$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Snapshots$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Snapshots$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Snapshots$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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/alpha/projects/{project}/global/snapshots/{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$Snapshots$Delete 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; + /** + * Name of the Snapshot resource to delete. + */ + snapshot?: string; + } + export interface Params$Resource$Snapshots$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the Snapshot resource to return. + */ + snapshot?: string; + } + export interface Params$Resource$Snapshots$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$Snapshots$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$Snapshots$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$Snapshots$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Snapshots$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$Sslcertificates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.sslCertificates.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Sslcertificates$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Sslcertificates$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Sslcertificates$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Sslcertificates$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcertificates$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.sslCertificates.delete + * @desc Deletes the specified SslCertificate resource. + * @alias compute.sslCertificates.delete + * @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.sslCertificate Name of the SslCertificate resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Sslcertificates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Sslcertificates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Sslcertificates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Sslcertificates$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcertificates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$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}/global/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'sslCertificate'], + pathParams: ['project', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslCertificates.get + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. + * @alias compute.sslCertificates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.sslCertificate Name of the SslCertificate resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Sslcertificates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sslcertificates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sslcertificates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sslcertificates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcertificates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$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}/global/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'sslCertificate'], + pathParams: ['project', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslCertificates.insert + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. + * @alias compute.sslCertificates.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 {().SslCertificate} params.resource Request body data + * @param {object} [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$Sslcertificates$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Sslcertificates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sslcertificates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Sslcertificates$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcertificates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$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}/global/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslCertificates.list + * @desc Retrieves the list of SslCertificate resources available to the specified project. + * @alias compute.sslCertificates.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$Sslcertificates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Sslcertificates$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sslcertificates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Sslcertificates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcertificates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$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}/global/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslCertificates.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.sslCertificates.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.resource Request body data + * @param {object} [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$Sslcertificates$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Sslcertificates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Sslcertificates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Sslcertificates$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcertificates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$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/alpha/projects/{project}/global/sslCertificates/{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$Sslcertificates$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } + export interface Params$Resource$Sslcertificates$Delete + 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; + /** + * Name of the SslCertificate resource to delete. + */ + sslCertificate?: string; + } + export interface Params$Resource$Sslcertificates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the SslCertificate resource to return. + */ + sslCertificate?: string; + } + export interface Params$Resource$Sslcertificates$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslCertificate; + } + export interface Params$Resource$Sslcertificates$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$Sslcertificates$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$Sslpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * @alias compute.sslPolicies.delete + * @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.sslPolicy Name of the SSL policy to delete. The name must be 1-63 characters long, and 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 + */ + delete( + params?: Params$Resource$Sslpolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Sslpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Sslpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Sslpolicies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslpolicies$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}/global/sslPolicies/{sslPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'sslPolicy'], + pathParams: ['project', 'sslPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslPolicies.get + * @desc Lists all of the ordered rules present in a single specified policy. + * @alias compute.sslPolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.sslPolicy Name of the SSL policy to update. The name must be 1-63 characters long, and 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$Sslpolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sslpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sslpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sslpolicies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sslpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslpolicies$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}/global/sslPolicies/{sslPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'sslPolicy'], + pathParams: ['project', 'sslPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslPolicies.insert + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. + * @alias compute.sslPolicies.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 {().SslPolicy} params.resource Request body data + * @param {object} [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$Sslpolicies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Sslpolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sslpolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Sslpolicies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslpolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslpolicies$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}/global/sslPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslPolicies.list + * @desc Lists all the SSL policies that have been configured for the specified project. + * @alias compute.sslPolicies.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$Sslpolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Sslpolicies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sslpolicies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Sslpolicies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sslpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslpolicies$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}/global/sslPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslPolicies.listAvailableFeatures + * @desc Lists all features that can be specified in the SSL policy when using custom profile. + * @alias compute.sslPolicies.listAvailableFeatures + * @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 + */ + listAvailableFeatures( + params?: Params$Resource$Sslpolicies$Listavailablefeatures, + options?: MethodOptions + ): GaxiosPromise; + listAvailableFeatures( + params: Params$Resource$Sslpolicies$Listavailablefeatures, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$SslPoliciesListAvailableFeaturesResponse + > + ): void; + listAvailableFeatures( + params: Params$Resource$Sslpolicies$Listavailablefeatures, + callback: BodyResponseCallback< + Schema$SslPoliciesListAvailableFeaturesResponse + > + ): void; + listAvailableFeatures( + callback: BodyResponseCallback< + Schema$SslPoliciesListAvailableFeaturesResponse + > + ): void; + listAvailableFeatures( + paramsOrCallback?: + | Params$Resource$Sslpolicies$Listavailablefeatures + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$SslPoliciesListAvailableFeaturesResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslpolicies$Listavailablefeatures; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslpolicies$Listavailablefeatures; + 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}/global/sslPolicies/listAvailableFeatures' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$SslPoliciesListAvailableFeaturesResponse + >(parameters); + } + } + + /** + * compute.sslPolicies.patch + * @desc Patches the specified SSL policy with the data included in the request. + * @alias compute.sslPolicies.patch + * @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.sslPolicy Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. + * @param {().SslPolicy} params.resource Request body data + * @param {object} [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$Sslpolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Sslpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Sslpolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Sslpolicies$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslpolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslpolicies$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}/global/sslPolicies/{sslPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'sslPolicy'], + pathParams: ['project', 'sslPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.sslPolicies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.sslPolicies.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.resource Request body data + * @param {object} [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$Sslpolicies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Sslpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Sslpolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Sslpolicies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslpolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslpolicies$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/alpha/projects/{project}/global/sslPolicies/{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$Sslpolicies$Delete + 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; + /** + * Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. + */ + sslPolicy?: string; + } + export interface Params$Resource$Sslpolicies$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + sslPolicy?: string; + } + export interface Params$Resource$Sslpolicies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslPolicy; + } + export interface Params$Resource$Sslpolicies$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$Sslpolicies$Listavailablefeatures + 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$Sslpolicies$Patch + 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; + /** + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + sslPolicy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslPolicy; + } + export interface Params$Resource$Sslpolicies$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$Subnetworks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.subnetworks.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Subnetworks$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Subnetworks$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Subnetworks$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Subnetworks$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/subnetworks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.delete + * @desc Deletes the specified subnetwork. + * @alias compute.subnetworks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.subnetwork Name of the Subnetwork resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Subnetworks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Subnetworks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Subnetworks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Subnetworks$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$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}/subnetworks/{subnetwork}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'subnetwork'], + pathParams: ['project', 'region', 'subnetwork'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.expandIpCidrRange + * @desc Expands the IP CIDR range of the subnetwork to a specified value. + * @alias compute.subnetworks.expandIpCidrRange + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.subnetwork Name of the Subnetwork resource to update. + * @param {().SubnetworksExpandIpCidrRangeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + expandIpCidrRange( + params?: Params$Resource$Subnetworks$Expandipcidrrange, + options?: MethodOptions + ): GaxiosPromise; + expandIpCidrRange( + params: Params$Resource$Subnetworks$Expandipcidrrange, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + expandIpCidrRange( + params: Params$Resource$Subnetworks$Expandipcidrrange, + callback: BodyResponseCallback + ): void; + expandIpCidrRange(callback: BodyResponseCallback): void; + expandIpCidrRange( + paramsOrCallback?: + | Params$Resource$Subnetworks$Expandipcidrrange + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Expandipcidrrange; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$Expandipcidrrange; + 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}/subnetworks/{subnetwork}/expandIpCidrRange' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'subnetwork'], + pathParams: ['project', 'region', 'subnetwork'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.get + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. + * @alias compute.subnetworks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.subnetwork Name of the Subnetwork resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Subnetworks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Subnetworks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Subnetworks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Subnetworks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Subnetworks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$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}/subnetworks/{subnetwork}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'subnetwork'], + pathParams: ['project', 'region', 'subnetwork'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.subnetworks.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.region The name of the region 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$Subnetworks$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Subnetworks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Subnetworks$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Subnetworks$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$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/alpha/projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.insert + * @desc Creates a subnetwork in the specified project using the data included in the request. + * @alias compute.subnetworks.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().Subnetwork} params.resource Request body data + * @param {object} [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$Subnetworks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Subnetworks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Subnetworks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Subnetworks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$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}/subnetworks' + ).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.subnetworks.list + * @desc Retrieves a list of subnetworks available to the specified project. + * @alias compute.subnetworks.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Subnetworks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Subnetworks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Subnetworks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Subnetworks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Subnetworks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$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}/subnetworks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.subnetworks.listUsable + * @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 + */ + listUsable( + params?: Params$Resource$Subnetworks$Listusable, + options?: MethodOptions + ): GaxiosPromise; + listUsable( + params: Params$Resource$Subnetworks$Listusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Subnetworks$Listusable, + callback: BodyResponseCallback + ): void; + listUsable( + callback: BodyResponseCallback + ): void; + listUsable( + paramsOrCallback?: + | Params$Resource$Subnetworks$Listusable + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Listusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$Listusable; + 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}/aggregated/subnetworks/listUsable' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * @alias compute.subnetworks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.drainTimeoutSeconds The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.subnetwork Name of the Subnetwork resource to patch. + * @param {().Subnetwork} params.resource Request body data + * @param {object} [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$Subnetworks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Subnetworks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Subnetworks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Subnetworks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/subnetworks/{subnetwork}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'subnetwork'], + pathParams: ['project', 'region', 'subnetwork'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.subnetworks.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetPolicyRequest} params.resource Request body data + * @param {object} [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$Subnetworks$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Subnetworks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Subnetworks$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Subnetworks$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$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/alpha/projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.setPrivateIpGoogleAccess + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.subnetwork Name of the Subnetwork resource. + * @param {().SubnetworksSetPrivateIpGoogleAccessRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setPrivateIpGoogleAccess( + params?: Params$Resource$Subnetworks$Setprivateipgoogleaccess, + options?: MethodOptions + ): GaxiosPromise; + setPrivateIpGoogleAccess( + params: Params$Resource$Subnetworks$Setprivateipgoogleaccess, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPrivateIpGoogleAccess( + params: Params$Resource$Subnetworks$Setprivateipgoogleaccess, + callback: BodyResponseCallback + ): void; + setPrivateIpGoogleAccess( + callback: BodyResponseCallback + ): void; + setPrivateIpGoogleAccess( + paramsOrCallback?: + | Params$Resource$Subnetworks$Setprivateipgoogleaccess + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Setprivateipgoogleaccess; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$Setprivateipgoogleaccess; + 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}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'subnetwork'], + pathParams: ['project', 'region', 'subnetwork'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.subnetworks.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.subnetworks.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Subnetworks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Subnetworks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Subnetworks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Subnetworks$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subnetworks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$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/alpha/projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Subnetworks$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Subnetworks$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Subnetwork resource to delete. + */ + subnetwork?: string; + } + export interface Params$Resource$Subnetworks$Expandipcidrrange + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Subnetwork resource to update. + */ + subnetwork?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SubnetworksExpandIpCidrRangeRequest; + } + export interface Params$Resource$Subnetworks$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the Subnetwork resource to return. + */ + subnetwork?: string; + } + export interface Params$Resource$Subnetworks$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; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Subnetworks$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subnetwork; + } + export interface Params$Resource$Subnetworks$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Subnetworks$Listusable + 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$Subnetworks$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. + */ + drainTimeoutSeconds?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Subnetwork resource to patch. + */ + subnetwork?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subnetwork; + } + export interface Params$Resource$Subnetworks$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Subnetworks$Setprivateipgoogleaccess + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Subnetwork resource. + */ + subnetwork?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SubnetworksSetPrivateIpGoogleAccessRequest; + } + export interface Params$Resource$Subnetworks$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Targethttpproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.targetHttpProxies.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Targethttpproxies$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targethttpproxies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targethttpproxies$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.targetHttpProxies.delete + * @desc Deletes the specified TargetHttpProxy resource. + * @alias compute.targetHttpProxies.delete + * @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.targetHttpProxy Name of the TargetHttpProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Targethttpproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Targethttpproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Targethttpproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$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}/global/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpProxy'], + pathParams: ['project', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpProxies.get + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. + * @alias compute.targetHttpProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targethttpproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targethttpproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targethttpproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$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}/global/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpProxy'], + pathParams: ['project', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpProxies.insert + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. + * @alias compute.targetHttpProxies.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 {().TargetHttpProxy} params.resource Request body data + * @param {object} [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$Targethttpproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targethttpproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targethttpproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$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}/global/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpProxies.list + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. + * @alias compute.targetHttpProxies.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$Targethttpproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targethttpproxies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targethttpproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$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}/global/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpProxies.setUrlMap + * @desc Changes the URL map for TargetHttpProxy. + * @alias compute.targetHttpProxies.setUrlMap + * @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.targetHttpProxy Name of the TargetHttpProxy to set a URL map for. + * @param {().UrlMapReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUrlMap( + params?: Params$Resource$Targethttpproxies$Seturlmap, + options?: MethodOptions + ): GaxiosPromise; + setUrlMap( + params: Params$Resource$Targethttpproxies$Seturlmap, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUrlMap( + params: Params$Resource$Targethttpproxies$Seturlmap, + callback: BodyResponseCallback + ): void; + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Seturlmap + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Seturlmap; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$Seturlmap; + 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}/targetHttpProxies/{targetHttpProxy}/setUrlMap' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpProxy'], + pathParams: ['project', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpProxies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.targetHttpProxies.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.resource Request body data + * @param {object} [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$Targethttpproxies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Targethttpproxies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targethttpproxies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$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/alpha/projects/{project}/global/targetHttpProxies/{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$Targethttpproxies$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } + export interface Params$Resource$Targethttpproxies$Delete + 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; + /** + * Name of the TargetHttpProxy resource to delete. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Targethttpproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the TargetHttpProxy resource to return. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Targethttpproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpProxy; + } + export interface Params$Resource$Targethttpproxies$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$Targethttpproxies$Seturlmap + 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; + /** + * Name of the TargetHttpProxy to set a URL map for. + */ + targetHttpProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapReference; + } + export interface Params$Resource$Targethttpproxies$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$Targethttpsproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.targetHttpsProxies.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Targethttpsproxies$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targethttpsproxies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targethttpsproxies$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/targetHttpsProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.targetHttpsProxies.delete + * @desc Deletes the specified TargetHttpsProxy resource. + * @alias compute.targetHttpsProxies.delete + * @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.targetHttpsProxy Name of the TargetHttpsProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Targethttpsproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Targethttpsproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Targethttpsproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$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}/global/targetHttpsProxies/{targetHttpsProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpsProxy'], + pathParams: ['project', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpsProxies.get + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. + * @alias compute.targetHttpsProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targethttpsproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targethttpsproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targethttpsproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$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}/global/targetHttpsProxies/{targetHttpsProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpsProxy'], + pathParams: ['project', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpsProxies.insert + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. + * @alias compute.targetHttpsProxies.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 {().TargetHttpsProxy} params.resource Request body data + * @param {object} [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$Targethttpsproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targethttpsproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targethttpsproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$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}/global/targetHttpsProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpsProxies.list + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. + * @alias compute.targetHttpsProxies.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$Targethttpsproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targethttpsproxies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targethttpsproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$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}/global/targetHttpsProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpsProxies.setQuicOverride + * @desc Sets the QUIC override policy for TargetHttpsProxy. + * @alias compute.targetHttpsProxies.setQuicOverride + * @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.targetHttpsProxy Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. + * @param {().TargetHttpsProxiesSetQuicOverrideRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setQuicOverride( + params?: Params$Resource$Targethttpsproxies$Setquicoverride, + options?: MethodOptions + ): GaxiosPromise; + setQuicOverride( + params: Params$Resource$Targethttpsproxies$Setquicoverride, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setQuicOverride( + params: Params$Resource$Targethttpsproxies$Setquicoverride, + callback: BodyResponseCallback + ): void; + setQuicOverride(callback: BodyResponseCallback): void; + setQuicOverride( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Setquicoverride + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Setquicoverride; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$Setquicoverride; + 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}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpsProxy'], + pathParams: ['project', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpsProxies.setSslCertificates + * @desc Replaces SslCertificates for TargetHttpsProxy. + * @alias compute.targetHttpsProxies.setSslCertificates + * @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.targetHttpsProxy Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + * @param {().TargetHttpsProxiesSetSslCertificatesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSslCertificates( + params?: Params$Resource$Targethttpsproxies$Setsslcertificates, + options?: MethodOptions + ): GaxiosPromise; + setSslCertificates( + params: Params$Resource$Targethttpsproxies$Setsslcertificates, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSslCertificates( + params: Params$Resource$Targethttpsproxies$Setsslcertificates, + callback: BodyResponseCallback + ): void; + setSslCertificates(callback: BodyResponseCallback): void; + setSslCertificates( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Setsslcertificates + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Setsslcertificates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$Setsslcertificates; + 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}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpsProxy'], + pathParams: ['project', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.targetHttpsProxies.setSslPolicy + * @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.targetHttpsProxy Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. + * @param {().SslPolicyReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSslPolicy( + params?: Params$Resource$Targethttpsproxies$Setsslpolicy, + options?: MethodOptions + ): GaxiosPromise; + setSslPolicy( + params: Params$Resource$Targethttpsproxies$Setsslpolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSslPolicy( + params: Params$Resource$Targethttpsproxies$Setsslpolicy, + callback: BodyResponseCallback + ): void; + setSslPolicy(callback: BodyResponseCallback): void; + setSslPolicy( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Setsslpolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Setsslpolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$Setsslpolicy; + 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}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpsProxy'], + pathParams: ['project', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpsProxies.setUrlMap + * @desc Changes the URL map for TargetHttpsProxy. + * @alias compute.targetHttpsProxies.setUrlMap + * @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.targetHttpsProxy Name of the TargetHttpsProxy resource whose URL map is to be set. + * @param {().UrlMapReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUrlMap( + params?: Params$Resource$Targethttpsproxies$Seturlmap, + options?: MethodOptions + ): GaxiosPromise; + setUrlMap( + params: Params$Resource$Targethttpsproxies$Seturlmap, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUrlMap( + params: Params$Resource$Targethttpsproxies$Seturlmap, + callback: BodyResponseCallback + ): void; + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Seturlmap + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Seturlmap; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$Seturlmap; + 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}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetHttpsProxy'], + pathParams: ['project', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetHttpsProxies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.targetHttpsProxies.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.resource Request body data + * @param {object} [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$Targethttpsproxies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Targethttpsproxies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targethttpsproxies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$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/alpha/projects/{project}/global/targetHttpsProxies/{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$Targethttpsproxies$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } + export interface Params$Resource$Targethttpsproxies$Delete + 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; + /** + * Name of the TargetHttpsProxy resource to delete. + */ + targetHttpsProxy?: string; + } + export interface Params$Resource$Targethttpsproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the TargetHttpsProxy resource to return. + */ + targetHttpsProxy?: string; + } + export interface Params$Resource$Targethttpsproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpsProxy; + } + export interface Params$Resource$Targethttpsproxies$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$Targethttpsproxies$Setquicoverride + 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; + /** + * Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpsProxiesSetQuicOverrideRequest; + } + export interface Params$Resource$Targethttpsproxies$Setsslcertificates + 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; + /** + * Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpsProxiesSetSslCertificatesRequest; + } + export interface Params$Resource$Targethttpsproxies$Setsslpolicy + 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; + /** + * Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslPolicyReference; + } + export interface Params$Resource$Targethttpsproxies$Seturlmap + 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; + /** + * Name of the TargetHttpsProxy resource whose URL map is to be set. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapReference; + } + export interface Params$Resource$Targethttpsproxies$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$Targetinstances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.targetInstances.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Targetinstances$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targetinstances$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targetinstances$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targetinstances$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetinstances$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetinstances$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/targetInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.targetInstances.delete + * @desc Deletes the specified TargetInstance resource. + * @alias compute.targetInstances.delete + * @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.targetInstance Name of the TargetInstance resource to delete. + * @param {string} params.zone Name of the zone 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 + */ + delete( + params?: Params$Resource$Targetinstances$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Targetinstances$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Targetinstances$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Targetinstances$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetinstances$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetinstances$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}/zones/{zone}/targetInstances/{targetInstance}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'targetInstance'], + pathParams: ['project', 'targetInstance', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetInstances.get + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. + * @alias compute.targetInstances.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.targetInstance Name of the TargetInstance resource to return. + * @param {string} params.zone Name of the zone scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targetinstances$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetinstances$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetinstances$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetinstances$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetinstances$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetinstances$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}/zones/{zone}/targetInstances/{targetInstance}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'targetInstance'], + pathParams: ['project', 'targetInstance', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetInstances.insert + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. + * @alias compute.targetInstances.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.zone Name of the zone scoping this request. + * @param {().TargetInstance} params.resource Request body data + * @param {object} [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$Targetinstances$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targetinstances$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targetinstances$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targetinstances$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetinstances$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetinstances$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}/zones/{zone}/targetInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetInstances.list + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. + * @alias compute.targetInstances.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone Name of the zone scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Targetinstances$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetinstances$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetinstances$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Targetinstances$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetinstances$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetinstances$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}/zones/{zone}/targetInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetInstances.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.targetInstances.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 {string} params.zone The name of the zone for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Targetinstances$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Targetinstances$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targetinstances$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targetinstances$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetinstances$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetinstances$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/alpha/projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Targetinstances$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Targetinstances$Delete + 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; + /** + * Name of the TargetInstance resource to delete. + */ + targetInstance?: string; + /** + * Name of the zone scoping this request. + */ + zone?: string; + } + export interface Params$Resource$Targetinstances$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the TargetInstance resource to return. + */ + targetInstance?: string; + /** + * Name of the zone scoping this request. + */ + zone?: string; + } + export interface Params$Resource$Targetinstances$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; + /** + * Name of the zone scoping this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetInstance; + } + export interface Params$Resource$Targetinstances$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone scoping this request. + */ + zone?: string; + } + export interface Params$Resource$Targetinstances$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; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Targetpools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.targetPools.addHealthCheck + * @desc Adds health check URLs to a target pool. + * @alias compute.targetPools.addHealthCheck + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetPool Name of the target pool to add a health check to. + * @param {().TargetPoolsAddHealthCheckRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addHealthCheck( + params?: Params$Resource$Targetpools$Addhealthcheck, + options?: MethodOptions + ): GaxiosPromise; + addHealthCheck( + params: Params$Resource$Targetpools$Addhealthcheck, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addHealthCheck( + params: Params$Resource$Targetpools$Addhealthcheck, + callback: BodyResponseCallback + ): void; + addHealthCheck(callback: BodyResponseCallback): void; + addHealthCheck( + paramsOrCallback?: + | Params$Resource$Targetpools$Addhealthcheck + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Addhealthcheck; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Addhealthcheck; + 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}/targetPools/{targetPool}/addHealthCheck' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.addInstance + * @desc Adds an instance to a target pool. + * @alias compute.targetPools.addInstance + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetPool Name of the TargetPool resource to add instances to. + * @param {().TargetPoolsAddInstanceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addInstance( + params?: Params$Resource$Targetpools$Addinstance, + options?: MethodOptions + ): GaxiosPromise; + addInstance( + params: Params$Resource$Targetpools$Addinstance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addInstance( + params: Params$Resource$Targetpools$Addinstance, + callback: BodyResponseCallback + ): void; + addInstance(callback: BodyResponseCallback): void; + addInstance( + paramsOrCallback?: + | Params$Resource$Targetpools$Addinstance + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Addinstance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Addinstance; + 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}/targetPools/{targetPool}/addInstance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Targetpools$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targetpools$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targetpools$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targetpools$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/targetPools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.delete + * @desc Deletes the specified target pool. + * @alias compute.targetPools.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetPool Name of the TargetPool resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Targetpools$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Targetpools$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Targetpools$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Targetpools$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$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}/targetPools/{targetPool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.get + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. + * @alias compute.targetPools.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.targetPool Name of the TargetPool resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targetpools$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetpools$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetpools$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetpools$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Targetpools$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$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}/targetPools/{targetPool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.targetPools.getHealth + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.targetPool Name of the TargetPool resource to which the queried instance belongs. + * @param {().InstanceReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getHealth( + params?: Params$Resource$Targetpools$Gethealth, + options?: MethodOptions + ): GaxiosPromise; + getHealth( + params: Params$Resource$Targetpools$Gethealth, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHealth( + params: Params$Resource$Targetpools$Gethealth, + callback: BodyResponseCallback + ): void; + getHealth( + callback: BodyResponseCallback + ): void; + getHealth( + paramsOrCallback?: + | Params$Resource$Targetpools$Gethealth + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Gethealth; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Gethealth; + 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}/targetPools/{targetPool}/getHealth' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.insert + * @desc Creates a target pool in the specified project and region using the data included in the request. + * @alias compute.targetPools.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().TargetPool} params.resource Request body data + * @param {object} [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$Targetpools$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targetpools$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targetpools$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targetpools$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$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}/targetPools' + ).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.targetPools.list + * @desc Retrieves a list of target pools available to the specified project and region. + * @alias compute.targetPools.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Targetpools$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetpools$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetpools$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Targetpools$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Targetpools$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$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}/targetPools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.removeHealthCheck + * @desc Removes health check URL from a target pool. + * @alias compute.targetPools.removeHealthCheck + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetPool Name of the target pool to remove health checks from. + * @param {().TargetPoolsRemoveHealthCheckRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeHealthCheck( + params?: Params$Resource$Targetpools$Removehealthcheck, + options?: MethodOptions + ): GaxiosPromise; + removeHealthCheck( + params: Params$Resource$Targetpools$Removehealthcheck, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeHealthCheck( + params: Params$Resource$Targetpools$Removehealthcheck, + callback: BodyResponseCallback + ): void; + removeHealthCheck(callback: BodyResponseCallback): void; + removeHealthCheck( + paramsOrCallback?: + | Params$Resource$Targetpools$Removehealthcheck + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Removehealthcheck; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Removehealthcheck; + 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}/targetPools/{targetPool}/removeHealthCheck' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.removeInstance + * @desc Removes instance URL from a target pool. + * @alias compute.targetPools.removeInstance + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetPool Name of the TargetPool resource to remove instances from. + * @param {().TargetPoolsRemoveInstanceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeInstance( + params?: Params$Resource$Targetpools$Removeinstance, + options?: MethodOptions + ): GaxiosPromise; + removeInstance( + params: Params$Resource$Targetpools$Removeinstance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeInstance( + params: Params$Resource$Targetpools$Removeinstance, + callback: BodyResponseCallback + ): void; + removeInstance(callback: BodyResponseCallback): void; + removeInstance( + paramsOrCallback?: + | Params$Resource$Targetpools$Removeinstance + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Removeinstance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Removeinstance; + 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}/targetPools/{targetPool}/removeInstance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.setBackup + * @desc Changes a backup target pool's configurations. + * @alias compute.targetPools.setBackup + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {number=} params.failoverRatio New failoverRatio value for the target pool. + * @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 {string} params.targetPool Name of the TargetPool resource to set a backup pool for. + * @param {().TargetReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setBackup( + params?: Params$Resource$Targetpools$Setbackup, + options?: MethodOptions + ): GaxiosPromise; + setBackup( + params: Params$Resource$Targetpools$Setbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setBackup( + params: Params$Resource$Targetpools$Setbackup, + callback: BodyResponseCallback + ): void; + setBackup(callback: BodyResponseCallback): void; + setBackup( + paramsOrCallback?: + | Params$Resource$Targetpools$Setbackup + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Setbackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$Setbackup; + 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}/targetPools/{targetPool}/setBackup' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetPool'], + pathParams: ['project', 'region', 'targetPool'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetPools.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.targetPools.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Targetpools$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Targetpools$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targetpools$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targetpools$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetpools$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetpools$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/alpha/projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Targetpools$Addhealthcheck + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the target pool to add a health check to. + */ + targetPool?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetPoolsAddHealthCheckRequest; + } + export interface Params$Resource$Targetpools$Addinstance + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetPool resource to add instances to. + */ + targetPool?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetPoolsAddInstanceRequest; + } + export interface Params$Resource$Targetpools$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Targetpools$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetPool resource to delete. + */ + targetPool?: string; + } + export interface Params$Resource$Targetpools$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the TargetPool resource to return. + */ + targetPool?: string; + } + export interface Params$Resource$Targetpools$Gethealth + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the TargetPool resource to which the queried instance belongs. + */ + targetPool?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceReference; + } + export interface Params$Resource$Targetpools$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetPool; + } + export interface Params$Resource$Targetpools$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Targetpools$Removehealthcheck + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the target pool to remove health checks from. + */ + targetPool?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetPoolsRemoveHealthCheckRequest; + } + export interface Params$Resource$Targetpools$Removeinstance + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetPool resource to remove instances from. + */ + targetPool?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetPoolsRemoveInstanceRequest; + } + export interface Params$Resource$Targetpools$Setbackup + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * New failoverRatio value for the target pool. + */ + failoverRatio?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetPool resource to set a backup pool for. + */ + targetPool?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetReference; + } + export interface Params$Resource$Targetpools$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Targetsslproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.targetSslProxies.delete + * @desc Deletes the specified TargetSslProxy resource. + * @alias compute.targetSslProxies.delete + * @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.targetSslProxy Name of the TargetSslProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Targetsslproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Targetsslproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Targetsslproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$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}/global/targetSslProxies/{targetSslProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'targetSslProxy'], + pathParams: ['project', 'targetSslProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetSslProxies.get + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. + * @alias compute.targetSslProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.targetSslProxy Name of the TargetSslProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targetsslproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetsslproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetsslproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$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}/global/targetSslProxies/{targetSslProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'targetSslProxy'], + pathParams: ['project', 'targetSslProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetSslProxies.insert + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. + * @alias compute.targetSslProxies.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 {().TargetSslProxy} params.resource Request body data + * @param {object} [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$Targetsslproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targetsslproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targetsslproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$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}/global/targetSslProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetSslProxies.list + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. + * @alias compute.targetSslProxies.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$Targetsslproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetsslproxies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetsslproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$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}/global/targetSslProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetSslProxies.setBackendService + * @desc Changes the BackendService for TargetSslProxy. + * @alias compute.targetSslProxies.setBackendService + * @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.targetSslProxy Name of the TargetSslProxy resource whose BackendService resource is to be set. + * @param {().TargetSslProxiesSetBackendServiceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setBackendService( + params?: Params$Resource$Targetsslproxies$Setbackendservice, + options?: MethodOptions + ): GaxiosPromise; + setBackendService( + params: Params$Resource$Targetsslproxies$Setbackendservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setBackendService( + params: Params$Resource$Targetsslproxies$Setbackendservice, + callback: BodyResponseCallback + ): void; + setBackendService(callback: BodyResponseCallback): void; + setBackendService( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Setbackendservice + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Setbackendservice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$Setbackendservice; + 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}/global/targetSslProxies/{targetSslProxy}/setBackendService' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetSslProxy'], + pathParams: ['project', 'targetSslProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetSslProxies.setProxyHeader + * @desc Changes the ProxyHeaderType for TargetSslProxy. + * @alias compute.targetSslProxies.setProxyHeader + * @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.targetSslProxy Name of the TargetSslProxy resource whose ProxyHeader is to be set. + * @param {().TargetSslProxiesSetProxyHeaderRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setProxyHeader( + params?: Params$Resource$Targetsslproxies$Setproxyheader, + options?: MethodOptions + ): GaxiosPromise; + setProxyHeader( + params: Params$Resource$Targetsslproxies$Setproxyheader, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setProxyHeader( + params: Params$Resource$Targetsslproxies$Setproxyheader, + callback: BodyResponseCallback + ): void; + setProxyHeader(callback: BodyResponseCallback): void; + setProxyHeader( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Setproxyheader + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Setproxyheader; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$Setproxyheader; + 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}/global/targetSslProxies/{targetSslProxy}/setProxyHeader' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetSslProxy'], + pathParams: ['project', 'targetSslProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetSslProxies.setSslCertificates + * @desc Changes SslCertificates for TargetSslProxy. + * @alias compute.targetSslProxies.setSslCertificates + * @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.targetSslProxy Name of the TargetSslProxy resource whose SslCertificate resource is to be set. + * @param {().TargetSslProxiesSetSslCertificatesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSslCertificates( + params?: Params$Resource$Targetsslproxies$Setsslcertificates, + options?: MethodOptions + ): GaxiosPromise; + setSslCertificates( + params: Params$Resource$Targetsslproxies$Setsslcertificates, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSslCertificates( + params: Params$Resource$Targetsslproxies$Setsslcertificates, + callback: BodyResponseCallback + ): void; + setSslCertificates(callback: BodyResponseCallback): void; + setSslCertificates( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Setsslcertificates + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Setsslcertificates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$Setsslcertificates; + 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}/global/targetSslProxies/{targetSslProxy}/setSslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetSslProxy'], + pathParams: ['project', 'targetSslProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.targetSslProxies.setSslPolicy + * @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.targetSslProxy Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. + * @param {().SslPolicyReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSslPolicy( + params?: Params$Resource$Targetsslproxies$Setsslpolicy, + options?: MethodOptions + ): GaxiosPromise; + setSslPolicy( + params: Params$Resource$Targetsslproxies$Setsslpolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSslPolicy( + params: Params$Resource$Targetsslproxies$Setsslpolicy, + callback: BodyResponseCallback + ): void; + setSslPolicy(callback: BodyResponseCallback): void; + setSslPolicy( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Setsslpolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Setsslpolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$Setsslpolicy; + 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}/global/targetSslProxies/{targetSslProxy}/setSslPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetSslProxy'], + pathParams: ['project', 'targetSslProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetSslProxies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.targetSslProxies.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.resource Request body data + * @param {object} [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$Targetsslproxies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Targetsslproxies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targetsslproxies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targetsslproxies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetsslproxies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetsslproxies$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/alpha/projects/{project}/global/targetSslProxies/{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$Targetsslproxies$Delete + 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; + /** + * Name of the TargetSslProxy resource to delete. + */ + targetSslProxy?: string; + } + export interface Params$Resource$Targetsslproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the TargetSslProxy resource to return. + */ + targetSslProxy?: string; + } + export interface Params$Resource$Targetsslproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetSslProxy; + } + export interface Params$Resource$Targetsslproxies$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$Targetsslproxies$Setbackendservice + 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; + /** + * Name of the TargetSslProxy resource whose BackendService resource is to be set. + */ + targetSslProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetSslProxiesSetBackendServiceRequest; + } + export interface Params$Resource$Targetsslproxies$Setproxyheader + 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; + /** + * Name of the TargetSslProxy resource whose ProxyHeader is to be set. + */ + targetSslProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetSslProxiesSetProxyHeaderRequest; + } + export interface Params$Resource$Targetsslproxies$Setsslcertificates + 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; + /** + * Name of the TargetSslProxy resource whose SslCertificate resource is to be set. + */ + targetSslProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetSslProxiesSetSslCertificatesRequest; + } + export interface Params$Resource$Targetsslproxies$Setsslpolicy + 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; + /** + * Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. + */ + targetSslProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslPolicyReference; + } + export interface Params$Resource$Targetsslproxies$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$Targettcpproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.targetTcpProxies.delete + * @desc Deletes the specified TargetTcpProxy resource. + * @alias compute.targetTcpProxies.delete + * @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.targetTcpProxy Name of the TargetTcpProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Targettcpproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Targettcpproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Targettcpproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Targettcpproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targettcpproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targettcpproxies$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}/global/targetTcpProxies/{targetTcpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'targetTcpProxy'], + pathParams: ['project', 'targetTcpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetTcpProxies.get + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. + * @alias compute.targetTcpProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.targetTcpProxy Name of the TargetTcpProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targettcpproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targettcpproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targettcpproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targettcpproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targettcpproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targettcpproxies$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}/global/targetTcpProxies/{targetTcpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'targetTcpProxy'], + pathParams: ['project', 'targetTcpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetTcpProxies.insert + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. + * @alias compute.targetTcpProxies.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 {().TargetTcpProxy} params.resource Request body data + * @param {object} [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$Targettcpproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targettcpproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targettcpproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targettcpproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targettcpproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targettcpproxies$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}/global/targetTcpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetTcpProxies.list + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. + * @alias compute.targetTcpProxies.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$Targettcpproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targettcpproxies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targettcpproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Targettcpproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targettcpproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targettcpproxies$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}/global/targetTcpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetTcpProxies.setBackendService + * @desc Changes the BackendService for TargetTcpProxy. + * @alias compute.targetTcpProxies.setBackendService + * @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.targetTcpProxy Name of the TargetTcpProxy resource whose BackendService resource is to be set. + * @param {().TargetTcpProxiesSetBackendServiceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setBackendService( + params?: Params$Resource$Targettcpproxies$Setbackendservice, + options?: MethodOptions + ): GaxiosPromise; + setBackendService( + params: Params$Resource$Targettcpproxies$Setbackendservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setBackendService( + params: Params$Resource$Targettcpproxies$Setbackendservice, + callback: BodyResponseCallback + ): void; + setBackendService(callback: BodyResponseCallback): void; + setBackendService( + paramsOrCallback?: + | Params$Resource$Targettcpproxies$Setbackendservice + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targettcpproxies$Setbackendservice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targettcpproxies$Setbackendservice; + 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}/global/targetTcpProxies/{targetTcpProxy}/setBackendService' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetTcpProxy'], + pathParams: ['project', 'targetTcpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetTcpProxies.setProxyHeader + * @desc Changes the ProxyHeaderType for TargetTcpProxy. + * @alias compute.targetTcpProxies.setProxyHeader + * @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.targetTcpProxy Name of the TargetTcpProxy resource whose ProxyHeader is to be set. + * @param {().TargetTcpProxiesSetProxyHeaderRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setProxyHeader( + params?: Params$Resource$Targettcpproxies$Setproxyheader, + options?: MethodOptions + ): GaxiosPromise; + setProxyHeader( + params: Params$Resource$Targettcpproxies$Setproxyheader, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setProxyHeader( + params: Params$Resource$Targettcpproxies$Setproxyheader, + callback: BodyResponseCallback + ): void; + setProxyHeader(callback: BodyResponseCallback): void; + setProxyHeader( + paramsOrCallback?: + | Params$Resource$Targettcpproxies$Setproxyheader + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targettcpproxies$Setproxyheader; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targettcpproxies$Setproxyheader; + 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}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'targetTcpProxy'], + pathParams: ['project', 'targetTcpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetTcpProxies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.targetTcpProxies.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.resource Request body data + * @param {object} [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$Targettcpproxies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Targettcpproxies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targettcpproxies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targettcpproxies$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targettcpproxies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targettcpproxies$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/alpha/projects/{project}/global/targetTcpProxies/{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$Targettcpproxies$Delete + 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; + /** + * Name of the TargetTcpProxy resource to delete. + */ + targetTcpProxy?: string; + } + export interface Params$Resource$Targettcpproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the TargetTcpProxy resource to return. + */ + targetTcpProxy?: string; + } + export interface Params$Resource$Targettcpproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetTcpProxy; + } + export interface Params$Resource$Targettcpproxies$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$Targettcpproxies$Setbackendservice + 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; + /** + * Name of the TargetTcpProxy resource whose BackendService resource is to be set. + */ + targetTcpProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetTcpProxiesSetBackendServiceRequest; + } + export interface Params$Resource$Targettcpproxies$Setproxyheader + 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; + /** + * Name of the TargetTcpProxy resource whose ProxyHeader is to be set. + */ + targetTcpProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetTcpProxiesSetProxyHeaderRequest; + } + export interface Params$Resource$Targettcpproxies$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$Targetvpngateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.targetVpnGateways.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Targetvpngateways$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targetvpngateways$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targetvpngateways$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targetvpngateways$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetvpngateways$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetvpngateways$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/targetVpnGateways' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.targetVpnGateways.delete + * @desc Deletes the specified target VPN gateway. + * @alias compute.targetVpnGateways.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetVpnGateway Name of the target VPN gateway 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$Targetvpngateways$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Targetvpngateways$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Targetvpngateways$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Targetvpngateways$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetvpngateways$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetvpngateways$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}/targetVpnGateways/{targetVpnGateway}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetVpnGateway'], + pathParams: ['project', 'region', 'targetVpnGateway'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetVpnGateways.get + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.targetVpnGateway Name of the target VPN gateway to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targetvpngateways$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetvpngateways$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetvpngateways$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetvpngateways$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetvpngateways$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetvpngateways$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}/targetVpnGateways/{targetVpnGateway}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetVpnGateway'], + pathParams: ['project', 'region', 'targetVpnGateway'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetVpnGateways.insert + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. + * @alias compute.targetVpnGateways.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().TargetVpnGateway} params.resource Request body data + * @param {object} [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$Targetvpngateways$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targetvpngateways$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targetvpngateways$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targetvpngateways$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetvpngateways$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetvpngateways$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}/targetVpnGateways' + ).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.targetVpnGateways.list + * @desc Retrieves a list of target VPN gateways available to the specified project and region. + * @alias compute.targetVpnGateways.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Targetvpngateways$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetvpngateways$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetvpngateways$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Targetvpngateways$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetvpngateways$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetvpngateways$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}/targetVpnGateways' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetVpnGateways.setLabels + * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.targetVpnGateways.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Targetvpngateways$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Targetvpngateways$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Targetvpngateways$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Targetvpngateways$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetvpngateways$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetvpngateways$Setlabels; + 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}/targetVpnGateways/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.targetVpnGateways.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.targetVpnGateways.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Targetvpngateways$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Targetvpngateways$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Targetvpngateways$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Targetvpngateways$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetvpngateways$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetvpngateways$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/alpha/projects/{project}/regions/{region}/targetVpnGateways/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Targetvpngateways$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Targetvpngateways$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the target VPN gateway to delete. + */ + targetVpnGateway?: string; + } + export interface Params$Resource$Targetvpngateways$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the target VPN gateway to return. + */ + targetVpnGateway?: string; + } + export interface Params$Resource$Targetvpngateways$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetVpnGateway; + } + export interface Params$Resource$Targetvpngateways$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Targetvpngateways$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Targetvpngateways$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Urlmaps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.urlMaps.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Urlmaps$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Urlmaps$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Urlmaps$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Urlmaps$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Urlmaps$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/aggregated/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.urlMaps.delete + * @desc Deletes the specified UrlMap resource. + * @alias compute.urlMaps.delete + * @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.urlMap Name of the UrlMap resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Urlmaps$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Urlmaps$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Urlmaps$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Urlmaps$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Urlmaps$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$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}/global/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'urlMap'], + pathParams: ['project', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.urlMaps.get + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @alias compute.urlMaps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.urlMap Name of the UrlMap resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Urlmaps$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Urlmaps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Urlmaps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Urlmaps$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Urlmaps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$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}/global/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'urlMap'], + pathParams: ['project', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.urlMaps.insert + * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @alias compute.urlMaps.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 {().UrlMap} params.resource Request body data + * @param {object} [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$Urlmaps$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Urlmaps$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Urlmaps$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Urlmaps$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Urlmaps$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$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}/global/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.urlMaps.invalidateCache + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @alias compute.urlMaps.invalidateCache + * @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.urlMap Name of the UrlMap scoping this request. + * @param {().CacheInvalidationRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + invalidateCache( + params?: Params$Resource$Urlmaps$Invalidatecache, + options?: MethodOptions + ): GaxiosPromise; + invalidateCache( + params: Params$Resource$Urlmaps$Invalidatecache, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invalidateCache( + params: Params$Resource$Urlmaps$Invalidatecache, + callback: BodyResponseCallback + ): void; + invalidateCache(callback: BodyResponseCallback): void; + invalidateCache( + paramsOrCallback?: + | Params$Resource$Urlmaps$Invalidatecache + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Urlmaps$Invalidatecache; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$Invalidatecache; + 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}/global/urlMaps/{urlMap}/invalidateCache' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'urlMap'], + pathParams: ['project', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.urlMaps.list + * @desc Retrieves the list of UrlMap resources available to the specified project. + * @alias compute.urlMaps.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$Urlmaps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Urlmaps$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Urlmaps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Urlmaps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Urlmaps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$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}/global/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.urlMaps.patch + * @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.urlMap Name of the UrlMap resource to patch. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Urlmaps$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Urlmaps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Urlmaps$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Urlmaps$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Urlmaps$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$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}/global/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'urlMap'], + pathParams: ['project', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.urlMaps.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.urlMaps.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.resource Request body data + * @param {object} [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$Urlmaps$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Urlmaps$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Urlmaps$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Urlmaps$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Urlmaps$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$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/alpha/projects/{project}/global/urlMaps/{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); + } + } + + /** + * compute.urlMaps.update + * @desc Updates the specified UrlMap resource with the data included in the request. + * @alias compute.urlMaps.update + * @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.urlMap Name of the UrlMap resource to update. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Urlmaps$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Urlmaps$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Urlmaps$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Urlmaps$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Urlmaps$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$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}/global/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'urlMap'], + pathParams: ['project', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.urlMaps.validate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.urlMap Name of the UrlMap resource to be validated as. + * @param {().UrlMapsValidateRequest} params.resource Request body data + * @param {object} [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$Urlmaps$Validate, + options?: MethodOptions + ): GaxiosPromise; + validate( + params: Params$Resource$Urlmaps$Validate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validate( + params: Params$Resource$Urlmaps$Validate, + callback: BodyResponseCallback + ): void; + validate( + callback: BodyResponseCallback + ): void; + validate( + paramsOrCallback?: + | Params$Resource$Urlmaps$Validate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Urlmaps$Validate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$Validate; + 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}/global/urlMaps/{urlMap}/validate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'urlMap'], + pathParams: ['project', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Urlmaps$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } + export interface Params$Resource$Urlmaps$Delete 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; + /** + * Name of the UrlMap resource to delete. + */ + urlMap?: string; + } + export interface Params$Resource$Urlmaps$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the UrlMap resource to return. + */ + urlMap?: string; + } + export interface Params$Resource$Urlmaps$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Urlmaps$Invalidatecache + 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; + /** + * Name of the UrlMap scoping this request. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CacheInvalidationRule; + } + export interface Params$Resource$Urlmaps$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$Urlmaps$Patch 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; + /** + * Name of the UrlMap resource to patch. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Urlmaps$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Urlmaps$Update 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; + /** + * Name of the UrlMap resource to update. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Urlmaps$Validate extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the UrlMap resource to be validated as. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapsValidateRequest; + } + + export class Resource$Vpngateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.vpnGateways.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Vpngateways$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Vpngateways$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Vpngateways$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Vpngateways$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpngateways$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/vpnGateways' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnGateways.delete + * @desc Deletes the specified VPN gateway. + * @alias compute.vpnGateways.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.vpnGateway Name of the VPN gateway 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$Vpngateways$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Vpngateways$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Vpngateways$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Vpngateways$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpngateways$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$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}/vpnGateways/{vpnGateway}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'vpnGateway'], + pathParams: ['project', 'region', 'vpnGateway'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnGateways.get + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. + * @alias compute.vpnGateways.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.vpnGateway Name of the VPN gateway to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Vpngateways$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Vpngateways$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Vpngateways$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Vpngateways$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Vpngateways$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$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}/vpnGateways/{vpnGateway}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'vpnGateway'], + pathParams: ['project', 'region', 'vpnGateway'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnGateways.getStatus + * @desc Returns the status for the specified VPN gateway. + * @alias compute.vpnGateways.getStatus + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.vpnGateway Name of the VPN gateway 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 + */ + getStatus( + params?: Params$Resource$Vpngateways$Getstatus, + options?: MethodOptions + ): GaxiosPromise; + getStatus( + params: Params$Resource$Vpngateways$Getstatus, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getStatus( + params: Params$Resource$Vpngateways$Getstatus, + callback: BodyResponseCallback + ): void; + getStatus( + callback: BodyResponseCallback + ): void; + getStatus( + paramsOrCallback?: + | Params$Resource$Vpngateways$Getstatus + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpngateways$Getstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$Getstatus; + 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}/vpnGateways/{vpnGateway}/getStatus' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'vpnGateway'], + pathParams: ['project', 'region', 'vpnGateway'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.vpnGateways.insert + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. + * @alias compute.vpnGateways.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().VpnGateway} params.resource Request body data + * @param {object} [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$Vpngateways$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Vpngateways$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Vpngateways$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Vpngateways$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpngateways$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$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}/vpnGateways' + ).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.vpnGateways.list + * @desc Retrieves a list of VPN gateways available to the specified project and region. + * @alias compute.vpnGateways.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Vpngateways$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Vpngateways$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Vpngateways$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Vpngateways$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Vpngateways$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$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}/vpnGateways' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnGateways.setLabels + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.vpnGateways.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Vpngateways$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Vpngateways$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Vpngateways$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Vpngateways$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpngateways$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$Setlabels; + 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}/vpnGateways/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnGateways.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.vpnGateways.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Vpngateways$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Vpngateways$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Vpngateways$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Vpngateways$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpngateways$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpngateways$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/alpha/projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Vpngateways$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Vpngateways$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the VPN gateway to delete. + */ + vpnGateway?: string; + } + export interface Params$Resource$Vpngateways$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the VPN gateway to return. + */ + vpnGateway?: string; + } + export interface Params$Resource$Vpngateways$Getstatus + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the VPN gateway to return. + */ + vpnGateway?: string; + } + export interface Params$Resource$Vpngateways$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VpnGateway; + } + export interface Params$Resource$Vpngateways$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Vpngateways$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Vpngateways$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Vpntunnels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.vpnTunnels.aggregatedList + * @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 {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Vpntunnels$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Vpntunnels$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Vpntunnels$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Vpntunnels$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpntunnels$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpntunnels$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/vpnTunnels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnTunnels.delete + * @desc Deletes the specified VpnTunnel resource. + * @alias compute.vpnTunnels.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.vpnTunnel Name of the VpnTunnel resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Vpntunnels$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Vpntunnels$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Vpntunnels$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Vpntunnels$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpntunnels$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpntunnels$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}/vpnTunnels/{vpnTunnel}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'vpnTunnel'], + pathParams: ['project', 'region', 'vpnTunnel'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnTunnels.get + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. + * @alias compute.vpnTunnels.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.vpnTunnel Name of the VpnTunnel resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Vpntunnels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Vpntunnels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Vpntunnels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Vpntunnels$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Vpntunnels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpntunnels$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}/vpnTunnels/{vpnTunnel}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'vpnTunnel'], + pathParams: ['project', 'region', 'vpnTunnel'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnTunnels.insert + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. + * @alias compute.vpnTunnels.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().VpnTunnel} params.resource Request body data + * @param {object} [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$Vpntunnels$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Vpntunnels$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Vpntunnels$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Vpntunnels$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpntunnels$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpntunnels$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}/vpnTunnels' + ).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.vpnTunnels.list + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. + * @alias compute.vpnTunnels.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Vpntunnels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Vpntunnels$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Vpntunnels$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Vpntunnels$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Vpntunnels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpntunnels$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}/vpnTunnels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnTunnels.setLabels + * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. + * @alias compute.vpnTunnels.setLabels + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().RegionSetLabelsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setLabels( + params?: Params$Resource$Vpntunnels$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Vpntunnels$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Vpntunnels$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Vpntunnels$Setlabels + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpntunnels$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpntunnels$Setlabels; + 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}/vpnTunnels/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.vpnTunnels.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.vpnTunnels.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Vpntunnels$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Vpntunnels$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Vpntunnels$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Vpntunnels$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vpntunnels$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vpntunnels$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/alpha/projects/{project}/regions/{region}/vpnTunnels/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Vpntunnels$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Vpntunnels$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the VpnTunnel resource to delete. + */ + vpnTunnel?: string; + } + export interface Params$Resource$Vpntunnels$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the VpnTunnel resource to return. + */ + vpnTunnel?: string; + } + export interface Params$Resource$Vpntunnels$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VpnTunnel; + } + export interface Params$Resource$Vpntunnels$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Vpntunnels$Setlabels + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Vpntunnels$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Zoneoperations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.zoneOperations.delete + * @desc Deletes the specified zone-specific Operations resource. + * @alias compute.zoneOperations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to delete. + * @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 + */ + delete( + params?: Params$Resource$Zoneoperations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Zoneoperations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Zoneoperations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Zoneoperations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Zoneoperations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zoneoperations$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}/zones/{zone}/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'operation'], + pathParams: ['operation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.zoneOperations.get + * @desc Retrieves the specified zone-specific Operations resource. + * @alias compute.zoneOperations.get + * @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 + */ + get( + params?: Params$Resource$Zoneoperations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Zoneoperations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Zoneoperations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Zoneoperations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Zoneoperations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zoneoperations$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}/zones/{zone}/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'operation'], + pathParams: ['operation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.zoneOperations.list + * @desc Retrieves a list of Operation resources contained within the specified zone. + * @alias compute.zoneOperations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone Name of the zone 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$Zoneoperations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Zoneoperations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Zoneoperations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Zoneoperations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Zoneoperations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zoneoperations$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}/zones/{zone}/operations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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/alpha/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 + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to delete. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Zoneoperations$Get + 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 interface Params$Resource$Zoneoperations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for request. + */ + 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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.zones.get + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. + * @alias compute.zones.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.zone Name of the zone resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Zones$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Zones$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Zones$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Zones$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Zones$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zones$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}/zones/{zone}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.zones.list + * @desc Retrieves the list of Zone resources available to the specified project. + * @alias compute.zones.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$Zones$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Zones$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Zones$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Zones$List + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Zones$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zones$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}/zones').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Zones$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone resource to return. + */ + zone?: string; + } + export interface Params$Resource$Zones$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; + } +} diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 1369ec4a828..58e9019aafa 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -264,11 +264,11 @@ export namespace compute_beta { /** * The number of the guest accelerator cards exposed to this instance. */ - acceleratorCount?: number; + acceleratorCount?: number | null; /** * Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. */ - acceleratorType?: string; + acceleratorType?: string | null; } /** * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) @@ -277,7 +277,7 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this accelerator type. */ @@ -285,53 +285,53 @@ export namespace compute_beta { /** * [Output Only] An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Maximum accelerator cards allowed per instance. */ - maximumCardsPerInstance?: number; + maximumCardsPerInstance?: number | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$AcceleratorTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AcceleratorTypesScopedList resources. */ - items?: {[key: string]: Schema$AcceleratorTypesScopedList}; + items?: {[key: string]: Schema$AcceleratorTypesScopedList} | null; /** * [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -339,7 +339,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of accelerator types. @@ -348,7 +348,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AcceleratorType resources. */ @@ -356,15 +356,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -372,7 +372,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AcceleratorTypesScopedList { /** @@ -386,7 +386,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * An access configuration attached to an instance's network interface. Only one access config per instance is supported. @@ -395,31 +395,31 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#accessConfig for access configs. */ - kind?: string; + kind?: string | null; /** * The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. */ - name?: string; + name?: string | null; /** * An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. */ - natIP?: string; + natIP?: string | null; /** * This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. */ - networkTier?: string; + networkTier?: string | null; /** * The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. */ - publicPtrDomainName?: string; + publicPtrDomainName?: string | null; /** * Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. */ - setPublicPtr?: boolean; + setPublicPtr?: boolean | null; /** * The type of configuration. The default and only option is ONE_TO_ONE_NAT. */ - type?: string; + type?: string | null; } /** * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) @@ -428,101 +428,101 @@ export namespace compute_beta { /** * The static IP address represented by this resource. */ - address?: string; + address?: string | null; /** * The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. */ - addressType?: string; + addressType?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ - ipVersion?: string; + ipVersion?: string | null; /** * [Output Only] Type of the resource. Always compute#address for addresses. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: 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?: string; + name?: string | null; /** * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. */ - network?: string; + network?: string | null; /** * This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ - networkTier?: string; + networkTier?: string | null; /** * The prefix length if the resource reprensents an IP range. */ - prefixLength?: number; + prefixLength?: number | null; /** * The purpose of this resource, which can be one of the following values: - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. - `DNS_RESOLVER` for a DNS resolver address in a subnetwork - `VPC_PEERING` for addresses that are reserved for VPC peer networks. - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. */ - purpose?: string; + purpose?: string | null; /** * [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. */ - status?: string; + status?: string | null; /** * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output Only] The URLs of the resources that are using this address. */ - users?: string[]; + users?: string[] | null; } export interface Schema$AddressAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AddressesScopedList resources. */ - items?: {[key: string]: Schema$AddressesScopedList}; + items?: {[key: string]: Schema$AddressesScopedList} | null; /** * [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -530,7 +530,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AddressesScopedList { /** @@ -544,7 +544,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of addresses. @@ -553,7 +553,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Address resources. */ @@ -561,15 +561,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#addressList for lists of addresses. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -577,7 +577,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * An alias IP range attached to an instance's network interface. @@ -586,21 +586,21 @@ export namespace compute_beta { /** * The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. */ - subnetworkRangeName?: string; + subnetworkRangeName?: string | null; } export interface Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk { /** * Specifies the size of the disk in base-2 GB. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ - interface?: string; + interface?: string | null; } /** * Properties of the SKU instances being reserved. @@ -617,11 +617,11 @@ export namespace compute_beta { /** * Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. */ - machineType?: string; + machineType?: string | null; /** * Minimum cpu platform the reservation. */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; } /** * This reservation type allows to pre allocate specific instance configuration. @@ -630,7 +630,7 @@ export namespace compute_beta { /** * Specifies the number of resources that are allocated. */ - count?: string; + count?: string | null; /** * The instance properties for the reservation. */ @@ -638,7 +638,7 @@ export namespace compute_beta { /** * [OutputOnly] Indicates how many instances are in use. */ - inUseCount?: string; + inUseCount?: string | null; } /** * An instance-attached disk resource. @@ -647,15 +647,15 @@ export namespace compute_beta { /** * 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; + 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; + boot?: boolean | null; /** * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. */ - deviceName?: string; + deviceName?: string | null; /** * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ @@ -667,7 +667,7 @@ export namespace compute_beta { /** * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. */ - index?: number; + index?: number | null; /** * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ @@ -675,27 +675,27 @@ export namespace compute_beta { /** * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported. */ - interface?: string; + interface?: string | null; /** * [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. */ - kind?: string; + kind?: string | null; /** * [Output Only] Any valid publicly visible licenses. */ - licenses?: string[]; + licenses?: 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; + mode?: string | null; /** - * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. */ - source?: string; + source?: string | null; /** * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. */ - type?: string; + type?: string | null; } /** * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. @@ -704,19 +704,19 @@ export namespace compute_beta { /** * An optional description. Provide this property when creating the disk. */ - description?: string; + description?: string | null; /** * Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. */ - diskName?: string; + 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. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. */ - diskType?: string; + 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures */ @@ -724,23 +724,23 @@ export namespace compute_beta { /** * Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; /** - * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. */ - sourceImage?: string; + sourceImage?: string | null; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. + * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. */ - sourceSnapshot?: string; + sourceSnapshot?: string | null; /** * The customer-supplied encryption key of the source snapshot. */ @@ -754,11 +754,11 @@ export namespace compute_beta { * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ - service?: string; + 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. @@ -767,15 +767,15 @@ export namespace compute_beta { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. */ - ignoreChildExemptions?: boolean; + ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Authorization-related information used by Cloud Audit Logging. @@ -784,7 +784,7 @@ export namespace compute_beta { /** * The type of the permission that was checked. */ - permissionType?: string; + permissionType?: string | null; } /** * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) @@ -797,35 +797,35 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of the autoscaler configuration. */ - status?: string; + status?: string | null; /** * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. */ @@ -833,33 +833,33 @@ export namespace compute_beta { /** * URL of the managed instance group that this autoscaler will scale. */ - target?: string; + target?: string | null; /** * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). */ - zone?: string; + zone?: string | null; } export interface Schema$AutoscalerAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AutoscalersScopedList resources. */ - items?: {[key: string]: Schema$AutoscalersScopedList}; + items?: {[key: string]: Schema$AutoscalersScopedList} | null; /** * [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -867,7 +867,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Autoscaler resources. @@ -876,7 +876,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Autoscaler resources. */ @@ -884,15 +884,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -900,7 +900,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AutoscalersScopedList { /** @@ -914,17 +914,17 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AutoscalerStatusDetails { /** * The status message. */ - message?: string; + message?: string | null; /** * The type of error returned. */ - type?: string; + type?: string | null; } /** * Cloud Autoscaler policy. @@ -933,7 +933,7 @@ export namespace compute_beta { /** * The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. */ - coolDownPeriodSec?: number; + coolDownPeriodSec?: number | null; /** * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. */ @@ -949,11 +949,11 @@ export namespace compute_beta { /** * The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. */ - maxNumReplicas?: number; + maxNumReplicas?: number | null; /** * 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; + minNumReplicas?: number | null; } /** * CPU utilization policy. @@ -962,7 +962,7 @@ export namespace compute_beta { /** * The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. */ - utilizationTarget?: number; + utilizationTarget?: number | null; } /** * Custom utilization metric policy. @@ -971,23 +971,23 @@ export namespace compute_beta { /** * A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value. */ - filter?: string; + filter?: string | null; /** * The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. */ - metric?: string; + metric?: string | null; /** * If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead. */ - singleInstanceAssignment?: number; + singleInstanceAssignment?: number | null; /** * The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances. */ - utilizationTarget?: number; + utilizationTarget?: number | null; /** * Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. */ - utilizationTargetType?: string; + utilizationTargetType?: string | null; } /** * Configuration parameters of autoscaling based on load balancing. @@ -996,7 +996,7 @@ export namespace compute_beta { /** * Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. */ - utilizationTarget?: number; + utilizationTarget?: number | null; } /** * Message containing information of one individual backend. @@ -1005,51 +1005,51 @@ export namespace compute_beta { /** * Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol. */ - balancingMode?: string; + balancingMode?: string | null; /** * A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing. */ - capacityScaler?: number; + capacityScaler?: number | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. */ - failover?: boolean; + failover?: boolean | null; /** * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. */ - group?: string; + group?: string | null; /** * Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION. */ - maxConnections?: number; + maxConnections?: number | null; /** * Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION. */ - maxConnectionsPerEndpoint?: number; + maxConnectionsPerEndpoint?: number | null; /** * Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION. */ - maxConnectionsPerInstance?: number; + maxConnectionsPerInstance?: number | null; /** * The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ - maxRate?: number; + maxRate?: number | null; /** * Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION. */ - maxRatePerEndpoint?: number; + maxRatePerEndpoint?: number | null; /** * Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION. */ - maxRatePerInstance?: number; + maxRatePerInstance?: number | null; /** * Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance. */ - maxUtilization?: number; + maxUtilization?: number | null; } /** * Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. @@ -1058,7 +1058,7 @@ export namespace compute_beta { /** * Cloud Storage bucket name. */ - bucketName?: string; + bucketName?: string | null; /** * Cloud CDN configuration for this BackendBucket. */ @@ -1066,31 +1066,31 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; + description?: string | null; /** * If true, enable Cloud CDN for this BackendBucket. */ - enableCdn?: boolean; + enableCdn?: boolean | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * Type of the resource. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * Message containing Cloud CDN configuration for a backend bucket. @@ -1099,11 +1099,11 @@ export namespace compute_beta { /** * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ - signedUrlCacheMaxAgeSec?: string; + signedUrlCacheMaxAgeSec?: string | null; /** * [Output Only] Names of the keys for signing request URLs. */ - signedUrlKeyNames?: string[]; + signedUrlKeyNames?: string[] | null; } /** * Contains a list of BackendBucket resources. @@ -1112,7 +1112,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of BackendBucket resources. */ @@ -1120,15 +1120,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1136,7 +1136,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) @@ -1145,7 +1145,7 @@ export namespace compute_beta { /** * If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400). */ - affinityCookieTtlSec?: number; + affinityCookieTtlSec?: number | null; /** * The list of backends that serve this BackendService. */ @@ -1166,19 +1166,19 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * Headers that the HTTP/S load balancer should add to proxied requests. */ - customRequestHeaders?: string[]; + customRequestHeaders?: string[] | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS. */ - enableCDN?: boolean; + enableCDN?: boolean | null; /** * Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend. */ @@ -1186,28 +1186,28 @@ export namespace compute_beta { /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ - healthChecks?: string[]; + healthChecks?: string[] | null; iap?: Schema$BackendServiceIAP; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#backendService for backend services. */ - kind?: string; + kind?: string | null; /** * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. */ - loadBalancingScheme?: string; + loadBalancingScheme?: string | null; /** * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ - localityLbPolicy?: string; + localityLbPolicy?: string | null; /** * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. */ @@ -1215,11 +1215,11 @@ export namespace compute_beta { /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL. */ - network?: string; + network?: string | null; /** * Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ @@ -1227,35 +1227,35 @@ export namespace compute_beta { /** * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). */ - port?: number; + port?: number | null; /** * A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing). */ - portName?: string; + portName?: string | null; /** * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. */ - protocol?: string; + protocol?: string | null; /** * [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] The resource URL for the security policy associated with this backend service. */ - securityPolicy?: string; + securityPolicy?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + 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. */ - sessionAffinity?: string; + sessionAffinity?: string | null; /** * The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds. */ - timeoutSec?: number; + timeoutSec?: number | null; } /** * Contains a list of BackendServicesScopedList. @@ -1264,23 +1264,23 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of BackendServicesScopedList resources. */ - items?: {[key: string]: Schema$BackendServicesScopedList}; + items?: {[key: string]: Schema$BackendServicesScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1288,7 +1288,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Message containing Cloud CDN configuration for a backend service. @@ -1301,25 +1301,25 @@ export namespace compute_beta { /** * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ - signedUrlCacheMaxAgeSec?: string; + signedUrlCacheMaxAgeSec?: string | null; /** * [Output Only] Names of the keys for signing request URLs. */ - signedUrlKeyNames?: string[]; + signedUrlKeyNames?: string[] | null; } export interface Schema$BackendServiceFailoverPolicy { /** * This can be set to true only if the protocol is TCP. The default is false. */ - disableConnectionDrainOnFailover?: boolean; + disableConnectionDrainOnFailover?: boolean | null; /** * Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false. */ - dropTrafficIfUnhealthy?: boolean; + dropTrafficIfUnhealthy?: boolean | null; /** * Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. */ - failoverRatio?: number; + failoverRatio?: number | null; } export interface Schema$BackendServiceGroupHealth { /** @@ -1329,19 +1329,19 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. */ - kind?: string; + kind?: string | null; } /** * Identity-Aware Proxy */ export interface Schema$BackendServiceIAP { - enabled?: boolean; - oauth2ClientId?: string; - oauth2ClientSecret?: string; + enabled?: boolean | null; + oauth2ClientId?: string | null; + oauth2ClientSecret?: string | null; /** * [Output Only] SHA256 hash value for the field oauth2_client_secret above. */ - oauth2ClientSecretSha256?: string; + oauth2ClientSecretSha256?: string | null; } /** * Contains a list of BackendService resources. @@ -1350,7 +1350,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of BackendService resources. */ @@ -1358,15 +1358,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1374,7 +1374,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * The available logging options for the load balancer traffic served by this backend service. @@ -1383,14 +1383,14 @@ export namespace compute_beta { /** * This field denotes whether to enable logging for the load balancer traffic served by this backend service. */ - enable?: boolean; + enable?: boolean | null; /** * This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0. */ - sampleRate?: number; + sampleRate?: number | null; } export interface Schema$BackendServiceReference { - backendService?: string; + backendService?: string | null; } export interface Schema$BackendServicesScopedList { /** @@ -1404,73 +1404,73 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$BfdPacket { /** * The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880 */ - authenticationPresent?: boolean; + authenticationPresent?: boolean | null; /** * The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880 */ - controlPlaneIndependent?: boolean; + controlPlaneIndependent?: boolean | null; /** * The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880 */ - demand?: boolean; + demand?: boolean | null; /** * The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880 */ - diagnostic?: string; + diagnostic?: string | null; /** * The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880 */ - final?: boolean; + final?: boolean | null; /** * The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880 */ - length?: number; + length?: number | null; /** * The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 */ - minEchoRxIntervalMs?: number; + minEchoRxIntervalMs?: number | null; /** * The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 */ - minRxIntervalMs?: number; + minRxIntervalMs?: number | null; /** * The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 */ - minTxIntervalMs?: number; + minTxIntervalMs?: number | null; /** * The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880 */ - multiplier?: number; + multiplier?: number | null; /** * The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880 */ - multipoint?: boolean; + multipoint?: boolean | null; /** * The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880 */ - myDiscriminator?: number; + myDiscriminator?: number | null; /** * The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880 */ - poll?: boolean; + poll?: boolean | null; /** * The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 */ - state?: string; + state?: string | null; /** * The version number of the BFD protocol, as specified in section 4.1 of RFC5880. */ - version?: number; + version?: number | null; /** * The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880 */ - yourDiscriminator?: number; + yourDiscriminator?: number | null; } /** * Next free: 15 @@ -1479,11 +1479,11 @@ export namespace compute_beta { /** * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. */ - bfdSessionInitializationMode?: string; + bfdSessionInitializationMode?: string | null; /** * Unix timestamp of the most recent config update. */ - configUpdateTimestampMicros?: string; + configUpdateTimestampMicros?: string | null; /** * Control packet counts for the current BFD session. */ @@ -1495,15 +1495,15 @@ export namespace compute_beta { /** * The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880 */ - localDiagnostic?: string; + localDiagnostic?: string | null; /** * The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 */ - localState?: string; + localState?: string | null; /** * Negotiated transmit interval for control packets. */ - negotiatedLocalControlTxIntervalMs?: number; + negotiatedLocalControlTxIntervalMs?: number | null; /** * The most recent Rx control packet for this BFD session. */ @@ -1515,25 +1515,25 @@ export namespace compute_beta { /** * Session uptime in milliseconds. Value will be 0 if session is not up. */ - uptimeMs?: string; + uptimeMs?: string | null; } export interface Schema$BfdStatusPacketCounts { /** * Number of packets received since the beginning of the current BFD session. */ - numRx?: number; + numRx?: number | null; /** * Number of packets received that were rejected because of errors since the beginning of the current BFD session. */ - numRxRejected?: number; + numRxRejected?: number | null; /** * Number of packets received that were successfully processed since the beginning of the current BFD session. */ - numRxSuccessful?: number; + numRxSuccessful?: number | null; /** * Number of packets transmitted since the beginning of the current BFD session. */ - numTx?: number; + numTx?: number | null; } /** * Associates `members` with a `role`. @@ -1546,18 +1546,18 @@ export namespace compute_beta { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } export interface Schema$CacheInvalidationRule { /** * If set, this invalidation rule will only apply to requests with a Host header matching host. */ - host?: string; - path?: string; + host?: string | null; + path?: string | null; } /** * Message containing what to include in the cache key for a request for Cloud CDN. @@ -1566,23 +1566,23 @@ export namespace compute_beta { /** * If true, requests to different hosts will be cached separately. */ - includeHost?: boolean; + includeHost?: boolean | null; /** * If true, http and https requests will be cached separately. */ - includeProtocol?: boolean; + includeProtocol?: boolean | null; /** * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. */ - includeQueryString?: boolean; + includeQueryString?: boolean | null; /** * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ - queryStringBlacklist?: string[]; + queryStringBlacklist?: string[] | null; /** * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ - queryStringWhitelist?: string[]; + queryStringWhitelist?: string[] | null; } /** * Settings controlling the volume of connections to a backend service. @@ -1595,23 +1595,23 @@ export namespace compute_beta { /** * The maximum number of connections to the backend cluster. If not specified, the default is 1024. */ - maxConnections?: number; + maxConnections?: number | null; /** * The maximum number of pending requests allowed to the backend cluster. If not specified, the default is 1024. */ - maxPendingRequests?: number; + maxPendingRequests?: number | null; /** * The maximum number of parallel requests that allowed to the backend cluster. If not specified, the default is 1024. */ - maxRequests?: number; + maxRequests?: number | null; /** * Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. */ - maxRequestsPerConnection?: number; + maxRequestsPerConnection?: number | null; /** * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 3. */ - maxRetries?: number; + maxRetries?: number | null; } /** * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) @@ -1620,35 +1620,35 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] Commitment end time in RFC3339 text format. */ - endTimestamp?: string; + endTimestamp?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#commitment for commitments. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ - plan?: string; + plan?: string | null; /** * [Output Only] URL of the region where this commitment may be used. */ - region?: string; + region?: string | null; /** * List of reservations in this commitment. */ @@ -1660,45 +1660,45 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Commitment start time in RFC3339 text format. */ - startTimestamp?: string; + startTimestamp?: string | null; /** * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. */ - status?: string; + status?: string | null; /** * [Output Only] An optional, human-readable explanation of the status. */ - statusMessage?: string; + statusMessage?: string | null; /** * The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. */ - type?: string; + type?: string | null; } export interface Schema$CommitmentAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of CommitmentsScopedList resources. */ - items?: {[key: string]: Schema$CommitmentsScopedList}; + items?: {[key: string]: Schema$CommitmentsScopedList} | null; /** * [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1706,7 +1706,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Commitment resources. @@ -1715,7 +1715,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Commitment resources. */ @@ -1723,15 +1723,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1739,7 +1739,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$CommitmentsScopedList { /** @@ -1753,7 +1753,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A condition to be met. @@ -1762,23 +1762,23 @@ export namespace compute_beta { /** * Trusted attributes supplied by the IAM system. */ - iam?: string; + iam?: string | null; /** * An operator to apply the subject with. */ - op?: string; + op?: string | null; /** * Trusted attributes discharged by the service. */ - svc?: string; + svc?: string | null; /** * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ - sys?: string; + sys?: string | null; /** * The objects of the condition. */ - values?: string[]; + values?: string[] | null; } /** * Message containing connection draining configuration. @@ -1787,7 +1787,7 @@ export namespace compute_beta { /** * The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]. */ - drainingTimeoutSec?: number; + drainingTimeoutSec?: number | null; } /** * This message defines settings for a consistent hash style load balancer. @@ -1800,11 +1800,11 @@ export namespace compute_beta { /** * The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD. */ - httpHeaderName?: string; + httpHeaderName?: string | null; /** * The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. */ - minimumRingSize?: string; + minimumRingSize?: string | null; } /** * The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. @@ -1813,11 +1813,11 @@ export namespace compute_beta { /** * Name of the cookie. */ - name?: string; + name?: string | null; /** * Path to set for the cookie. */ - path?: string; + path?: string | null; /** * Lifetime of the cookie. */ @@ -1830,35 +1830,35 @@ export namespace compute_beta { /** * In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default is false. */ - allowCredentials?: boolean; + allowCredentials?: boolean | null; /** * Specifies the content for the Access-Control-Allow-Headers header. */ - allowHeaders?: string[]; + allowHeaders?: string[] | null; /** * Specifies the content for the Access-Control-Allow-Methods header. */ - allowMethods?: string[]; + allowMethods?: string[] | null; /** * Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex. */ - allowOriginRegexes?: string[]; + allowOriginRegexes?: string[] | null; /** * Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex. */ - allowOrigins?: string[]; + allowOrigins?: string[] | null; /** * If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. */ - disabled?: boolean; + disabled?: boolean | null; /** * Specifies the content for the Access-Control-Expose-Headers header. */ - exposeHeaders?: string[]; + exposeHeaders?: string[] | null; /** * Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. */ - maxAge?: number; + maxAge?: number | null; } /** * Represents a customer-supplied encryption key @@ -1867,19 +1867,19 @@ export namespace compute_beta { /** * The name of the encryption key that is stored in Google Cloud KMS. */ - kmsKeyName?: string; + kmsKeyName?: string | null; /** * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. */ - rawKey?: string; + rawKey?: string | null; /** * Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: - The key is wrapped using a RSA public key certificate provided by Google. - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem */ - rsaEncryptedKey?: string; + rsaEncryptedKey?: string | null; /** * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. */ - sha256?: string; + sha256?: string | null; } export interface Schema$CustomerEncryptionKeyProtectedDisk { /** @@ -1889,7 +1889,7 @@ export namespace compute_beta { /** * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. */ - source?: string; + source?: string | null; } /** * Deprecation status for a public resource. @@ -1898,23 +1898,23 @@ export namespace compute_beta { /** * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. */ - deleted?: string; + deleted?: string | null; /** * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. */ - deprecated?: string; + deprecated?: string | null; /** * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. */ - obsolete?: string; + obsolete?: string | null; /** * The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. */ - replacement?: string; + replacement?: string | null; /** * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. */ - state?: string; + state?: string | null; } /** * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) @@ -1923,11 +1923,11 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * 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. */ @@ -1939,71 +1939,71 @@ export namespace compute_beta { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#disk for disks. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this disk. These can be later modified by the setLabels method. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Output Only] Last attach timestamp in RFC3339 text format. */ - lastAttachTimestamp?: string; + lastAttachTimestamp?: string | null; /** * [Output Only] Last detach timestamp in RFC3339 text format. */ - lastDetachTimestamp?: string; + lastDetachTimestamp?: string | null; /** * Integer license codes indicating which licenses are attached to this disk. */ - licenseCodes?: string[]; + licenseCodes?: string[] | null; /** * A list of publicly visible licenses. Reserved for Google's use. */ - licenses?: string[]; + licenses?: string[] | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Internal use only. */ - options?: string; + options?: string | null; /** * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. */ - physicalBlockSizeBytes?: string; + physicalBlockSizeBytes?: string | null; /** * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ - replicaZones?: string[]; + replicaZones?: string[] | null; /** * Resource policies applied to this disk for automatic snapshot creations. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. */ - sizeGb?: string; + sizeGb?: string | null; /** * The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family */ - sourceImage?: string; + sourceImage?: string | null; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ @@ -2011,11 +2011,11 @@ export namespace compute_beta { /** * [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. */ - sourceImageId?: string; + sourceImageId?: string | null; /** * The source snapshot used to create this disk. 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/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot */ - sourceSnapshot?: string; + sourceSnapshot?: string | null; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ @@ -2023,49 +2023,49 @@ export namespace compute_beta { /** * [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; + sourceSnapshotId?: 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. */ - status?: string; + status?: string | null; /** * [Deprecated] Storage type of the persistent disk. */ - storageType?: string; + storageType?: string | null; /** * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ - type?: string; + type?: string | null; /** * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance */ - users?: string[]; + users?: string[] | null; /** * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$DiskAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DisksScopedList resources. */ - items?: {[key: string]: Schema$DisksScopedList}; + items?: {[key: string]: Schema$DisksScopedList} | null; /** * [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2073,7 +2073,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. @@ -2082,19 +2082,19 @@ export namespace compute_beta { /** * 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; + autoDelete?: boolean | null; /** * The custom source image to be used to restore this disk when instantiating this instance template. */ - customImage?: string; + customImage?: string | null; /** * Specifies the device name of the disk to which the configurations apply to. */ - deviceName?: string; + deviceName?: string | null; /** * Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. */ - instantiateFrom?: string; + instantiateFrom?: string | null; } /** * A list of Disk resources. @@ -2103,7 +2103,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Disk resources. */ @@ -2111,15 +2111,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#diskList for lists of disks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2127,35 +2127,35 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$DiskMoveRequest { /** * The URL of the destination zone to move the disk. 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 */ - destinationZone?: string; + destinationZone?: string | null; /** * The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ - targetDisk?: string; + targetDisk?: string | null; } export interface Schema$DisksAddResourcePoliciesRequest { /** * Resource policies to be added to this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$DisksRemoveResourcePoliciesRequest { /** * Resource policies to be removed from this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$DisksResizeRequest { /** * The new size of the persistent disk, which is specified in GB. */ - sizeGb?: string; + sizeGb?: string | null; } export interface Schema$DisksScopedList { /** @@ -2169,7 +2169,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) @@ -2178,11 +2178,11 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] Server-defined default disk size in GB. */ - defaultDiskSizeGb?: string; + defaultDiskSizeGb?: string | null; /** * [Output Only] The deprecation status associated with this disk type. */ @@ -2190,57 +2190,57 @@ export namespace compute_beta { /** * [Output Only] An optional description of this resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#diskType for disk types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". */ - validDiskSize?: string; + validDiskSize?: string | null; /** * [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$DiskTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DiskTypesScopedList resources. */ - items?: {[key: string]: Schema$DiskTypesScopedList}; + items?: {[key: string]: Schema$DiskTypesScopedList} | null; /** * [Output Only] Type of resource. Always compute#diskTypeAggregatedList. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2248,7 +2248,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of disk types. @@ -2257,7 +2257,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DiskType resources. */ @@ -2265,15 +2265,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#diskTypeList for disk types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2281,7 +2281,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$DiskTypesScopedList { /** @@ -2295,7 +2295,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A set of Display Device options @@ -2304,7 +2304,7 @@ export namespace compute_beta { /** * Defines whether the instance has Display enabled. */ - enableDisplay?: boolean; + enableDisplay?: boolean | null; } export interface Schema$DistributionPolicy { /** @@ -2316,7 +2316,7 @@ export namespace compute_beta { /** * The URL of the zone. The zone must exist in the region where the managed instance group is located. */ - zone?: string; + zone?: string | null; } /** * A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. @@ -2325,39 +2325,39 @@ export namespace compute_beta { /** * Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. */ - nanos?: number; + nanos?: number | null; /** * Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years */ - seconds?: string; + seconds?: string | null; } export interface Schema$ExchangedPeeringRoute { /** * The destination range of the route. */ - destRange?: string; + 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; + imported?: boolean | null; /** * The region of peering route next hop, only applies to dynamic routes. */ - nextHopRegion?: string; + nextHopRegion?: string | null; /** * The priority of the peering route. */ - priority?: number; + priority?: number | null; /** * The type of the peering route. */ - type?: string; + type?: string | null; } export interface Schema$ExchangedPeeringRoutesList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ExchangedPeeringRoute resources. */ @@ -2365,15 +2365,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2381,7 +2381,7 @@ export namespace compute_beta { 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" @@ -2390,19 +2390,19 @@ export namespace compute_beta { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. @@ -2411,15 +2411,15 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * List of interfaces for this external VPN gateway. */ @@ -2427,27 +2427,27 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this ExternalVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Indicates the user-supplied redundancy type of this external VPN gateway. */ - redundancyType?: string; + redundancyType?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * The interface for the external VPN gateway. @@ -2456,21 +2456,21 @@ export namespace compute_beta { /** * The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 */ - id?: number; + id?: number | null; /** * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. */ - ipAddress?: string; + ipAddress?: string | null; } /** * Response to the list request, and contains a list of externalVpnGateways. */ export interface Schema$ExternalVpnGatewayList { - etag?: string; + etag?: string | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ExternalVpnGateway resources. */ @@ -2478,15 +2478,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2494,7 +2494,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. @@ -2503,43 +2503,43 @@ export namespace compute_beta { /** * The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. */ - allowed?: Array<{IPProtocol?: string; ports?: string[]}>; + allowed?: Array<{IPProtocol?: string; ports?: string[]}> | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. */ - denied?: Array<{IPProtocol?: string; ports?: string[]}>; + denied?: Array<{IPProtocol?: string; ports?: string[]}> | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ - destinationRanges?: string[]; + destinationRanges?: string[] | null; /** * Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields. */ - direction?: string; + direction?: string | null; /** * Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ - disabled?: boolean; + disabled?: boolean | null; /** * Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ - enableLogging?: boolean; + enableLogging?: boolean | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#firewall for firewall rules. */ - kind?: string; + kind?: string | null; /** * This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ @@ -2547,39 +2547,39 @@ export namespace compute_beta { /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. 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; + name?: string | null; /** * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ - network?: string; + network?: string | null; /** * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ - priority?: number; + priority?: number | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported. */ - sourceRanges?: string[]; + sourceRanges?: string[] | null; /** * If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ - sourceServiceAccounts?: string[]; + sourceServiceAccounts?: string[] | null; /** * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. */ - sourceTags?: string[]; + sourceTags?: string[] | null; /** * A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. */ - targetServiceAccounts?: string[]; + targetServiceAccounts?: string[] | null; /** * A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. */ - targetTags?: string[]; + targetTags?: string[] | null; } /** * Contains a list of firewalls. @@ -2588,7 +2588,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Firewall resources. */ @@ -2596,15 +2596,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#firewallList for lists of firewalls. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2612,7 +2612,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * The available logging options for a firewall rule. @@ -2621,7 +2621,7 @@ export namespace compute_beta { /** * This field denotes whether to enable logging for a particular firewall rule. */ - enable?: boolean; + enable?: boolean | null; } /** * Encapsulates numeric value that can be either absolute or relative. @@ -2630,15 +2630,15 @@ export namespace compute_beta { /** * [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up. */ - calculated?: number; + calculated?: number | null; /** * Specifies a fixed number of VM instances. This must be a positive integer. */ - fixed?: number; + fixed?: number | null; /** * Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. */ - percent?: number; + percent?: number | null; } /** * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) @@ -2647,59 +2647,59 @@ export namespace compute_beta { /** * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. */ - allowGlobalAccess?: boolean; + allowGlobalAccess?: boolean | null; /** * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. */ - allPorts?: boolean; + allPorts?: boolean | null; /** * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. */ - backendService?: string; + backendService?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: * projects/project_id/regions/region/addresses/address-name * regions/region/addresses/address-name * global/addresses/address-name * address-name The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). */ - IPAddress?: string; + IPAddress?: string | null; /** * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. */ - IPProtocol?: string; + IPProtocol?: string | null; /** * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. */ - ipVersion?: string; + ipVersion?: string | null; /** * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) */ - loadBalancingScheme?: string; + 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. */ @@ -2707,69 +2707,69 @@ export namespace compute_beta { /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * This field is not used for external load balancing. For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. */ - network?: string; + network?: string | null; /** * This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. */ - networkTier?: string; + networkTier?: string | null; /** * This field is deprecated. See the port field. */ - portRange?: string; + 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. */ - ports?: string[]; + ports?: string[] | null; /** * [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. This field is only used for internal load balancing. */ - serviceLabel?: string; + serviceLabel?: string | null; /** * [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. */ - serviceName?: string; + serviceName?: string | null; /** * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. */ - subnetwork?: string; + subnetwork?: string | null; /** * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. */ - target?: string; + target?: string | null; } export interface Schema$ForwardingRuleAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ForwardingRulesScopedList resources. */ - items?: {[key: string]: Schema$ForwardingRulesScopedList}; + items?: {[key: string]: Schema$ForwardingRulesScopedList} | null; /** * [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2777,7 +2777,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of ForwardingRule resources. @@ -2786,7 +2786,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ForwardingRule resources. */ @@ -2794,15 +2794,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2810,10 +2810,10 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ForwardingRuleReference { - forwardingRule?: string; + forwardingRule?: string | null; } export interface Schema$ForwardingRulesScopedList { /** @@ -2827,17 +2827,17 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$GlobalSetLabelsRequest { /** * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } export interface Schema$GlobalSetPolicyRequest { /** @@ -2847,7 +2847,7 @@ export namespace compute_beta { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -2860,11 +2860,11 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. */ - kind?: string; + kind?: string | null; /** * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') */ - queryPath?: string; + queryPath?: string | null; /** * [Output Only] The value of the requested queried path. */ @@ -2872,15 +2872,15 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The key to search for. */ - variableKey?: string; + variableKey?: string | null; /** * [Output Only] The value found for the requested key. */ - variableValue?: string; + variableValue?: string | null; } /** * A guest attributes namespace/key/value entry. @@ -2889,15 +2889,15 @@ export namespace compute_beta { /** * Key for the guest attribute entry. */ - key?: string; + key?: string | null; /** * Namespace for the guest attribute entry. */ - namespace?: string; + namespace?: string | null; /** * Value for the guest attribute entry. */ - value?: string; + value?: string | null; } /** * Array of guest attribute namespace/key/value tuples. @@ -2912,7 +2912,7 @@ export namespace compute_beta { /** * The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. */ - type?: string; + type?: string | null; } /** * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. @@ -2921,56 +2921,56 @@ export namespace compute_beta { /** * How often (in seconds) to send a health check. The default value is 5 seconds. */ - checkIntervalSec?: number; + checkIntervalSec?: number | null; /** * [Output Only] Creation timestamp in 3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ - healthyThreshold?: number; + healthyThreshold?: number | null; http2HealthCheck?: Schema$HTTP2HealthCheck; httpHealthCheck?: Schema$HTTPHealthCheck; httpsHealthCheck?: Schema$HTTPSHealthCheck; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Type of the resource. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] Region where the health check resides. Not applicable to global health checks. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; sslHealthCheck?: Schema$SSLHealthCheck; tcpHealthCheck?: Schema$TCPHealthCheck; /** * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ - timeoutSec?: number; + timeoutSec?: number | null; /** * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. */ - type?: string; + type?: string | null; /** * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } /** * Contains a list of HealthCheck resources. @@ -2979,7 +2979,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of HealthCheck resources. */ @@ -2987,15 +2987,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3003,35 +3003,35 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ export interface Schema$HealthCheckReference { - healthCheck?: string; + healthCheck?: string | null; } export interface Schema$HealthChecksAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of HealthChecksScopedList resources. */ - items?: {[key: string]: Schema$HealthChecksScopedList}; + items?: {[key: string]: Schema$HealthChecksScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3039,7 +3039,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$HealthChecksScopedList { /** @@ -3053,25 +3053,25 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$HealthStatus { /** * Health state of the instance. */ - healthState?: string; + healthState?: string | null; /** * URL of the instance resource. */ - instance?: string; + instance?: string | null; /** * The IP address represented by this resource. */ - ipAddress?: string; + ipAddress?: string | null; /** * The port on the instance. */ - port?: number; + port?: number | null; } export interface Schema$HealthStatusForNetworkEndpoint { /** @@ -3089,7 +3089,7 @@ export namespace compute_beta { /** * Health state of the network endpoint determined based on the health checks configured. */ - healthState?: string; + healthState?: string | null; } /** * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. @@ -3098,45 +3098,45 @@ export namespace compute_beta { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. */ - hosts?: string[]; + hosts?: string[] | null; /** * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. */ - pathMatcher?: string; + pathMatcher?: string | null; } export interface Schema$HTTP2HealthCheck { /** * The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The request path of the HTTP/2 health check request. The default value is /. */ - requestPath?: string; + requestPath?: string | null; /** * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } /** * Specification for how requests are aborted as part of fault injection. @@ -3145,11 +3145,11 @@ export namespace compute_beta { /** * The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. */ - httpStatus?: number; + httpStatus?: number | null; /** * The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. */ - percentage?: number; + percentage?: number | null; } /** * Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. @@ -3162,7 +3162,7 @@ export namespace compute_beta { /** * The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. */ - percentage?: number; + percentage?: number | null; } /** * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. @@ -3188,7 +3188,7 @@ export namespace compute_beta { /** * A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. */ - requestHeadersToRemove?: string[]; + requestHeadersToRemove?: string[] | null; /** * Headers to add the response prior to sending the response back to the client. */ @@ -3196,7 +3196,7 @@ export namespace compute_beta { /** * A list of header names for headers that need to be removed from the response prior to sending the response back to the client. */ - responseHeadersToRemove?: string[]; + responseHeadersToRemove?: string[] | null; } /** * matchRule criteria for request header matches. @@ -3205,23 +3205,23 @@ export namespace compute_beta { /** * The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ - exactMatch?: string; + exactMatch?: string | null; /** * The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". */ - headerName?: string; + headerName?: string | null; /** * If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false. */ - invertMatch?: boolean; + invertMatch?: boolean | null; /** * The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ - prefixMatch?: string; + prefixMatch?: string | null; /** * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ - presentMatch?: boolean; + presentMatch?: boolean | null; /** * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ @@ -3229,11 +3229,11 @@ export namespace compute_beta { /** * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ - regexMatch?: string; + regexMatch?: string | null; /** * The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ - suffixMatch?: string; + suffixMatch?: string | null; } /** * Specification determining how headers are added to requests or responses. @@ -3242,15 +3242,15 @@ export namespace compute_beta { /** * The name of the header. */ - headerName?: string; + headerName?: string | null; /** * The value of the header to add. */ - headerValue?: string; + headerValue?: string | null; /** * If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. */ - replace?: boolean; + replace?: boolean | null; } /** * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. @@ -3259,85 +3259,85 @@ export namespace compute_beta { /** * How often (in seconds) to send a health check. The default value is 5 seconds. */ - checkIntervalSec?: number; + checkIntervalSec?: number | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ - healthyThreshold?: number; + healthyThreshold?: number | null; /** * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The TCP port number for the HTTP health check request. The default value is 80. */ - port?: number; + port?: number | null; /** * The request path of the HTTP health check request. The default value is /. This field does not support query parameters. */ - requestPath?: string; + requestPath?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ - timeoutSec?: number; + timeoutSec?: number | null; /** * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } export interface Schema$HTTPHealthCheck { /** * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The request path of the HTTP health check request. The default value is /. */ - requestPath?: string; + requestPath?: string | null; /** * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } /** * Contains a list of HttpHealthCheck resources. @@ -3346,7 +3346,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of HttpHealthCheck resources. */ @@ -3354,15 +3354,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3370,7 +3370,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * HttpRouteRuleMatch criteria for a request's query parameter. @@ -3379,19 +3379,19 @@ export namespace compute_beta { /** * 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. */ - exactMatch?: string; + exactMatch?: string | null; /** * The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. */ - name?: string; + 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. */ - presentMatch?: boolean; + presentMatch?: boolean | null; /** * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set. */ - regexMatch?: string; + regexMatch?: string | null; } /** * Specifies settings for an HTTP redirect. @@ -3400,27 +3400,27 @@ export namespace compute_beta { /** * The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. */ - hostRedirect?: string; + hostRedirect?: string | null; /** * If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. */ - httpsRedirect?: boolean; + httpsRedirect?: boolean | null; /** * The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters. */ - pathRedirect?: string; + pathRedirect?: string | null; /** * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. */ - prefixRedirect?: string; + prefixRedirect?: string | null; /** * The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. */ - redirectResponseCode?: string; + redirectResponseCode?: string | null; /** * If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. */ - stripQuery?: boolean; + stripQuery?: boolean | null; } /** * The retry policy associates with HttpRouteRule @@ -3429,7 +3429,7 @@ export namespace compute_beta { /** * Specifies the allowed number retries. This number must be > 0. */ - numRetries?: number; + numRetries?: number | null; /** * Specifies a non-zero timeout per retry attempt. */ @@ -3437,7 +3437,7 @@ export namespace compute_beta { /** * Specfies one or more conditions when this retry rule applies. Valid values are: - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable */ - retryConditions?: string[]; + retryConditions?: string[] | null; } export interface Schema$HttpRouteAction { /** @@ -3485,7 +3485,7 @@ export namespace compute_beta { /** * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ - service?: string; + service?: string | null; /** * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. */ @@ -3498,7 +3498,7 @@ export namespace compute_beta { /** * 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. */ - fullPathMatch?: string; + fullPathMatch?: string | null; /** * Specifies a list of header match criteria, all of which must match corresponding headers in the request. */ @@ -3506,7 +3506,7 @@ export namespace compute_beta { /** * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive must not be used with regexMatch. */ - ignoreCase?: boolean; + 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. */ @@ -3514,7 +3514,7 @@ export namespace compute_beta { /** * 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. */ - prefixMatch?: string; + prefixMatch?: string | null; /** * Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. */ @@ -3522,7 +3522,7 @@ export namespace compute_beta { /** * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ - regexMatch?: string; + regexMatch?: string | null; } /** * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. @@ -3531,85 +3531,85 @@ export namespace compute_beta { /** * How often (in seconds) to send a health check. The default value is 5 seconds. */ - checkIntervalSec?: number; + checkIntervalSec?: number | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ - healthyThreshold?: number; + healthyThreshold?: number | null; /** * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Type of the resource. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The TCP port number for the HTTPS health check request. The default value is 443. */ - port?: number; + port?: number | null; /** * The request path of the HTTPS health check request. The default value is "/". */ - requestPath?: string; + requestPath?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. */ - timeoutSec?: number; + timeoutSec?: number | null; /** * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } export interface Schema$HTTPSHealthCheck { /** * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The request path of the HTTPS health check request. The default value is /. */ - requestPath?: string; + requestPath?: string | null; /** * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } /** * Contains a list of HttpsHealthCheck resources. @@ -3618,7 +3618,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of HttpsHealthCheck resources. */ @@ -3626,15 +3626,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3642,7 +3642,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) @@ -3651,11 +3651,11 @@ export namespace compute_beta { /** * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ - archiveSizeBytes?: string; + archiveSizeBytes?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * The deprecation status associated with this image. */ @@ -3663,15 +3663,15 @@ export namespace compute_beta { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Size of the image when restored onto a persistent disk (in GB). */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. */ - family?: string; + family?: string | null; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -3679,7 +3679,7 @@ export namespace compute_beta { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. */ @@ -3687,39 +3687,43 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#image for images. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this image. These can be later modified by the setLabels method. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Integer license codes indicating which licenses are attached to this image. */ - licenseCodes?: string[]; + licenseCodes?: string[] | null; /** * Any applicable license URI. */ - licenses?: string[]; + licenses?: string[] | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The parameters of the raw disk image. */ - rawDisk?: {containerType?: string; sha1Checksum?: string; source?: string}; + rawDisk?: { + containerType?: string; + sha1Checksum?: string; + source?: string; + } | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ - sourceDisk?: string; + sourceDisk?: string | null; /** * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ @@ -3727,11 +3731,11 @@ export namespace compute_beta { /** * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. */ - sourceDiskId?: string; + sourceDiskId?: string | null; /** * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ - sourceImage?: string; + sourceImage?: string | null; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ @@ -3739,11 +3743,11 @@ export namespace compute_beta { /** * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. */ - sourceImageId?: string; + sourceImageId?: string | null; /** * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ - sourceSnapshot?: string; + sourceSnapshot?: string | null; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ @@ -3751,19 +3755,19 @@ export namespace compute_beta { /** * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. */ - sourceSnapshotId?: string; + sourceSnapshotId?: string | null; /** * The type of the image used to create this disk. The default and only value is RAW */ - sourceType?: string; + sourceType?: string | null; /** * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ - status?: string; + status?: string | null; /** * Cloud Storage bucket storage location of the image (regional or multi-regional). */ - storageLocations?: string[]; + storageLocations?: string[] | null; } /** * Contains a list of images. @@ -3772,7 +3776,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Image resources. */ @@ -3780,15 +3784,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3796,7 +3800,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) @@ -3805,23 +3809,23 @@ export namespace compute_beta { /** * Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. */ - canIpForward?: boolean; + canIpForward?: boolean | null; /** * [Output Only] The CPU platform used by this instance. */ - cpuPlatform?: string; + cpuPlatform?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * Whether the resource should be protected against deletion. */ - deletionProtection?: boolean; + deletionProtection?: boolean | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Array of disks associated with this instance. Persistent disks must be created before you can assign them. */ @@ -3837,27 +3841,27 @@ export namespace compute_beta { /** * Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. */ - hostname?: string; + hostname?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#instance for instances. */ - kind?: string; + kind?: string | null; /** * A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this instance. These can be later modified by the setLabels method. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. */ - machineType?: string; + machineType?: string | null; /** * The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. */ @@ -3865,11 +3869,11 @@ export namespace compute_beta { /** * Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". */ - minCpuPlatform?: string; + minCpuPlatform?: 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. */ - name?: string; + name?: string | null; /** * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. */ @@ -3885,7 +3889,7 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. */ @@ -3897,15 +3901,15 @@ export namespace compute_beta { /** * [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. */ - startRestricted?: boolean; + startRestricted?: boolean | null; /** * [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. */ - status?: string; + status?: string | null; /** * [Output Only] An optional, human-readable explanation of the status. */ - statusMessage?: string; + statusMessage?: string | null; /** * Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. */ @@ -3913,29 +3917,29 @@ export namespace compute_beta { /** * [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$InstanceAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * An object that contains a list of instances scoped by zone. */ - items?: {[key: string]: Schema$InstancesScopedList}; + items?: {[key: string]: Schema$InstancesScopedList} | null; /** * [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3943,7 +3947,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | 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 ==) @@ -3952,27 +3956,27 @@ export namespace compute_beta { /** * [Output Only] The creation timestamp for this instance group in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] A unique identifier for this instance group, generated by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The resource type, which is always compute#instanceGroup for instance groups. */ - kind?: string; + kind?: string | null; /** * The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. */ - name?: string; + name?: string | null; /** * Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. */ @@ -3980,49 +3984,49 @@ export namespace compute_beta { /** * The URL of the network to which all instances in the instance group belong. */ - network?: string; + network?: string | null; /** * [Output Only] The URL of the region where the instance group is located (for regional resources). */ - region?: string; + region?: string | null; /** * [Output Only] The URL for this instance group. The server generates this URL. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The total number of instances in the instance group. */ - size?: number; + size?: number | null; /** * [Output Only] The URL of the subnetwork to which all instances in the instance group belong. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output Only] The URL of the zone where the instance group is located (for zonal resources). */ - zone?: string; + zone?: string | null; } export interface Schema$InstanceGroupAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupsScopedList resources. */ - items?: {[key: string]: Schema$InstanceGroupsScopedList}; + items?: {[key: string]: Schema$InstanceGroupsScopedList} | null; /** * [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4030,7 +4034,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A list of InstanceGroup resources. @@ -4039,7 +4043,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroup resources. */ @@ -4047,15 +4051,15 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4063,7 +4067,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) @@ -4076,11 +4080,11 @@ export namespace compute_beta { /** * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. */ - baseInstanceName?: string; + baseInstanceName?: string | null; /** * [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. */ @@ -4088,7 +4092,7 @@ export namespace compute_beta { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Policy specifying intended distribution of instances in regional managed instance group. */ @@ -4096,31 +4100,31 @@ export namespace compute_beta { /** * The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. */ - failoverAction?: string; + failoverAction?: string | null; /** * Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] A unique identifier for this resource type. The server generates this identifier. */ - id?: string; + id?: string | null; /** * [Output Only] The URL of the Instance Group resource. */ - instanceGroup?: string; + instanceGroup?: string | null; /** * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ - instanceTemplate?: string; + instanceTemplate?: string | null; /** * [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. */ - kind?: string; + kind?: string | null; /** * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. */ - name?: string; + name?: string | null; /** * Named ports configured for the Instance Groups complementary to this Instance Group Manager. */ @@ -4132,15 +4136,15 @@ export namespace compute_beta { /** * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ - region?: string; + region?: string | null; /** * [Output Only] The URL for this managed instance group. The server defines this URL. */ - selfLink?: string; + selfLink?: string | null; /** * 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; + serviceAccount?: string | null; /** * [Output Only] The status of this managed instance group. */ @@ -4148,11 +4152,11 @@ export namespace compute_beta { /** * The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ - targetPools?: string[]; + targetPools?: string[] | null; /** * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. */ - targetSize?: number; + targetSize?: number | null; /** * The update policy for this managed instance group. */ @@ -4164,67 +4168,67 @@ export namespace compute_beta { /** * [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). */ - zone?: string; + zone?: string | null; } export interface Schema$InstanceGroupManagerActionsSummary { /** * [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. */ - abandoning?: number; + abandoning?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. */ - creating?: number; + creating?: number | null; /** * [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. */ - creatingWithoutRetries?: number; + creatingWithoutRetries?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. */ - deleting?: number; + deleting?: number | null; /** * [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. */ - none?: number; + none?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. */ - recreating?: number; + recreating?: number | null; /** * [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. */ - refreshing?: number; + refreshing?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. */ - restarting?: number; + restarting?: number | null; /** * [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. */ - verifying?: number; + verifying?: number | null; } export interface Schema$InstanceGroupManagerAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupManagersScopedList resources. */ - items?: {[key: string]: Schema$InstanceGroupManagersScopedList}; + items?: {[key: string]: Schema$InstanceGroupManagersScopedList} | null; /** * [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4232,17 +4236,17 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupManagerAutoHealingPolicy { /** * The URL for the health check that signals autohealing. */ - healthCheck?: string; + healthCheck?: string | null; /** * The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. */ - initialDelaySec?: number; + initialDelaySec?: number | null; } /** * [Output Only] A list of managed instance groups. @@ -4251,7 +4255,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupManager resources. */ @@ -4259,15 +4263,15 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4275,31 +4279,31 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupManagerPendingActionsSummary { /** * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created. */ - creating?: number; + creating?: number | null; /** * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted. */ - deleting?: number; + deleting?: number | null; /** * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated. */ - recreating?: number; + recreating?: number | null; /** * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted. */ - restarting?: number; + restarting?: number | null; } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** * 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]. */ - instances?: string[]; + instances?: string[] | null; } /** * InstanceGroupManagers.applyUpdatesToInstances @@ -4308,21 +4312,30 @@ export namespace compute_beta { /** * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ - instances?: string[]; + instances?: string[] | null; /** * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. */ - minimalAction?: string; + minimalAction?: string | null; /** * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. */ - mostDisruptiveAllowedAction?: string; + mostDisruptiveAllowedAction?: 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$InstanceGroupManagersListManagedInstancesResponse { /** @@ -4332,23 +4345,23 @@ export namespace compute_beta { /** * [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; + nextPageToken?: string | null; } 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$InstanceGroupManagersResizeAdvancedRequest { /** * If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds. This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario. This flag is applicable only to the current resize request. It does not influence other resize requests in any way. You can see which instances is being creating in which mode by calling the get or listManagedInstances API. */ - noCreationRetries?: boolean; + noCreationRetries?: boolean | null; /** * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. */ - targetSize?: number; + targetSize?: number | null; } export interface Schema$InstanceGroupManagersScopedList { /** @@ -4362,7 +4375,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupManagersSetAutoHealingRequest { autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; @@ -4371,23 +4384,23 @@ export namespace compute_beta { /** * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ - instanceTemplate?: string; + instanceTemplate?: string | null; } export interface Schema$InstanceGroupManagersSetTargetPoolsRequest { /** * The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings. */ - targetPools?: string[]; + targetPools?: string[] | null; } export interface Schema$InstanceGroupManagerStatus { /** * [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; + isStable?: boolean | null; /** * [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. */ @@ -4397,13 +4410,13 @@ export namespace compute_beta { /** * [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; + 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; + 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. */ @@ -4415,25 +4428,25 @@ export namespace compute_beta { /** * Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. */ - minimalAction?: string; + minimalAction?: string | null; /** * Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. */ - minReadySec?: number; + minReadySec?: number | 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). */ - type?: string; + type?: string | null; } export interface Schema$InstanceGroupManagerVersion { /** * The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. */ - instanceTemplate?: string; + instanceTemplate?: string | null; /** * Name of the version. Unique among all versions in the scope of this managed instance group. */ - name?: string; + name?: string | null; /** * Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. */ @@ -4449,7 +4462,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceWithNamedPorts resources. */ @@ -4457,15 +4470,15 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4473,13 +4486,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupsListInstancesRequest { /** * A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. */ - instanceState?: string; + instanceState?: string | null; } export interface Schema$InstanceGroupsRemoveInstancesRequest { /** @@ -4499,13 +4512,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of named ports to set for this instance group. */ @@ -4518,7 +4531,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Instance resources. */ @@ -4526,15 +4539,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4542,7 +4555,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of instance referrers. @@ -4551,7 +4564,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Reference resources. */ @@ -4559,15 +4572,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4575,27 +4588,27 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; 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 */ - destinationZone?: string; + destinationZone?: string | null; /** * The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ - targetInstance?: string; + targetInstance?: string | null; } export interface Schema$InstanceProperties { /** * Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. */ - canIpForward?: boolean; + canIpForward?: boolean | null; /** * An optional text description for the instances that are created from this instance template. */ - description?: string; + description?: string | null; /** * An array of disks that are associated with the instances that are created from this template. */ @@ -4611,11 +4624,11 @@ export namespace compute_beta { /** * Labels to apply to instances that are created from this template. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The machine type to use for instances that are created from this template. */ - machineType?: string; + machineType?: string | null; /** * The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. */ @@ -4623,7 +4636,7 @@ export namespace compute_beta { /** * 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 minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * An array of network access configurations for this interface. */ @@ -4654,7 +4667,7 @@ export namespace compute_beta { /** * The URL for a specific instance. */ - instance?: string; + instance?: string | null; } export interface Schema$InstancesResumeRequest { /** @@ -4678,14 +4691,14 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstancesSetLabelsRequest { /** * Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels. */ - labelFingerprint?: string; - labels?: {[key: string]: string}; + labelFingerprint?: string | null; + labels?: {[key: string]: string} | null; } export interface Schema$InstancesSetMachineResourcesRequest { /** @@ -4697,23 +4710,23 @@ export namespace compute_beta { /** * Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1 */ - machineType?: string; + machineType?: string | null; } export interface Schema$InstancesSetMinCpuPlatformRequest { /** * Minimum cpu/platform this instance should be started at. */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; } export interface Schema$InstancesSetServiceAccountRequest { /** * Email address of the service account. */ - email?: string; + email?: string | null; /** * The list of scopes to be made available for this service account. */ - scopes?: string[]; + scopes?: string[] | null; } export interface Schema$InstancesStartWithEncryptionKeyRequest { /** @@ -4728,23 +4741,23 @@ export namespace compute_beta { /** * [Output Only] The creation timestamp for this instance template in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] A unique identifier for this instance template. The server defines this identifier. */ - id?: string; + id?: string | null; /** * [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. */ - kind?: string; + kind?: string | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The instance properties for this instance template. */ @@ -4752,11 +4765,11 @@ export namespace compute_beta { /** * [Output Only] The URL for this instance template. The server defines this URL. */ - selfLink?: string; + selfLink?: string | null; /** * The source instance used to create the template. 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; + sourceInstance?: string | null; /** * The source instance params to use to create this instance template. */ @@ -4769,7 +4782,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceTemplate resources. */ @@ -4777,15 +4790,15 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4793,13 +4806,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceWithNamedPorts { /** * [Output Only] The URL of the instance. */ - instance?: string; + instance?: string | null; /** * [Output Only] The named ports that belong to this instance group. */ @@ -4807,7 +4820,7 @@ export namespace compute_beta { /** * [Output Only] The status of the instance. */ - status?: string; + status?: string | null; } /** * HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. @@ -4816,11 +4829,11 @@ export namespace compute_beta { /** * The end of the range (exclusive) in signed long integer format. */ - rangeEnd?: string; + rangeEnd?: string | null; /** * The start of the range (inclusive) in signed long integer format. */ - rangeStart?: string; + rangeStart?: string | null; } /** * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) @@ -4829,7 +4842,7 @@ export namespace compute_beta { /** * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. */ - adminEnabled?: boolean; + adminEnabled?: boolean | null; /** * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. */ @@ -4837,15 +4850,15 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. */ - customerName?: string; + customerName?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] A list of outages expected for this Interconnect. */ @@ -4853,75 +4866,75 @@ export namespace compute_beta { /** * [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. */ - googleIpAddress?: string; + googleIpAddress?: string | null; /** * [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ - googleReferenceId?: string; + googleReferenceId?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. */ - interconnectAttachments?: string[]; + interconnectAttachments?: string[] | null; /** * Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. */ - interconnectType?: string; + interconnectType?: string | null; /** * [Output Only] Type of the resource. Always compute#interconnect for interconnects. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. */ - linkType?: string; + linkType?: string | null; /** * URL of the InterconnectLocation object that represents where this connection is to be provisioned. */ - location?: string; + location?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. */ - nocContactEmail?: string; + nocContactEmail?: string | null; /** * [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ - operationalStatus?: string; + operationalStatus?: string | null; /** * [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. */ - peerIpAddress?: string; + peerIpAddress?: string | null; /** * [Output Only] Number of links actually provisioned in this interconnect. */ - provisionedLinkCount?: number; + provisionedLinkCount?: number | null; /** * Target number of physical links in the link bundle, as requested by the customer. */ - requestedLinkCount?: number; + requestedLinkCount?: number | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ - state?: string; + state?: string | null; } /** * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) @@ -4930,75 +4943,75 @@ export namespace compute_beta { /** * Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. */ - adminEnabled?: boolean; + adminEnabled?: boolean | null; /** * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s */ - bandwidth?: string; + bandwidth?: string | null; /** * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ - candidateSubnets?: string[]; + candidateSubnets?: string[] | null; /** * [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. */ - cloudRouterIpAddress?: string; + cloudRouterIpAddress?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. */ - customerRouterIpAddress?: string; + customerRouterIpAddress?: string | null; /** * An optional description of this resource. */ - description?: string; + description?: string | null; /** * Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ - edgeAvailabilityDomain?: string; + edgeAvailabilityDomain?: string | null; /** * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. */ - googleReferenceId?: string; + googleReferenceId?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * URL of the underlying Interconnect object that this attachment's traffic will traverse through. */ - interconnect?: string; + interconnect?: string | null; /** * [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. */ - operationalStatus?: string; + operationalStatus?: string | null; /** * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" */ - pairingKey?: string; + pairingKey?: string | null; /** * Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ - partnerAsn?: string; + partnerAsn?: string | null; /** * Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. */ @@ -5010,49 +5023,49 @@ export namespace compute_beta { /** * [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. */ - router?: string; + router?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. */ - state?: string; + state?: string | null; /** * The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. */ - type?: string; + type?: string | null; /** * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. */ - vlanTag8021q?: number; + vlanTag8021q?: number | null; } export interface Schema$InterconnectAttachmentAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InterconnectAttachmentsScopedList resources. */ - items?: {[key: string]: Schema$InterconnectAttachmentsScopedList}; + items?: {[key: string]: Schema$InterconnectAttachmentsScopedList} | null; /** * [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5060,7 +5073,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Response to the list request, and contains a list of interconnect attachments. @@ -5069,7 +5082,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InterconnectAttachment resources. */ @@ -5077,15 +5090,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5093,7 +5106,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. @@ -5102,15 +5115,15 @@ export namespace compute_beta { /** * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ - interconnectName?: string; + interconnectName?: string | null; /** * Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values. */ - partnerName?: string; + partnerName?: string | null; /** * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ - portalUrl?: string; + portalUrl?: string | null; } /** * Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. @@ -5119,7 +5132,7 @@ export namespace compute_beta { /** * [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region. */ - tag8021q?: number; + tag8021q?: number | null; } export interface Schema$InterconnectAttachmentsScopedList { /** @@ -5133,7 +5146,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 @@ -5142,15 +5155,15 @@ export namespace compute_beta { /** * Customer-side demarc ID for this circuit. */ - customerDemarcId?: string; + customerDemarcId?: string | null; /** * Google-assigned unique ID for this circuit. Assigned at circuit turn-up. */ - googleCircuitId?: string; + googleCircuitId?: string | null; /** * Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. */ - googleDemarcId?: string; + googleDemarcId?: string | null; } /** * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. @@ -5167,7 +5180,7 @@ export namespace compute_beta { /** * The MAC address of the Interconnect's bundle interface. */ - macAddress?: string; + macAddress?: string | null; } /** * Describing the ARP neighbor entries seen on this link @@ -5176,35 +5189,35 @@ export namespace compute_beta { /** * The IP address of this ARP neighbor. */ - ipAddress?: string; + ipAddress?: string | null; /** * The MAC address of this ARP neighbor. */ - macAddress?: string; + macAddress?: string | null; } export interface Schema$InterconnectDiagnosticsLinkLACPStatus { /** * System ID of the port on Google?s side of the LACP exchange. */ - googleSystemId?: string; + googleSystemId?: string | null; /** * System ID of the port on the neighbor?s side of the LACP exchange. */ - neighborSystemId?: string; + neighborSystemId?: string | null; /** * The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. */ - state?: string; + state?: string | null; } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { /** * The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. */ - state?: string; + state?: string | null; /** * Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. */ - value?: number; + value?: number | null; } export interface Schema$InterconnectDiagnosticsLinkStatus { /** @@ -5214,11 +5227,11 @@ export namespace compute_beta { /** * The unique ID for this link assigned during turn up by Google. */ - circuitId?: string; + circuitId?: string | null; /** * The Demarc address assigned by Google and provided in the LoA. */ - googleDemarc?: string; + googleDemarc?: string | null; lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; /** * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. @@ -5236,7 +5249,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Interconnect resources. */ @@ -5244,15 +5257,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5260,7 +5273,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. @@ -5269,51 +5282,51 @@ export namespace compute_beta { /** * [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. */ - address?: string; + address?: string | null; /** * [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". */ - availabilityZone?: string; + availabilityZone?: string | null; /** * [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". */ - city?: string; + city?: string | null; /** * [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA */ - continent?: string; + continent?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] An optional description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The name of the provider for this facility (e.g., EQUINIX). */ - facilityProvider?: string; + facilityProvider?: string | null; /** * [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). */ - facilityProviderFacilityId?: string; + facilityProviderFacilityId?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). */ - peeringdbFacilityId?: string; + peeringdbFacilityId?: string | null; /** * [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. */ @@ -5321,11 +5334,11 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. */ - status?: string; + status?: string | null; } /** * Response to the list request, and contains a list of interconnect locations. @@ -5334,7 +5347,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InterconnectLocation resources. */ @@ -5342,15 +5355,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5358,7 +5371,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. @@ -5367,15 +5380,15 @@ export namespace compute_beta { /** * Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. */ - expectedRttMs?: string; + expectedRttMs?: string | null; /** * Identifies the network presence of this location. */ - locationPresence?: string; + locationPresence?: string | null; /** * URL for the region of this location. */ - region?: string; + region?: string | null; } /** * Description of a planned outage on this Interconnect. Next id: 9 @@ -5384,35 +5397,35 @@ export namespace compute_beta { /** * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. */ - affectedCircuits?: string[]; + affectedCircuits?: string[] | null; /** * A description about the purpose of the outage. */ - description?: string; + description?: string | null; /** * Scheduled end time for the outage (milliseconds since Unix epoch). */ - endTime?: string; + endTime?: string | null; /** * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. */ - issueType?: string; + issueType?: string | null; /** * Unique identifier for this outage notification. */ - name?: string; + name?: string | null; /** * The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. */ - source?: string; + source?: string | null; /** * Scheduled start time for the outage (milliseconds since Unix epoch). */ - startTime?: string; + startTime?: string | null; /** * State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. */ - state?: string; + state?: string | null; } /** * Response for the InterconnectsGetDiagnosticsRequest. @@ -5427,58 +5440,58 @@ export namespace compute_beta { /** * [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. */ - chargesUseFee?: boolean; + chargesUseFee?: boolean | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#license for licenses. */ - kind?: string; + kind?: string | null; /** * [Output Only] The unique code used to attach this license to images, snapshots, and disks. */ - licenseCode?: string; + licenseCode?: string | null; /** * Name of the resource. The name must be 1-63 characters long and comply with RFC1035. */ - name?: string; + name?: string | null; resourceRequirements?: Schema$LicenseResourceRequirements; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. */ - transferable?: boolean; + transferable?: boolean | null; } export interface Schema$LicenseCode { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] Description of this License Code. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#licenseCode for licenses. */ - kind?: string; + kind?: string | null; /** * [Output Only] URL and description aliases of Licenses with the same License Code. */ @@ -5486,45 +5499,45 @@ export namespace compute_beta { /** * [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Current state of this License Code. */ - state?: string; + state?: string | null; /** * [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. */ - transferable?: boolean; + transferable?: boolean | null; } export interface Schema$LicenseCodeLicenseAlias { /** * [Output Only] Description of this License Code. */ - description?: string; + description?: string | null; /** * [Output Only] URL of license corresponding to this License Code. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$LicenseResourceRequirements { /** * Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. */ - minGuestCpuCount?: number; + minGuestCpuCount?: number | null; /** * Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. */ - minMemoryMb?: number; + minMemoryMb?: number | null; } export interface Schema$LicensesListResponse { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of License resources. */ @@ -5532,11 +5545,11 @@ export namespace compute_beta { /** * [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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5544,7 +5557,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Specifies what kind of log the caller must write @@ -5574,7 +5587,7 @@ export namespace compute_beta { /** * The log_name to populate in the Cloud Audit Record. */ - logName?: string; + logName?: string | null; } /** * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). @@ -5583,11 +5596,11 @@ export namespace compute_beta { /** * The field value to attribute. */ - field?: string; + field?: string | null; /** * The metric to update. */ - metric?: string; + metric?: string | null; } /** * Write a Data Access (Gin) log @@ -5596,7 +5609,7 @@ export namespace compute_beta { /** * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. */ - logMode?: string; + logMode?: string | null; } /** * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) @@ -5605,7 +5618,7 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this machine type. */ @@ -5613,69 +5626,69 @@ export namespace compute_beta { /** * [Output Only] An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The number of virtual CPUs that are available to the instance. */ - guestCpus?: number; + guestCpus?: number | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. */ - isSharedCpu?: boolean; + isSharedCpu?: boolean | null; /** * [Output Only] The type of the resource. Always compute#machineType for machine types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Maximum persistent disks allowed. */ - maximumPersistentDisks?: number; + maximumPersistentDisks?: number | null; /** * [Output Only] Maximum total persistent disks size (GB) allowed. */ - maximumPersistentDisksSizeGb?: string; + maximumPersistentDisksSizeGb?: string | null; /** * [Output Only] The amount of physical memory available to the instance, defined in MB. */ - memoryMb?: number; + memoryMb?: number | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The name of the zone where the machine type resides, such as us-central1-a. */ - zone?: string; + zone?: string | null; } export interface Schema$MachineTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of MachineTypesScopedList resources. */ - items?: {[key: string]: Schema$MachineTypesScopedList}; + items?: {[key: string]: Schema$MachineTypesScopedList} | null; /** * [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5683,7 +5696,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of machine types. @@ -5692,7 +5705,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of MachineType resources. */ @@ -5700,15 +5713,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5716,7 +5729,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$MachineTypesScopedList { /** @@ -5730,7 +5743,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A Managed Instance resource. @@ -5739,19 +5752,23 @@ export namespace compute_beta { /** * [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. */ - currentAction?: string; + currentAction?: string | null; /** * [Output only] The unique identifier for this resource. This field is empty when instance does not exist. */ - id?: string; + id?: string | null; /** * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ - instance?: string; + instance?: string | null; + /** + * [Output Only] Health state of the instance per health-check. + */ + instanceHealth?: Schema$ManagedInstanceInstanceHealth[]; /** * [Output Only] The status of the instance. This field is empty when the instance does not exist. */ - instanceStatus?: string; + instanceStatus?: string | null; /** * [Output Only] Information about the last attempt to create or delete the instance. */ @@ -5761,23 +5778,33 @@ export namespace compute_beta { */ version?: Schema$ManagedInstanceVersion; } + export interface Schema$ManagedInstanceInstanceHealth { + /** + * [Output Only] The current detailed instance health state. + */ + detailedHealthState?: string | null; + /** + * [Output Only] The URL for the health check that verifies whether the instance is healthy. + */ + healthCheck?: string | null; + } export interface Schema$ManagedInstanceLastAttempt { /** * [Output Only] Encountered errors during the last attempt to create or delete the instance. */ errors?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; } export interface Schema$ManagedInstanceVersion { /** * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. */ - instanceTemplate?: string; + instanceTemplate?: string | null; /** * [Output Only] Name of the version. */ - name?: string; + name?: string | null; } /** * A metadata key/value entry. @@ -5786,15 +5813,15 @@ export namespace compute_beta { /** * Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. */ - fingerprint?: string; + fingerprint?: string | null; /** * Array of key/value pairs. The total size of all keys and values must be less than 512 KB. */ - items?: Array<{key?: string; value?: string}>; + items?: Array<{key?: string; value?: string}> | null; /** * [Output Only] Type of the resource. Always compute#metadata for metadata. */ - kind?: string; + 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. @@ -5807,7 +5834,7 @@ export namespace compute_beta { /** * Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. */ - filterMatchCriteria?: string; + filterMatchCriteria?: string | null; } /** * MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. @@ -5816,11 +5843,11 @@ export namespace compute_beta { /** * Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. */ - name?: string; + name?: string | null; /** * The value of the label must match the specified value. value can have a maximum length of 1024 characters. */ - value?: string; + value?: string | null; } /** * The named port. For example: . @@ -5829,11 +5856,11 @@ export namespace compute_beta { /** * The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. */ - name?: string; + name?: string | null; /** * The port number, which can be a value between 1 and 65535. */ - port?: number; + port?: number | null; } /** * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) @@ -5842,35 +5869,35 @@ export namespace compute_beta { /** * When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. */ - autoCreateSubnetworks?: boolean; + autoCreateSubnetworks?: boolean | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The gateway address for default routing out of the network, selected by GCP. */ - gatewayIPv4?: string; + gatewayIPv4?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. */ - IPv4Range?: string; + IPv4Range?: string | null; /** * [Output Only] Type of the resource. Always compute#network for networks. */ - kind?: string; + 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?: string; + name?: string | null; /** * [Output Only] A list of network peerings for the resource. */ @@ -5882,11 +5909,11 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. */ - subnetworks?: string[]; + subnetworks?: string[] | null; } /** * The network endpoint. @@ -5895,15 +5922,15 @@ export namespace compute_beta { /** * The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035. */ - instance?: string; + instance?: string | null; /** * Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. */ - ipAddress?: string; + ipAddress?: string | null; /** * Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used. */ - port?: number; + port?: number | null; } /** * Represents a collection of network endpoints. @@ -5912,23 +5939,23 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * The default port used if the port number is not specified in the network endpoint. */ - defaultPort?: number; + defaultPort?: number | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. */ - kind?: string; + kind?: string | null; /** * This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated. */ @@ -5936,53 +5963,53 @@ export namespace compute_beta { /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. */ - network?: string; + network?: string | null; /** * Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT. */ - networkEndpointType?: string; + networkEndpointType?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] Number of network endpoints in the network endpoint group. */ - size?: number; + size?: number | null; /** * Optional URL of the subnetwork to which all network endpoints in the NEG belong. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output Only] The URL of the zone where the network endpoint group is located. */ - zone?: string; + zone?: string | null; } export interface Schema$NetworkEndpointGroupAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NetworkEndpointGroupsScopedList resources. */ - items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList}; + items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList} | null; /** * [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5990,7 +6017,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Load balancing specific fields for network endpoint group. @@ -5999,25 +6026,25 @@ export namespace compute_beta { /** * The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. */ - defaultPort?: number; + defaultPort?: number | null; /** * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated. */ - network?: string; + network?: string | null; /** * Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. */ - zone?: string; + zone?: string | null; } export interface Schema$NetworkEndpointGroupList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NetworkEndpointGroup resources. */ @@ -6025,15 +6052,15 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6041,7 +6068,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NetworkEndpointGroupsAttachEndpointsRequest { /** @@ -6059,13 +6086,13 @@ export namespace compute_beta { /** * Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided. */ - healthStatus?: string; + healthStatus?: string | null; } export interface Schema$NetworkEndpointGroupsListNetworkEndpoints { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NetworkEndpointWithHealthStatus resources. */ @@ -6073,11 +6100,11 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Informational warning message. */ @@ -6085,7 +6112,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NetworkEndpointGroupsScopedList { /** @@ -6099,7 +6126,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NetworkEndpointWithHealthStatus { /** @@ -6126,27 +6153,27 @@ 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; + fingerprint?: string | null; /** * [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. */ - kind?: string; + kind?: string | null; /** * [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. */ - name?: string; + name?: string | null; /** * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ - network?: string; + network?: string | null; /** * An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ - networkIP?: string; + networkIP?: string | null; /** * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ - subnetwork?: string; + subnetwork?: string | null; } /** * Contains a list of networks. @@ -6155,7 +6182,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Network resources. */ @@ -6163,15 +6190,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#networkList for lists of networks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6179,7 +6206,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. @@ -6188,35 +6215,35 @@ export namespace compute_beta { /** * This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ - autoCreateRoutes?: boolean; + autoCreateRoutes?: boolean | null; /** * Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ - exchangeSubnetRoutes?: boolean; + exchangeSubnetRoutes?: boolean | null; /** * Whether to export the custom routes to peer network. */ - exportCustomRoutes?: boolean; + exportCustomRoutes?: boolean | null; /** * Whether to import the custom routes from peer network. */ - importCustomRoutes?: boolean; + importCustomRoutes?: boolean | null; /** * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ - network?: string; + network?: string | null; /** * [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. */ - state?: string; + state?: string | null; /** * [Output Only] Details about the current state of the peering. */ - stateDetails?: string; + stateDetails?: string | null; } /** * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. @@ -6225,17 +6252,17 @@ export namespace compute_beta { /** * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. */ - routingMode?: string; + routingMode?: string | null; } export interface Schema$NetworksAddPeeringRequest { /** * This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ - autoCreateRoutes?: boolean; + autoCreateRoutes?: boolean | null; /** * Name of the peering, which should conform to RFC1035. */ - name?: string; + name?: string | null; /** * Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ @@ -6243,13 +6270,13 @@ export namespace compute_beta { /** * URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ - peerNetwork?: string; + peerNetwork?: string | null; } export interface Schema$NetworksRemovePeeringRequest { /** * Name of the peering, which should conform to RFC1035. */ - name?: string; + name?: string | null; } export interface Schema$NetworksUpdatePeeringRequest { networkPeering?: Schema$NetworkPeering; @@ -6261,62 +6288,62 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ - kind?: string; + kind?: 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. */ - name?: string; + name?: string | null; /** * The URL of the node template to which this node group belongs. */ - nodeTemplate?: string; + nodeTemplate?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The total number of nodes in the node group. */ - size?: number; - status?: string; + size?: number | null; + status?: string | null; /** * [Output Only] The name of the zone where the node group resides, such as us-central1-a. */ - zone?: string; + zone?: string | null; } export interface Schema$NodeGroupAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeGroupsScopedList resources. */ - items?: {[key: string]: Schema$NodeGroupsScopedList}; + items?: {[key: string]: Schema$NodeGroupsScopedList} | null; /** * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6324,7 +6351,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of nodeGroups. @@ -6333,7 +6360,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeGroup resources. */ @@ -6341,15 +6368,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6357,44 +6384,44 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeGroupNode { /** * Instances scheduled on this node. */ - instances?: string[]; + instances?: string[] | null; /** * The name of the node. */ - name?: string; + name?: string | null; /** * The type of this node. */ - nodeType?: string; + nodeType?: string | null; /** * Binding properties for the physical server. */ serverBinding?: Schema$ServerBinding; - status?: string; + status?: string | null; } export interface Schema$NodeGroupsAddNodesRequest { /** * Count of additional nodes to be added to the node group. */ - additionalNodeCount?: number; + additionalNodeCount?: number | null; } export interface Schema$NodeGroupsDeleteNodesRequest { /** * Names of the nodes to delete. */ - nodes?: string[]; + nodes?: string[] | null; } export interface Schema$NodeGroupsListNodes { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Node resources. */ @@ -6402,15 +6429,15 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6418,7 +6445,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeGroupsScopedList { /** @@ -6432,13 +6459,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** * Full or partial URL of the node template resource to be updated for this node group. */ - nodeTemplate?: string; + 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 ==) @@ -6447,31 +6474,31 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. */ - kind?: string; + kind?: 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. */ - name?: string; + name?: string | null; /** * Labels to use for node affinity, which will be used in instance scheduling. */ - nodeAffinityLabels?: {[key: string]: string}; + nodeAffinityLabels?: {[key: string]: string} | null; /** * The node type to use for nodes group that are created from this template. */ - nodeType?: string; + nodeType?: string | null; /** * The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. */ @@ -6479,11 +6506,11 @@ export namespace compute_beta { /** * [Output Only] The name of the region where the node template resides, such as us-central1. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. */ @@ -6491,33 +6518,33 @@ export namespace compute_beta { /** * [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. */ - status?: string; + status?: string | null; /** * [Output Only] An optional, human-readable explanation of the status. */ - statusMessage?: string; + statusMessage?: string | null; } export interface Schema$NodeTemplateAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeTemplatesScopedList resources. */ - items?: {[key: string]: Schema$NodeTemplatesScopedList}; + items?: {[key: string]: Schema$NodeTemplatesScopedList} | null; /** * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6525,7 +6552,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of node templates. @@ -6534,7 +6561,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeTemplate resources. */ @@ -6542,15 +6569,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6558,12 +6585,12 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeTemplateNodeTypeFlexibility { - cpus?: string; - localSsd?: string; - memory?: string; + cpus?: string | null; + localSsd?: string | null; + memory?: string | null; } export interface Schema$NodeTemplatesScopedList { /** @@ -6577,7 +6604,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) @@ -6586,11 +6613,11 @@ export namespace compute_beta { /** * [Output Only] The CPU platform used by this node type. */ - cpuPlatform?: string; + cpuPlatform?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this node type. */ @@ -6598,61 +6625,61 @@ export namespace compute_beta { /** * [Output Only] An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The number of virtual CPUs that are available to the node type. */ - guestCpus?: number; + guestCpus?: number | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#nodeType for node types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Local SSD available to the node type, defined in GB. */ - localSsdGb?: number; + localSsdGb?: number | null; /** * [Output Only] The amount of physical memory available to the node type, defined in MB. */ - memoryMb?: number; + memoryMb?: number | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The name of the zone where the node type resides, such as us-central1-a. */ - zone?: string; + zone?: string | null; } export interface Schema$NodeTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeTypesScopedList resources. */ - items?: {[key: string]: Schema$NodeTypesScopedList}; + items?: {[key: string]: Schema$NodeTypesScopedList} | null; /** * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6660,7 +6687,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of node types. @@ -6669,7 +6696,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeType resources. */ @@ -6677,15 +6704,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6693,7 +6720,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeTypesScopedList { /** @@ -6707,7 +6734,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) @@ -6716,89 +6743,89 @@ export namespace compute_beta { /** * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ - clientOperationId?: string; + clientOperationId?: string | null; /** * [Deprecated] This field is deprecated. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] A textual description of the operation, which is set when the operation is created. */ - description?: string; + description?: string | null; /** * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ - endTime?: string; + endTime?: string | null; /** * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ - httpErrorMessage?: string; + httpErrorMessage?: string | null; /** * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ - httpErrorStatusCode?: number; + httpErrorStatusCode?: number | null; /** * [Output Only] The unique identifier for the operation. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the operation. */ - name?: string; + name?: string | null; /** * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ - operationType?: string; + operationType?: string | null; /** * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ - progress?: number; + progress?: number | null; /** * [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ - status?: string; + status?: string | null; /** * [Output Only] An optional textual description of the current status of the operation. */ - statusMessage?: string; + statusMessage?: string | null; /** * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ - targetId?: string; + targetId?: string | null; /** * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ - targetLink?: string; + targetLink?: string | null; /** * [Output Only] User who requested the operation, for example: user@example.com. */ - user?: string; + user?: string | null; /** * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ @@ -6806,33 +6833,33 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; /** * [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. */ - zone?: string; + zone?: string | null; } export interface Schema$OperationAggregatedList { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A map of scoped operation lists. */ - items?: {[key: string]: Schema$OperationsScopedList}; + items?: {[key: string]: Schema$OperationsScopedList} | null; /** * [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6840,7 +6867,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Operation resources. @@ -6849,7 +6876,7 @@ export namespace compute_beta { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of Operation resources. */ @@ -6857,15 +6884,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#operations for Operations resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6873,7 +6900,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$OperationsScopedList { /** @@ -6887,7 +6914,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Settings controlling eviction of unhealthy hosts from the load balancing pool. @@ -6900,23 +6927,23 @@ export namespace compute_beta { /** * Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. */ - consecutiveErrors?: number; + consecutiveErrors?: number | null; /** * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5. */ - consecutiveGatewayFailure?: number; + consecutiveGatewayFailure?: number | null; /** * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. */ - enforcingConsecutiveErrors?: number; + enforcingConsecutiveErrors?: number | null; /** * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. */ - enforcingConsecutiveGatewayFailure?: number; + enforcingConsecutiveGatewayFailure?: number | null; /** * The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. */ - enforcingSuccessRate?: number; + enforcingSuccessRate?: number | null; /** * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. */ @@ -6924,19 +6951,19 @@ export namespace compute_beta { /** * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%. */ - maxEjectionPercent?: number; + maxEjectionPercent?: number | null; /** * The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. */ - successRateMinimumHosts?: number; + successRateMinimumHosts?: number | null; /** * The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. */ - successRateRequestVolume?: number; + successRateRequestVolume?: number | null; /** * This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. */ - successRateStdevFactor?: number; + successRateStdevFactor?: number | null; } /** * Next free: 7 @@ -6945,27 +6972,27 @@ export namespace compute_beta { /** * Average observed inter-packet interval in milliseconds. */ - avgMs?: string; + avgMs?: string | null; /** * From how long ago in the past these intervals were observed. */ - duration?: string; + duration?: string | null; /** * Maximum observed inter-packet interval in milliseconds. */ - maxMs?: string; + maxMs?: string | null; /** * Minimum observed inter-packet interval in milliseconds. */ - minMs?: string; + minMs?: string | null; /** * Number of inter-packet intervals from which these statistics were derived. */ - numIntervals?: string; + numIntervals?: string | null; /** * The type of packets for which inter-packet intervals were computed. */ - type?: string; + type?: string | null; } /** * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. @@ -6978,7 +7005,7 @@ export namespace compute_beta { /** * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use */ - defaultService?: string; + 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. */ @@ -6986,7 +7013,7 @@ export namespace compute_beta { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap */ @@ -6994,7 +7021,7 @@ export namespace compute_beta { /** * The name to which this PathMatcher is referred by the HostRule. */ - name?: string; + name?: string | null; /** * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. */ @@ -7011,7 +7038,7 @@ export namespace compute_beta { /** * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. */ - paths?: string[]; + paths?: string[] | null; /** * In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. */ @@ -7019,12 +7046,22 @@ export namespace compute_beta { /** * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ - service?: string; + service?: string | null; /** * When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. */ urlRedirect?: Schema$HttpRedirectAction; } + export interface Schema$PerInstanceConfig { + /** + * Fingerprint of this per-instance config. This field may be used in optimistic locking. It will be ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. + */ + fingerprint?: string | null; + /** + * The name of the per-instance config and the corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in a failure. + */ + name?: string | null; + } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ @@ -7040,8 +7077,8 @@ export namespace compute_beta { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; - iamOwned?: boolean; + etag?: string | null; + iamOwned?: boolean | null; /** * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ @@ -7049,7 +7086,7 @@ export namespace compute_beta { /** * Deprecated. */ - version?: number; + version?: number | null; } export interface Schema$PreconfiguredWafSet { /** @@ -7068,35 +7105,35 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. */ - defaultNetworkTier?: string; + defaultNetworkTier?: string | null; /** * [Output Only] Default service account used by VMs running in this project. */ - defaultServiceAccount?: string; + defaultServiceAccount?: string | null; /** * An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * Restricted features enabled for use on this project. */ - enabledFeatures?: string[]; + enabledFeatures?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#project for projects. */ - kind?: string; + kind?: string | null; /** * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. */ - name?: string; + name?: string | null; /** * [Output Only] Quotas assigned to this project. */ @@ -7104,7 +7141,7 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. */ @@ -7112,7 +7149,7 @@ export namespace compute_beta { /** * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. */ - xpnProjectStatus?: string; + xpnProjectStatus?: string | null; } export interface Schema$ProjectsDisableXpnResourceRequest { /** @@ -7130,11 +7167,11 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Service resources (a.k.a service projects) attached to this project as their shared VPC host. */ @@ -7144,13 +7181,13 @@ export namespace compute_beta { /** * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. */ - organization?: string; + organization?: string | null; } export interface Schema$ProjectsSetDefaultNetworkTierRequest { /** * Default network tier to be set. */ - networkTier?: string; + networkTier?: string | null; } /** * A quotas entry. @@ -7159,19 +7196,19 @@ export namespace compute_beta { /** * [Output Only] Quota limit for this metric. */ - limit?: number; + limit?: number | null; /** * [Output Only] Name of the quota metric. */ - metric?: string; + metric?: string | null; /** * [Output Only] Owning resource. This is the resource on which this quota is applied. */ - owner?: string; + owner?: string | null; /** * [Output Only] Current usage of this metric. */ - usage?: number; + usage?: number | null; } /** * Represents a reference to a resource. @@ -7180,19 +7217,19 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#reference for references. */ - kind?: string; + kind?: string | null; /** * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF */ - referenceType?: string; + referenceType?: string | null; /** * URL of the resource which refers to the target. */ - referrer?: string; + referrer?: string | null; /** * URL of the resource to which this reference points. */ - target?: string; + target?: string | null; } /** * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) @@ -7201,7 +7238,7 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this region. */ @@ -7209,19 +7246,19 @@ export namespace compute_beta { /** * [Output Only] Textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#region for regions. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Quotas assigned to this region. */ @@ -7229,15 +7266,15 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Status of the region, either UP or DOWN. */ - status?: string; + status?: string | null; /** * [Output Only] A list of zones available in this region, in the form of resource URLs. */ - zones?: string[]; + zones?: string[] | null; } /** * Contains a list of autoscalers. @@ -7246,7 +7283,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Autoscaler resources. */ @@ -7254,15 +7291,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7270,7 +7307,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RegionCommitmentsUpdateReservationsRequest { /** @@ -7282,25 +7319,25 @@ export namespace compute_beta { /** * Resource policies to be added to this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$RegionDisksRemoveResourcePoliciesRequest { /** * Resource policies to be removed from this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$RegionDisksResizeRequest { /** * The new size of the regional persistent disk, which is specified in GB. */ - sizeGb?: string; + sizeGb?: string | null; } export interface Schema$RegionDiskTypeList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DiskType resources. */ @@ -7308,15 +7345,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7324,7 +7361,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of InstanceGroup resources. @@ -7333,7 +7370,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroup resources. */ @@ -7341,15 +7378,15 @@ export namespace compute_beta { /** * The resource type. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7357,7 +7394,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of managed instance groups. @@ -7366,7 +7403,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupManager resources. */ @@ -7374,15 +7411,15 @@ export namespace compute_beta { /** * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7390,13 +7427,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } 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]. */ - instances?: string[]; + instances?: string[] | null; } /** * InstanceGroupManagers.applyUpdatesToInstances @@ -7405,21 +7442,30 @@ export namespace compute_beta { /** * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ - instances?: string[]; + instances?: string[] | null; /** * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. */ - minimalAction?: string; + minimalAction?: string | null; /** * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. */ - mostDisruptiveAllowedAction?: string; + mostDisruptiveAllowedAction?: 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$RegionInstanceGroupManagersListInstancesResponse { /** @@ -7429,13 +7475,13 @@ export namespace compute_beta { /** * [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; + nextPageToken?: string | null; } export interface Schema$RegionInstanceGroupManagersRecreateRequest { /** * 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$RegionInstanceGroupManagersSetAutoHealingRequest { autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; @@ -7444,23 +7490,23 @@ export namespace compute_beta { /** * Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional. */ - fingerprint?: string; + fingerprint?: string | null; /** * The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ - targetPools?: string[]; + targetPools?: string[] | null; } export interface Schema$RegionInstanceGroupManagersSetTemplateRequest { /** * URL of the InstanceTemplate resource from which all new instances will be created. */ - instanceTemplate?: string; + instanceTemplate?: string | null; } export interface Schema$RegionInstanceGroupsListInstances { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceWithNamedPorts resources. */ @@ -7468,15 +7514,15 @@ export namespace compute_beta { /** * The resource type. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7484,23 +7530,23 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. */ - instanceState?: string; + instanceState?: string | null; /** * Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. */ - portName?: string; + portName?: string | null; } export interface Schema$RegionInstanceGroupsSetNamedPortsRequest { /** * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of named ports to set for this instance group. */ @@ -7513,7 +7559,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Region resources. */ @@ -7521,15 +7567,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#regionList for lists of regions. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7537,17 +7583,17 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RegionSetLabelsRequest { /** * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * The labels to set for this resource. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } export interface Schema$RegionSetPolicyRequest { /** @@ -7557,7 +7603,7 @@ export namespace compute_beta { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -7567,7 +7613,7 @@ export namespace compute_beta { /** * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. */ - sslCertificates?: string[]; + sslCertificates?: string[] | null; } export interface Schema$RegionUrlMapsValidateRequest { /** @@ -7582,7 +7628,7 @@ export namespace compute_beta { /** * The full or partial URL to the BackendService resource being mirrored to. */ - backendService?: string; + backendService?: string | null; } /** * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) @@ -7591,31 +7637,31 @@ export namespace compute_beta { /** * [OutputOnly] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. */ - commitment?: string; + commitment?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#reservations for reservations. */ - kind?: string; + kind?: 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. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Reservation for instances with specific machine shapes. */ @@ -7623,15 +7669,15 @@ export namespace compute_beta { /** * Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. */ - specificReservationRequired?: boolean; + specificReservationRequired?: boolean | null; /** * [Output Only] The status of the reservation. */ - status?: string; + status?: string | null; /** * Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. */ - zone?: string; + zone?: string | null; } /** * Specifies the reservations that this instance can consume from. @@ -7640,15 +7686,15 @@ export namespace compute_beta { /** * Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. */ - consumeReservationType?: string; + consumeReservationType?: string | null; /** * Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */ - key?: string; + key?: string | null; /** * Corresponds to the label values of a reservation resource. */ - values?: string[]; + values?: string[] | null; } /** * Contains a list of reservations. @@ -7657,23 +7703,23 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Allocation resources. */ - items?: {[key: string]: Schema$ReservationsScopedList}; + items?: {[key: string]: Schema$ReservationsScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7681,13 +7727,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ReservationList { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of Allocation resources. */ @@ -7695,15 +7741,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource.Always compute#reservationsList for listsof reservations */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7711,13 +7757,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ReservationsResizeRequest { /** * Number of allocated resources can be resized with minimum = 1 and maximum = 1000. */ - specificSkuCount?: string; + specificSkuCount?: string | null; } export interface Schema$ReservationsScopedList { /** @@ -7731,7 +7777,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -7740,21 +7786,21 @@ export namespace compute_beta { /** * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. */ - acceleratorType?: string; + acceleratorType?: string | null; /** * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. */ - amount?: string; + amount?: string | null; /** * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY */ - type?: string; + type?: string | null; } export interface Schema$ResourceGroupReference { /** * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. */ - group?: string; + group?: string | null; } export interface Schema$ResourcePoliciesScopedList { /** @@ -7768,31 +7814,31 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ResourcePolicy { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; - description?: string; + creationTimestamp?: string | null; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#resource_policies for resource policies. */ - kind?: string; + kind?: 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. */ - name?: string; - region?: string; + name?: string | null; + region?: string | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Resource policy for persistent disks for creating snapshots. */ @@ -7800,33 +7846,33 @@ export namespace compute_beta { /** * [Output Only] The status of resource policy creation. */ - status?: string; + status?: string | null; } /** * Contains a list of resourcePolicies. */ export interface Schema$ResourcePolicyAggregatedList { - etag?: string; + etag?: string | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ResourcePolicy resources. */ - items?: {[key: string]: Schema$ResourcePoliciesScopedList}; + items?: {[key: string]: Schema$ResourcePoliciesScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7834,7 +7880,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Time window specified for daily operations. @@ -7843,15 +7889,15 @@ export namespace compute_beta { /** * Defines a schedule that runs every nth day of the month. */ - daysInCycle?: number; + daysInCycle?: number | null; /** * [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. */ - duration?: string; + duration?: string | null; /** * Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid. */ - startTime?: string; + startTime?: string | null; } /** * Time window specified for hourly operations. @@ -7860,22 +7906,22 @@ export namespace compute_beta { /** * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ - duration?: string; + duration?: string | null; /** * Allows to define schedule that runs every nth hour. */ - hoursInCycle?: number; + hoursInCycle?: number | null; /** * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ - startTime?: string; + startTime?: string | null; } export interface Schema$ResourcePolicyList { - etag?: string; + etag?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of ResourcePolicy resources. */ @@ -7883,15 +7929,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7899,7 +7945,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. @@ -7925,11 +7971,11 @@ export namespace compute_beta { /** * Maximum age of the snapshot that is allowed to be kept. */ - maxRetentionDays?: number; + maxRetentionDays?: number | null; /** * Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. */ - onSourceDiskDelete?: string; + onSourceDiskDelete?: string | null; } /** * A schedule for disks where the schedueled operations are performed. @@ -7946,15 +7992,15 @@ export namespace compute_beta { /** * Indication to perform a ?guest aware? snapshot. */ - guestFlush?: boolean; + guestFlush?: boolean | null; /** * Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). */ - storageLocations?: string[]; + storageLocations?: string[] | null; } /** * Time window specified for weekly operations. @@ -7969,15 +8015,15 @@ export namespace compute_beta { /** * Allows to define schedule that runs specified day of the week. */ - day?: string; + day?: string | null; /** * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ - duration?: string; + duration?: string | null; /** * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ - startTime?: string; + startTime?: string | null; } /** * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) @@ -7986,75 +8032,75 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * The destination range of outgoing packets that this route applies to. Only IPv4 is supported. */ - destRange?: string; + destRange?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of this resource. Always compute#routes for Route resources. */ - kind?: string; + 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?: string; + name?: string | null; /** * Fully-qualified URL of the network that this route applies to. */ - network?: string; + network?: string | null; /** * The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway */ - nextHopGateway?: string; + nextHopGateway?: string | null; /** * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Note that this can only be used when the destination_range is a public (non-RFC 1918) IP CIDR range. */ - nextHopIlb?: string; + nextHopIlb?: string | null; /** * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ - nextHopInstance?: string; + nextHopInstance?: string | null; /** * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. */ - nextHopInterconnectAttachment?: string; + nextHopInterconnectAttachment?: string | null; /** * The network IP address of an instance that should handle matching packets. Only IPv4 is supported. */ - nextHopIp?: string; + nextHopIp?: string | null; /** * The URL of the local network if it should handle matching packets. */ - nextHopNetwork?: string; + nextHopNetwork?: string | null; /** * [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. */ - nextHopPeering?: string; + nextHopPeering?: string | null; /** * The URL to a VpnTunnel that should handle matching packets. */ - nextHopVpnTunnel?: string; + nextHopVpnTunnel?: string | null; /** * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. */ - priority?: number; + priority?: number | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * A list of instance tags to which this route applies. */ - tags?: string[]; + tags?: string[] | null; /** * [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. */ @@ -8062,7 +8108,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * Contains a list of Route resources. @@ -8071,7 +8117,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Route resources. */ @@ -8079,15 +8125,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8095,7 +8141,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Cloud Router resource. For more information about Cloud Router, read the the Cloud Router overview. @@ -8112,15 +8158,15 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. */ @@ -8128,11 +8174,11 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#router for routers. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * A list of NAT services created in this router. */ @@ -8140,15 +8186,15 @@ export namespace compute_beta { /** * URI of the network to which this router belongs. */ - network?: string; + network?: string | null; /** * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * Description-tagged IP ranges for the router to advertise. @@ -8157,11 +8203,11 @@ export namespace compute_beta { /** * User-specified description for the IP range. */ - description?: string; + description?: string | null; /** * The IP range to advertise. The value must be a CIDR-formatted string. */ - range?: string; + range?: string | null; } /** * Contains a list of routers. @@ -8170,23 +8216,23 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Router resources. */ - items?: {[key: string]: Schema$RoutersScopedList}; + items?: {[key: string]: Schema$RoutersScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8194,13 +8240,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RouterBgp { /** * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ - advertisedGroups?: string[]; + advertisedGroups?: string[] | null; /** * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ @@ -8208,21 +8254,21 @@ export namespace compute_beta { /** * User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. */ - advertiseMode?: string; + advertiseMode?: string | null; /** * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN. */ - asn?: number; + asn?: number | null; /** * The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer?s hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 1 and 120. The default is 20. */ - keepaliveInterval?: number; + keepaliveInterval?: number | null; } export interface Schema$RouterBgpPeer { /** * User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ - advertisedGroups?: string[]; + advertisedGroups?: string[] | null; /** * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ @@ -8230,11 +8276,11 @@ export namespace compute_beta { /** * The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. */ - advertisedRoutePriority?: number; + advertisedRoutePriority?: number | null; /** * User-specified flag to indicate which mode to use for advertisement. */ - advertiseMode?: string; + advertiseMode?: string | null; /** * BFD configuration for the BGP peering. */ @@ -8242,71 +8288,71 @@ export namespace compute_beta { /** * The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. */ - enable?: string; + enable?: string | null; /** * Name of the interface the BGP peer is associated with. */ - interfaceName?: string; + interfaceName?: string | null; /** * IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. */ - ipAddress?: string; + ipAddress?: string | null; /** * [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ - managementType?: string; + managementType?: string | null; /** * Name of this BGP peer. 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; + name?: string | null; /** * Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. */ - peerAsn?: number; + peerAsn?: number | null; /** * IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. */ - peerIpAddress?: string; + peerIpAddress?: string | null; } export interface Schema$RouterBgpPeerBfd { /** * The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 100 and 30000. The default is 300. */ - minReceiveInterval?: number; + minReceiveInterval?: number | null; /** * The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 100 and 30000. The default is 300. */ - minTransmitInterval?: number; + minTransmitInterval?: number | null; /** * The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 2 and 16. The default is 3. */ - multiplier?: number; + multiplier?: number | null; /** * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. */ - sessionInitializationMode?: string; + sessionInitializationMode?: string | null; } export interface Schema$RouterInterface { /** * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ - ipRange?: string; + ipRange?: string | null; /** * URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be either be a VPN tunnel or an Interconnect attachment. */ - linkedInterconnectAttachment?: string; + linkedInterconnectAttachment?: string | null; /** * URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be either a VPN tunnel or an Interconnect attachment. */ - linkedVpnTunnel?: string; + linkedVpnTunnel?: string | null; /** * [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ - managementType?: string; + managementType?: string | null; /** * Name of this interface entry. 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; + name?: string | null; } /** * Contains a list of Router resources. @@ -8315,7 +8361,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Router resources. */ @@ -8323,15 +8369,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#router for routers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8339,7 +8385,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided. @@ -8348,11 +8394,11 @@ export namespace compute_beta { /** * A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only. */ - drainNatIps?: string[]; + drainNatIps?: string[] | null; /** * Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. */ - icmpIdleTimeoutSec?: number; + icmpIdleTimeoutSec?: number | null; /** * Configure logging on this NAT. */ @@ -8360,23 +8406,23 @@ export namespace compute_beta { /** * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM. */ - minPortsPerVm?: number; + minPortsPerVm?: number | null; /** * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. */ - name?: string; + name?: string | null; /** * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. */ - natIpAllocateOption?: string; + natIpAllocateOption?: string | null; /** * A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project. */ - natIps?: string[]; + natIps?: string[] | null; /** * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ - sourceSubnetworkIpRangesToNat?: string; + sourceSubnetworkIpRangesToNat?: string | null; /** * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. */ @@ -8384,15 +8430,15 @@ export namespace compute_beta { /** * Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. */ - tcpEstablishedIdleTimeoutSec?: number; + tcpEstablishedIdleTimeoutSec?: number | null; /** * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. */ - tcpTransitoryIdleTimeoutSec?: number; + tcpTransitoryIdleTimeoutSec?: number | null; /** * Timeout (in seconds) for UDP connections. Defaults to 30s if not set. */ - udpIdleTimeoutSec?: number; + udpIdleTimeoutSec?: number | null; } /** * Configuration of logging on a NAT. @@ -8401,11 +8447,11 @@ export namespace compute_beta { /** * Indicates whether or not to export logs. This is false by default. */ - enable?: boolean; + enable?: boolean | null; /** * Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. */ - filter?: string; + filter?: string | null; } /** * Defines the IP ranges that want to use NAT for a subnetwork. @@ -8414,15 +8460,15 @@ export namespace compute_beta { /** * URL for the subnetwork resource that will use NAT. */ - name?: string; + name?: string | null; /** * A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat. */ - secondaryIpRangeNames?: string[]; + secondaryIpRangeNames?: string[] | null; /** * Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ - sourceIpRangesToNat?: string[]; + sourceIpRangesToNat?: string[] | null; } export interface Schema$RoutersPreviewResponse { /** @@ -8442,7 +8488,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RouterStatus { /** @@ -8458,7 +8504,7 @@ export namespace compute_beta { /** * URI of the network to which this router belongs. */ - network?: string; + network?: string | null; } export interface Schema$RouterStatusBgpPeerStatus { /** @@ -8469,39 +8515,39 @@ export namespace compute_beta { /** * IP address of the local BGP interface. */ - ipAddress?: string; + ipAddress?: string | null; /** * URL of the VPN tunnel that this BGP peer controls. */ - linkedVpnTunnel?: string; + linkedVpnTunnel?: string | null; /** * Name of this BGP peer. Unique within the Routers resource. */ - name?: string; + name?: string | null; /** * Number of routes learned from the remote BGP Peer. */ - numLearnedRoutes?: number; + numLearnedRoutes?: number | null; /** * IP address of the remote BGP interface. */ - peerIpAddress?: string; + peerIpAddress?: string | null; /** * BGP state as specified in RFC1771. */ - state?: string; + state?: string | null; /** * Status of the BGP peer: {UP, DOWN} */ - status?: string; + status?: string | null; /** * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds */ - uptime?: string; + uptime?: string | null; /** * Time this session has been up, in seconds. Format: 145 */ - uptimeSeconds?: string; + uptimeSeconds?: string | null; } /** * Status of a NAT contained in this router. Next tag: 9 @@ -8510,41 +8556,41 @@ export namespace compute_beta { /** * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] */ - autoAllocatedNatIps?: string[]; + autoAllocatedNatIps?: string[] | null; /** * A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. */ - drainAutoAllocatedNatIps?: string[]; + drainAutoAllocatedNatIps?: string[] | null; /** * A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. */ - drainUserAllocatedNatIps?: string[]; + drainUserAllocatedNatIps?: string[] | null; /** * The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. */ - minExtraNatIpsNeeded?: number; + minExtraNatIpsNeeded?: number | null; /** * Unique name of this NAT. */ - name?: string; + name?: string | null; /** * Number of VM endpoints (i.e., Nics) that can use NAT. */ - numVmEndpointsWithNatMappings?: number; + numVmEndpointsWithNatMappings?: number | null; /** * A list of fully qualified URLs of reserved IP address resources. */ - userAllocatedNatIpResources?: string[]; + userAllocatedNatIpResources?: string[] | null; /** * A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133". */ - userAllocatedNatIps?: string[]; + userAllocatedNatIps?: string[] | null; } export interface Schema$RouterStatusResponse { /** * Type of resource. */ - kind?: string; + kind?: string | null; result?: Schema$RouterStatus; } /** @@ -8554,7 +8600,7 @@ export namespace compute_beta { /** * Required */ - action?: string; + action?: string | null; /** * Additional restrictions that must be met. All conditions must pass for the rule to match. */ @@ -8562,11 +8608,11 @@ export namespace compute_beta { /** * Human-readable description of the rule. */ - description?: string; + description?: string | null; /** * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ - ins?: string[]; + ins?: string[] | null; /** * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ @@ -8574,11 +8620,11 @@ export namespace compute_beta { /** * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ - notIns?: string[]; + notIns?: string[] | null; /** * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Sets the scheduling options for an Instance. NextID: 9 @@ -8587,7 +8633,7 @@ 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; + automaticRestart?: boolean | null; /** * A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. */ @@ -8595,11 +8641,11 @@ export namespace compute_beta { /** * Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. */ - onHostMaintenance?: string; + onHostMaintenance?: string | null; /** * Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. */ - preemptible?: boolean; + preemptible?: boolean | null; } /** * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. @@ -8608,15 +8654,15 @@ export namespace compute_beta { /** * Corresponds to the label key of Node resource. */ - key?: string; + key?: string | null; /** * Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. */ - operator?: string; + operator?: string | null; /** * Corresponds to the label values of Node resource. */ - values?: string[]; + values?: string[] | null; } export interface Schema$SecurityPoliciesListPreconfiguredExpressionSetsResponse { preconfiguredExpressionSets?: Schema$SecurityPoliciesWafConfig; @@ -8631,35 +8677,35 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output only] Type of the resource. Always compute#securityPolicyfor security policies */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this security policy resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. */ @@ -8667,13 +8713,13 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$SecurityPolicyList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SecurityPolicy resources. */ @@ -8681,11 +8727,11 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Informational warning message. */ @@ -8693,10 +8739,10 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$SecurityPolicyReference { - securityPolicy?: string; + securityPolicy?: string | null; } /** * Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). @@ -8705,15 +8751,15 @@ export namespace compute_beta { /** * The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. */ - action?: string; + action?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules */ - kind?: string; + kind?: string | null; /** * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. */ @@ -8721,11 +8767,11 @@ export namespace compute_beta { /** * If set to true, the specified action is not enforced. */ - preview?: boolean; + preview?: boolean | null; /** * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. */ - priority?: number; + priority?: number | null; } /** * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. @@ -8742,13 +8788,13 @@ export namespace compute_beta { /** * Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. */ - versionedExpr?: string; + versionedExpr?: string | null; } export interface Schema$SecurityPolicyRuleMatcherConfig { /** * CIDR IP address range. */ - srcIpRanges?: string[]; + srcIpRanges?: string[] | null; } /** * An instance's serial console output. @@ -8757,26 +8803,26 @@ export namespace compute_beta { /** * [Output Only] The contents of the console output. */ - contents?: string; + contents?: string | null; /** * [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. */ - kind?: string; + kind?: string | null; /** * [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter. */ - next?: string; + next?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched. */ - start?: string; + start?: string | null; } export interface Schema$ServerBinding { - type?: string; + type?: string | null; } /** * A service account. @@ -8785,11 +8831,11 @@ export namespace compute_beta { /** * Email address of the service account. */ - email?: string; + email?: string | null; /** * The list of scopes to be made available for this service account. */ - scopes?: string[]; + scopes?: string[] | null; } /** * A set of Shielded Instance options. @@ -8798,15 +8844,15 @@ export namespace compute_beta { /** * Defines whether the instance has integrity monitoring enabled. */ - enableIntegrityMonitoring?: boolean; + enableIntegrityMonitoring?: boolean | null; /** * Defines whether the instance has Secure Boot enabled. */ - enableSecureBoot?: boolean; + enableSecureBoot?: boolean | null; /** * Defines whether the instance has the vTPM enabled. */ - enableVtpm?: boolean; + enableVtpm?: boolean | null; } /** * A shielded Instance identity entry. @@ -8819,7 +8865,7 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. */ - kind?: string; + kind?: string | null; /** * An Attestation Key (AK) issued to the Shielded Instance's vTPM. */ @@ -8832,11 +8878,11 @@ export namespace compute_beta { /** * A PEM-encoded X.509 certificate. This field can be empty. */ - ekCert?: string; + ekCert?: string | null; /** * A PEM-encoded public key. */ - ekPub?: string; + ekPub?: string | null; } /** * The policy describes the baseline against which Instance boot integrity is measured. @@ -8845,7 +8891,7 @@ export namespace compute_beta { /** * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ - updateAutoLearnPolicy?: boolean; + updateAutoLearnPolicy?: boolean | null; } /** * A set of Shielded VM options. @@ -8854,15 +8900,15 @@ export namespace compute_beta { /** * Defines whether the instance has integrity monitoring enabled. */ - enableIntegrityMonitoring?: boolean; + enableIntegrityMonitoring?: boolean | null; /** * Defines whether the instance has Secure Boot enabled. */ - enableSecureBoot?: boolean; + enableSecureBoot?: boolean | null; /** * Defines whether the instance has the vTPM enabled. */ - enableVtpm?: boolean; + enableVtpm?: boolean | null; } /** * A shielded VM identity entry. @@ -8875,7 +8921,7 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry. */ - kind?: string; + kind?: string | null; /** * An Attestation Key (AK) issued to the Shielded VM's vTPM. */ @@ -8888,11 +8934,11 @@ export namespace compute_beta { /** * A PEM-encoded X.509 certificate. This field can be empty. */ - ekCert?: string; + ekCert?: string | null; /** * A PEM-encoded public key. */ - ekPub?: string; + ekPub?: string | null; } /** * The policy describes the baseline against which VM instance boot integrity is measured. @@ -8901,7 +8947,7 @@ export namespace compute_beta { /** * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ - updateAutoLearnPolicy?: boolean; + updateAutoLearnPolicy?: boolean | null; } /** * Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs @@ -8910,11 +8956,11 @@ export namespace compute_beta { /** * Name of the key. 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. */ - keyName?: string; + keyName?: string | null; /** * 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. */ - keyValue?: string; + keyValue?: string | null; } /** * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) @@ -8923,51 +8969,51 @@ export namespace compute_beta { /** * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. */ - autoCreated?: boolean; + autoCreated?: boolean | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] Size of the snapshot, specified in GB. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Output Only] Integer license codes indicating which licenses are attached to this snapshot. */ - licenseCodes?: string[]; + licenseCodes?: string[] | null; /** * [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). */ - licenses?: string[]; + licenses?: string[] | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ @@ -8975,7 +9021,7 @@ export namespace compute_beta { /** * [Output Only] The source disk used to create this snapshot. */ - sourceDisk?: string; + sourceDisk?: string | null; /** * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ @@ -8983,23 +9029,23 @@ export namespace compute_beta { /** * [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. */ - sourceDiskId?: string; + sourceDiskId?: string | null; /** * [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. */ - status?: string; + status?: string | null; /** * [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. */ - storageBytes?: string; + 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; + storageBytesStatus?: string | null; /** * Cloud Storage bucket storage location of the snapshot (regional or multi-regional). */ - storageLocations?: string[]; + storageLocations?: string[] | null; } /** * Contains a list of Snapshot resources. @@ -9008,7 +9054,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Snapshot resources. */ @@ -9016,15 +9062,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9032,7 +9078,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A specification of the parameters to use when creating the instance template from a source instance. @@ -9050,27 +9096,27 @@ export namespace compute_beta { /** * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ - certificate?: string; + certificate?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] Expire time of the certificate. RFC3339 */ - expireTime?: string; + expireTime?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. */ - kind?: string; + kind?: string | null; /** * Configuration and status of a managed SSL certificate. */ @@ -9078,19 +9124,19 @@ export namespace compute_beta { /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * A write-only private key in PEM format. Only insert requests will include this field. */ - privateKey?: string; + privateKey?: string | null; /** * [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. */ - region?: string; + region?: string | null; /** * [Output only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Configuration and status of a self-managed SSL certificate. */ @@ -9098,33 +9144,33 @@ export namespace compute_beta { /** * [Output Only] Domains associated with the certificate via Subject Alternative Name. */ - subjectAlternativeNames?: string[]; + subjectAlternativeNames?: string[] | null; /** * (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. */ - type?: string; + type?: string | null; } export interface Schema$SslCertificateAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SslCertificatesScopedList resources. */ - items?: {[key: string]: Schema$SslCertificatesScopedList}; + items?: {[key: string]: Schema$SslCertificatesScopedList} | null; /** * [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9132,7 +9178,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of SslCertificate resources. @@ -9141,7 +9187,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SslCertificate resources. */ @@ -9149,15 +9195,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9165,7 +9211,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Configuration and status of a managed SSL certificate. @@ -9174,15 +9220,15 @@ export namespace compute_beta { /** * The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported. */ - domains?: string[]; + domains?: string[] | null; /** * [Output only] Detailed statuses of the domains specified for managed certificate resource. */ - domainStatus?: {[key: string]: string}; + domainStatus?: {[key: string]: string} | null; /** * [Output only] Status of the managed certificate resource. */ - status?: string; + status?: string | null; } /** * Configuration and status of a self-managed SSL certificate. @@ -9191,11 +9237,11 @@ export namespace compute_beta { /** * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ - certificate?: string; + certificate?: string | null; /** * A write-only private key in PEM format. Only insert requests will include this field. */ - privateKey?: string; + privateKey?: string | null; } export interface Schema$SslCertificatesScopedList { /** @@ -9209,39 +9255,39 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$SSLHealthCheck { /** * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ - request?: string; + request?: string | null; /** * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } export interface Schema$SslPoliciesList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SslPolicy resources. */ @@ -9249,15 +9295,15 @@ export namespace compute_beta { /** * [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9265,10 +9311,10 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$SslPoliciesListAvailableFeaturesResponse { - features?: string[]; + features?: string[] | null; } /** * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) @@ -9277,47 +9323,47 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * A list of features enabled when the selected profile is CUSTOM. The - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. */ - customFeatures?: string[]; + customFeatures?: string[] | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The list of features enabled in the SSL policy. */ - enabledFeatures?: string[]; + enabledFeatures?: string[] | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. */ - kind?: string; + kind?: string | null; /** * The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. */ - minTlsVersion?: string; + minTlsVersion?: string | null; /** * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. */ - profile?: string; + profile?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. */ @@ -9325,13 +9371,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } export interface Schema$SslPolicyReference { /** * URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. */ - sslPolicy?: string; + sslPolicy?: string | null; } /** * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) @@ -9340,39 +9386,39 @@ export namespace compute_beta { /** * Whether this subnetwork can conflict with static routes. Setting this to true allows this subnetwork's primary and secondary ranges to conflict with routes that have already been configured on the corresponding network. Static routes will take precedence over the subnetwork route if the route prefix length is at least as large as the subnetwork prefix length. Also, packets destined to IPs within subnetwork may contain private/sensitive data and are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks. This field cannot be set to true at resource creation time. */ - allowSubnetCidrRoutesOverlap?: boolean; + allowSubnetCidrRoutesOverlap?: boolean | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. */ - description?: string; + description?: string | null; /** * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ - enableFlowLogs?: boolean; + enableFlowLogs?: boolean | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. */ - gatewayAddress?: string; + gatewayAddress?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * 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; + ipCidrRange?: string | null; /** * [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. */ - kind?: string; + kind?: string | null; /** * This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver. */ @@ -9380,27 +9426,27 @@ export namespace compute_beta { /** * The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. */ - network?: string; + network?: string | null; /** * 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; + privateIpGoogleAccess?: boolean | 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. */ - purpose?: string; + purpose?: string | null; /** * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. */ - region?: string; + region?: string | null; /** * The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. */ - role?: string; + role?: string | null; /** * An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. */ @@ -9408,33 +9454,33 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY. */ - state?: string; + state?: string | null; } export interface Schema$SubnetworkAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SubnetworksScopedList resources. */ - items?: {[key: string]: Schema$SubnetworksScopedList}; + items?: {[key: string]: Schema$SubnetworksScopedList} | null; /** * [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9442,7 +9488,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Subnetwork resources. @@ -9451,7 +9497,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Subnetwork resources. */ @@ -9459,15 +9505,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9475,7 +9521,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * The available logging options for this subnetwork. @@ -9484,19 +9530,19 @@ export namespace compute_beta { /** * Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. */ - aggregationInterval?: string; + aggregationInterval?: string | null; /** * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ - enable?: boolean; + enable?: boolean | null; /** * Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5, which means half of all collected logs are reported. */ - flowSampling?: number; + flowSampling?: number | null; /** * Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. */ - metadata?: string; + metadata?: string | null; } /** * Represents a secondary IP range of a subnetwork. @@ -9505,17 +9551,17 @@ export namespace compute_beta { /** * The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ - rangeName?: string; + rangeName?: string | null; } export interface Schema$SubnetworksExpandIpCidrRangeRequest { /** * The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. */ - ipCidrRange?: string; + ipCidrRange?: string | null; } export interface Schema$SubnetworksScopedList { /** @@ -9529,10 +9575,10 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { - privateIpGoogleAccess?: boolean; + privateIpGoogleAccess?: boolean | null; } /** * A set of instance tags. @@ -9541,11 +9587,11 @@ export namespace compute_beta { /** * Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. */ - fingerprint?: string; + fingerprint?: string | null; /** * An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. */ - items?: string[]; + items?: string[] | null; } export interface Schema$TargetHttpProxiesScopedList { /** @@ -9559,7 +9605,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | 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 ==) @@ -9568,57 +9614,57 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL to the UrlMap resource that defines the mapping from URL to the BackendService. */ - urlMap?: string; + urlMap?: string | null; } export interface Schema$TargetHttpProxyAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetHttpProxiesScopedList resources. */ - items?: {[key: string]: Schema$TargetHttpProxiesScopedList}; + items?: {[key: string]: Schema$TargetHttpProxiesScopedList} | null; /** * [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9626,7 +9672,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A list of TargetHttpProxy resources. @@ -9635,7 +9681,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetHttpProxy resources. */ @@ -9643,15 +9689,15 @@ export namespace compute_beta { /** * Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9659,7 +9705,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetHttpsProxiesScopedList { /** @@ -9673,19 +9719,19 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { /** * QUIC policy for the TargetHttpsProxy resource. */ - quicOverride?: string; + quicOverride?: string | null; } export interface Schema$TargetHttpsProxiesSetSslCertificatesRequest { /** * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. */ - sslCertificates?: string[]; + 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 ==) @@ -9694,69 +9740,69 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. */ - quicOverride?: string; + quicOverride?: string | null; /** * [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ - sslCertificates?: string[]; + sslCertificates?: string[] | null; /** * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. */ - sslPolicy?: string; + sslPolicy?: string | null; /** * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map */ - urlMap?: string; + urlMap?: string | null; } export interface Schema$TargetHttpsProxyAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetHttpsProxiesScopedList resources. */ - items?: {[key: string]: Schema$TargetHttpsProxiesScopedList}; + items?: {[key: string]: Schema$TargetHttpsProxiesScopedList} | null; /** * [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9764,7 +9810,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of TargetHttpsProxy resources. @@ -9773,7 +9819,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetHttpsProxy resources. */ @@ -9781,15 +9827,15 @@ export namespace compute_beta { /** * Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9797,7 +9843,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) @@ -9806,61 +9852,61 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ - instance?: string; + instance?: string | null; /** * [Output Only] The type of the resource. Always compute#targetInstance for target instances. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. */ - natPolicy?: string; + natPolicy?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$TargetInstanceAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetInstance resources. */ - items?: {[key: string]: Schema$TargetInstancesScopedList}; + items?: {[key: string]: Schema$TargetInstancesScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9868,7 +9914,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of TargetInstance resources. @@ -9877,7 +9923,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetInstance resources. */ @@ -9885,15 +9931,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9901,7 +9947,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetInstancesScopedList { /** @@ -9915,7 +9961,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) @@ -9924,73 +9970,73 @@ export namespace compute_beta { /** * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ - backupPool?: string; + backupPool?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ - failoverRatio?: number; + failoverRatio?: number | null; /** * The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. */ - healthChecks?: string[]; + healthChecks?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. */ - instances?: string[]; + instances?: string[] | null; /** * [Output Only] Type of the resource. Always compute#targetPool for target pools. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] URL of the region where the target pool resides. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. */ - sessionAffinity?: string; + sessionAffinity?: string | null; } export interface Schema$TargetPoolAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetPool resources. */ - items?: {[key: string]: Schema$TargetPoolsScopedList}; + items?: {[key: string]: Schema$TargetPoolsScopedList} | null; /** * [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9998,14 +10044,14 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; /** * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. */ - kind?: string; + kind?: string | null; } /** * Contains a list of TargetPool resources. @@ -10014,7 +10060,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetPool resources. */ @@ -10022,15 +10068,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10038,7 +10084,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetPoolsAddHealthCheckRequest { /** @@ -10076,28 +10122,28 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetReference { - target?: string; + target?: string | null; } export interface Schema$TargetSslProxiesSetBackendServiceRequest { /** * The URL of the new BackendService resource for the targetSslProxy. */ - service?: string; + service?: string | null; } export interface Schema$TargetSslProxiesSetProxyHeaderRequest { /** * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ - proxyHeader?: string; + proxyHeader?: string | null; } export interface Schema$TargetSslProxiesSetSslCertificatesRequest { /** * New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. */ - sslCertificates?: string[]; + sslCertificates?: string[] | null; } /** * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) @@ -10106,43 +10152,43 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL to the BackendService resource. */ - service?: string; + service?: string | null; /** * URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ - sslCertificates?: string[]; + sslCertificates?: string[] | null; /** * URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. */ - sslPolicy?: string; + sslPolicy?: string | null; } /** * Contains a list of TargetSslProxy resources. @@ -10151,7 +10197,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetSslProxy resources. */ @@ -10159,15 +10205,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10175,56 +10221,56 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetTcpProxiesSetBackendServiceRequest { /** * The URL of the new BackendService resource for the targetTcpProxy. */ - service?: string; + service?: string | null; } export interface Schema$TargetTcpProxiesSetProxyHeaderRequest { /** * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ - proxyHeader?: string; + proxyHeader?: string | null; } /** - * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference ta target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL to the BackendService resource. */ - service?: string; + service?: string | null; } /** * Contains a list of TargetTcpProxy resources. @@ -10233,7 +10279,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetTcpProxy resources. */ @@ -10241,15 +10287,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10257,7 +10303,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) @@ -10266,77 +10312,77 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. */ - forwardingRules?: string[]; + forwardingRules?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this TargetVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ - network?: string; + network?: string | null; /** * [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. */ - status?: string; + status?: string | null; /** * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. */ - tunnels?: string[]; + tunnels?: string[] | null; } export interface Schema$TargetVpnGatewayAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetVpnGateway resources. */ - items?: {[key: string]: Schema$TargetVpnGatewaysScopedList}; + items?: {[key: string]: Schema$TargetVpnGatewaysScopedList} | null; /** * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10344,7 +10390,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of TargetVpnGateway resources. @@ -10353,7 +10399,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetVpnGateway resources. */ @@ -10361,15 +10407,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10377,7 +10423,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetVpnGatewaysScopedList { /** @@ -10391,51 +10437,51 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TCPHealthCheck { /** * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ - request?: string; + request?: string | null; /** * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } export interface Schema$TestFailure { - actualService?: string; - expectedService?: string; - host?: string; - path?: string; + actualService?: string | null; + expectedService?: string | null; + host?: string | null; + path?: string | null; } export interface Schema$TestPermissionsRequest { /** * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export interface Schema$TestPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. @@ -10444,7 +10490,7 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. */ @@ -10452,7 +10498,7 @@ export namespace compute_beta { /** * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. */ - defaultService?: string; + defaultService?: string | null; /** * When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. */ @@ -10460,11 +10506,11 @@ export namespace compute_beta { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. */ - fingerprint?: string; + fingerprint?: string | null; /** * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. */ @@ -10476,15 +10522,15 @@ export namespace compute_beta { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#urlMaps for url maps. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The list of named PathMatchers to use against the URL. */ @@ -10492,11 +10538,11 @@ export namespace compute_beta { /** * [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. */ @@ -10509,7 +10555,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of UrlMap resources. */ @@ -10517,15 +10563,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10533,32 +10579,32 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$UrlMapReference { - urlMap?: string; + urlMap?: string | null; } export interface Schema$UrlMapsAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of UrlMapsScopedList resources. */ - items?: {[key: string]: Schema$UrlMapsScopedList}; + items?: {[key: string]: Schema$UrlMapsScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10566,7 +10612,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$UrlMapsScopedList { /** @@ -10580,7 +10626,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$UrlMapsValidateRequest { /** @@ -10598,34 +10644,34 @@ export namespace compute_beta { /** * Description of this test case. */ - description?: string; + description?: string | null; /** * Host portion of the URL. */ - host?: string; + host?: string | null; /** * Path portion of the URL. */ - path?: string; + path?: string | null; /** * Expected BackendService resource the given URL should be mapped to. */ - service?: string; + service?: string | null; } /** * Message representing the validation result for a UrlMap. */ export interface Schema$UrlMapValidationResult { - loadErrors?: string[]; + loadErrors?: string[] | null; /** * Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons. */ - loadSucceeded?: boolean; + loadSucceeded?: boolean | null; testFailures?: Schema$TestFailure[]; /** * If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure. */ - testPassed?: boolean; + testPassed?: boolean | null; } /** * The spec for modifying the path before sending the request to the matched backend service. @@ -10634,11 +10680,11 @@ export namespace compute_beta { /** * Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters. */ - hostRewrite?: string; + hostRewrite?: string | null; /** * Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters. */ - pathPrefixRewrite?: string; + pathPrefixRewrite?: string | null; } /** * Subnetwork which the current user has compute.subnetworks.use permission on. @@ -10647,11 +10693,11 @@ export namespace compute_beta { /** * The range of internal addresses that are owned by this subnetwork. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Network URL. */ - network?: string; + network?: string | null; /** * Secondary IP ranges. */ @@ -10659,13 +10705,13 @@ export namespace compute_beta { /** * Subnetwork URL. */ - subnetwork?: string; + subnetwork?: string | null; } export interface Schema$UsableSubnetworksAggregatedList { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output] A list of usable subnetwork URLs. */ @@ -10673,15 +10719,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10689,7 +10735,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Secondary IP range of a usable subnetwork. @@ -10698,11 +10744,11 @@ export namespace compute_beta { /** * The range of IP addresses belonging to this subnetwork secondary range. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ - rangeName?: string; + rangeName?: string | null; } /** * The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. @@ -10711,11 +10757,11 @@ export namespace compute_beta { /** * The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. */ - bucketName?: string; + bucketName?: string | null; /** * An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. */ - reportNamePrefix?: string; + reportNamePrefix?: string | null; } /** * Contain information of Nat mapping for a VM endpoint (i.e., NIC). @@ -10724,7 +10770,7 @@ export namespace compute_beta { /** * Name of the VM instance which the endpoint belongs to */ - instanceName?: string; + instanceName?: string | null; interfaceNatMappings?: Schema$VmEndpointNatMappingsInterfaceNatMappings[]; } /** @@ -10734,27 +10780,27 @@ export namespace compute_beta { /** * List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ - drainNatIpPortRanges?: string[]; + drainNatIpPortRanges?: string[] | null; /** * A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ - natIpPortRanges?: string[]; + natIpPortRanges?: string[] | null; /** * Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges. */ - numTotalDrainNatPorts?: number; + numTotalDrainNatPorts?: number | null; /** * Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. */ - numTotalNatPorts?: number; + numTotalNatPorts?: number | null; /** * Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". */ - sourceAliasIpRange?: string; + sourceAliasIpRange?: string | null; /** * Primary IP of the VM for this NIC. */ - sourceVirtualIp?: string; + sourceVirtualIp?: string | null; } /** * Contains a list of VmEndpointNatMappings. @@ -10763,15 +10809,15 @@ export namespace compute_beta { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] A list of Nat mapping information of VM endpoints. */ @@ -10779,7 +10825,7 @@ export namespace compute_beta { /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10787,7 +10833,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a VPN gateway resource. @@ -10796,43 +10842,43 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an VpnGateway. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ - network?: string; + network?: string | null; /** * [Output Only] URL of the region where the VPN gateway resides. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] A list of interfaces on this VPN gateway. */ @@ -10842,23 +10888,23 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnGateway resources. */ - items?: {[key: string]: Schema$VpnGatewaysScopedList}; + items?: {[key: string]: Schema$VpnGatewaysScopedList} | null; /** * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10866,7 +10912,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of VpnGateway resources. @@ -10875,7 +10921,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnGateway resources. */ @@ -10883,15 +10929,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -10899,7 +10945,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$VpnGatewaysGetStatusResponse { result?: Schema$VpnGatewayStatus; @@ -10916,7 +10962,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$VpnGatewayStatus { /** @@ -10931,11 +10977,11 @@ export namespace compute_beta { /** * Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. */ - state?: string; + state?: string | null; /** * Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. */ - unsatisfiedReason?: string; + unsatisfiedReason?: string | null; } /** * Contains some information about a VPN tunnel. @@ -10944,15 +10990,15 @@ export namespace compute_beta { /** * The VPN gateway interface this VPN tunnel is associated with. */ - localGatewayInterface?: number; + localGatewayInterface?: number | null; /** * The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway. */ - peerGatewayInterface?: number; + peerGatewayInterface?: number | null; /** * URL reference to the VPN tunnel. */ - tunnelUrl?: string; + tunnelUrl?: string | null; } /** * A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway. @@ -10961,11 +11007,11 @@ export namespace compute_beta { /** * URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ - peerExternalGateway?: string; + peerExternalGateway?: string | null; /** * URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ - peerGcpGateway?: string; + peerGcpGateway?: string | null; /** * HighAvailabilityRequirementState for the VPN connection. */ @@ -10982,11 +11028,11 @@ export namespace compute_beta { /** * The numeric ID of this VPN gateway interface. */ - id?: number; + id?: number | null; /** * The external IP address for this VPN gateway interface. */ - ipAddress?: string; + ipAddress?: string | null; } /** * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) @@ -10995,121 +11041,121 @@ export namespace compute_beta { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] Detailed status message for the VPN tunnel. */ - detailedStatus?: string; + detailedStatus?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. */ - ikeVersion?: number; + ikeVersion?: number | null; /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. */ - localTrafficSelector?: string[]; + localTrafficSelector?: string[] | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. */ - peerExternalGateway?: string; + peerExternalGateway?: string | null; /** * The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. */ - peerExternalGatewayInterface?: number; + peerExternalGatewayInterface?: number | null; /** * URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. */ - peerGcpGateway?: string; + peerGcpGateway?: string | null; /** * IP address of the peer VPN gateway. Only IPv4 is supported. */ - peerIp?: string; + peerIp?: string | null; /** * [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. */ - remoteTrafficSelector?: string[]; + remoteTrafficSelector?: string[] | null; /** * URL of the router resource to be used for dynamic routing. */ - router?: string; + router?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. */ - sharedSecret?: string; + sharedSecret?: string | null; /** * Hash of the shared secret. */ - sharedSecretHash?: string; + sharedSecretHash?: string | null; /** * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. */ - status?: string; + status?: string | null; /** * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. */ - targetVpnGateway?: string; + targetVpnGateway?: string | null; /** * URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. */ - vpnGateway?: string; + vpnGateway?: string | null; /** * The interface ID of the VPN gateway with which this VPN tunnel is associated. */ - vpnGatewayInterface?: number; + vpnGatewayInterface?: number | null; } export interface Schema$VpnTunnelAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnTunnelsScopedList resources. */ - items?: {[key: string]: Schema$VpnTunnelsScopedList}; + items?: {[key: string]: Schema$VpnTunnelsScopedList} | null; /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -11117,7 +11163,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of VpnTunnel resources. @@ -11126,7 +11172,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnTunnel resources. */ @@ -11134,15 +11180,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -11150,7 +11196,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$VpnTunnelsScopedList { /** @@ -11164,13 +11210,13 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$WafExpressionSet { /** * A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set. */ - aliases?: string[]; + aliases?: string[] | null; /** * List of available expressions. */ @@ -11178,13 +11224,13 @@ export namespace compute_beta { /** * Google specified expression set ID. The format should be: - E.g. XSS-20170329 */ - id?: string; + id?: string | null; } export interface Schema$WafExpressionSetExpression { /** * Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. */ - id?: string; + id?: string | null; } /** * In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService @@ -11193,7 +11239,7 @@ export namespace compute_beta { /** * The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight. */ - backendService?: string; + backendService?: string | null; /** * Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. */ @@ -11201,13 +11247,13 @@ export namespace compute_beta { /** * Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000 */ - weight?: number; + weight?: number | null; } export interface Schema$XpnHostList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of shared VPC host project URLs. */ @@ -11215,15 +11261,15 @@ export namespace compute_beta { /** * [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -11231,7 +11277,7 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Service resource (a.k.a service project) ID. @@ -11240,11 +11286,11 @@ export namespace compute_beta { /** * The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). */ - id?: string; + id?: string | null; /** * The type of the service resource. */ - type?: string; + type?: string | null; } /** * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) @@ -11253,11 +11299,11 @@ export namespace compute_beta { /** * [Output Only] Available cpu/platform selections for the zone. */ - availableCpuPlatforms?: string[]; + availableCpuPlatforms?: string[] | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this zone. */ @@ -11265,31 +11311,31 @@ export namespace compute_beta { /** * [Output Only] Textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#zone for zones. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Full URL reference to the region which hosts the zone. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Status of the zone, either UP or DOWN. */ - status?: string; + status?: string | null; } /** * Contains a list of zone resources. @@ -11298,7 +11344,7 @@ export namespace compute_beta { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Zone resources. */ @@ -11306,15 +11352,15 @@ export namespace compute_beta { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -11322,17 +11368,17 @@ export namespace compute_beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ZoneSetLabelsRequest { /** * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * The labels to set for this resource. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } export interface Schema$ZoneSetPolicyRequest { /** @@ -11342,7 +11388,7 @@ export namespace compute_beta { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -30736,6 +30782,84 @@ 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. + * @alias compute.instanceGroupManagers.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.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.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createInstances( + params?: Params$Resource$Instancegroupmanagers$Createinstances, + options?: MethodOptions + ): GaxiosPromise; + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, + callback: BodyResponseCallback + ): void; + createInstances(callback: BodyResponseCallback): void; + createInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Createinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Createinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$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/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances' + ).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.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. @@ -32928,6 +33052,35 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersApplyUpdatesRequest; } + 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 { /** @@ -58538,6 +58691,84 @@ 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. + * @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.resource Request body data + * @param {object} [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/beta/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. @@ -60569,6 +60800,35 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; } + 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 { /** diff --git a/src/apis/compute/index.ts b/src/apis/compute/index.ts index 996574b5326..8b3fb18daf2 100644 --- a/src/apis/compute/index.ts +++ b/src/apis/compute/index.ts @@ -14,21 +14,33 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {compute_alpha} from './alpha'; import {compute_beta} from './beta'; import {compute_v1} from './v1'; export const VERSIONS = { + alpha: compute_alpha.Compute, beta: compute_beta.Compute, v1: compute_v1.Compute, }; +export function compute(version: 'alpha'): compute_alpha.Compute; +export function compute(options: compute_alpha.Options): compute_alpha.Compute; export function compute(version: 'beta'): compute_beta.Compute; export function compute(options: compute_beta.Options): compute_beta.Compute; export function compute(version: 'v1'): compute_v1.Compute; export function compute(options: compute_v1.Options): compute_v1.Compute; -export function compute( +export function compute< + T = compute_alpha.Compute | compute_beta.Compute | compute_v1.Compute +>( this: GoogleConfigurable, - versionOrOptions: 'beta' | compute_beta.Options | 'v1' | compute_v1.Options + versionOrOptions: + | 'alpha' + | compute_alpha.Options + | 'beta' + | compute_beta.Options + | 'v1' + | compute_v1.Options ) { return getAPI('compute', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 8c218599eb4..01a215dd0bc 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -127,10 +127,15 @@ export namespace compute_v1 { regionCommitments: Resource$Regioncommitments; regionDisks: Resource$Regiondisks; regionDiskTypes: Resource$Regiondisktypes; + regionHealthChecks: Resource$Regionhealthchecks; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; regionOperations: Resource$Regionoperations; regions: Resource$Regions; + regionSslCertificates: Resource$Regionsslcertificates; + regionTargetHttpProxies: Resource$Regiontargethttpproxies; + regionTargetHttpsProxies: Resource$Regiontargethttpsproxies; + regionUrlMaps: Resource$Regionurlmaps; reservations: Resource$Reservations; resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; @@ -209,6 +214,7 @@ export namespace compute_v1 { this.regionCommitments = new Resource$Regioncommitments(this.context); this.regionDisks = new Resource$Regiondisks(this.context); this.regionDiskTypes = new Resource$Regiondisktypes(this.context); + this.regionHealthChecks = new Resource$Regionhealthchecks(this.context); this.regionInstanceGroupManagers = new Resource$Regioninstancegroupmanagers( this.context ); @@ -217,6 +223,16 @@ export namespace compute_v1 { ); this.regionOperations = new Resource$Regionoperations(this.context); this.regions = new Resource$Regions(this.context); + this.regionSslCertificates = new Resource$Regionsslcertificates( + this.context + ); + this.regionTargetHttpProxies = new Resource$Regiontargethttpproxies( + this.context + ); + this.regionTargetHttpsProxies = new Resource$Regiontargethttpsproxies( + this.context + ); + this.regionUrlMaps = new Resource$Regionurlmaps(this.context); this.reservations = new Resource$Reservations(this.context); this.resourcePolicies = new Resource$Resourcepolicies(this.context); this.routers = new Resource$Routers(this.context); @@ -248,11 +264,11 @@ export namespace compute_v1 { /** * The number of the guest accelerator cards exposed to this instance. */ - acceleratorCount?: number; + acceleratorCount?: number | null; /** * Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. */ - acceleratorType?: string; + acceleratorType?: string | null; } /** * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) @@ -261,7 +277,7 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this accelerator type. */ @@ -269,53 +285,53 @@ export namespace compute_v1 { /** * [Output Only] An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Maximum accelerator cards allowed per instance. */ - maximumCardsPerInstance?: number; + maximumCardsPerInstance?: number | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$AcceleratorTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AcceleratorTypesScopedList resources. */ - items?: {[key: string]: Schema$AcceleratorTypesScopedList}; + items?: {[key: string]: Schema$AcceleratorTypesScopedList} | null; /** * [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -323,7 +339,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of accelerator types. @@ -332,7 +348,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AcceleratorType resources. */ @@ -340,15 +356,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -356,7 +372,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AcceleratorTypesScopedList { /** @@ -370,7 +386,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * An access configuration attached to an instance's network interface. Only one access config per instance is supported. @@ -379,31 +395,31 @@ export namespace compute_v1 { /** * [Output Only] Type of the resource. Always compute#accessConfig for access configs. */ - kind?: string; + kind?: string | null; /** * The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. */ - name?: string; + name?: string | null; /** * An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. */ - natIP?: string; + natIP?: string | null; /** * This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. */ - networkTier?: string; + networkTier?: string | null; /** * The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. */ - publicPtrDomainName?: string; + publicPtrDomainName?: string | null; /** * Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. */ - setPublicPtr?: boolean; + setPublicPtr?: boolean | null; /** * The type of configuration. The default and only option is ONE_TO_ONE_NAT. */ - type?: string; + type?: string | null; } /** * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) @@ -412,93 +428,93 @@ export namespace compute_v1 { /** * The static IP address represented by this resource. */ - address?: string; + address?: string | null; /** * The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. */ - addressType?: string; + addressType?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ - ipVersion?: string; + ipVersion?: string | null; /** * [Output Only] Type of the resource. Always compute#address for addresses. */ - kind?: string; + 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?: string; + name?: string | null; /** * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. */ - network?: string; + network?: string | null; /** * This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ - networkTier?: string; + networkTier?: string | null; /** * The prefix length if the resource reprensents an IP range. */ - prefixLength?: number; + prefixLength?: number | null; /** * The purpose of this resource, which can be one of the following values: - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. - `DNS_RESOLVER` for a DNS resolver address in a subnetwork - `VPC_PEERING` for addresses that are reserved for VPC peer networks. - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. */ - purpose?: string; + purpose?: string | null; /** * [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. */ - status?: string; + status?: string | null; /** * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output Only] The URLs of the resources that are using this address. */ - users?: string[]; + users?: string[] | null; } export interface Schema$AddressAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AddressesScopedList resources. */ - items?: {[key: string]: Schema$AddressesScopedList}; + items?: {[key: string]: Schema$AddressesScopedList} | null; /** * [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -506,7 +522,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AddressesScopedList { /** @@ -520,7 +536,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of addresses. @@ -529,7 +545,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Address resources. */ @@ -537,15 +553,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#addressList for lists of addresses. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -553,7 +569,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * An alias IP range attached to an instance's network interface. @@ -562,21 +578,21 @@ export namespace compute_v1 { /** * The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. */ - subnetworkRangeName?: string; + subnetworkRangeName?: string | null; } export interface Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk { /** * Specifies the size of the disk in base-2 GB. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ - interface?: string; + interface?: string | null; } /** * Properties of the SKU instances being reserved. @@ -593,11 +609,11 @@ export namespace compute_v1 { /** * Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. */ - machineType?: string; + machineType?: string | null; /** * Minimum cpu platform the reservation. */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; } /** * This reservation type allows to pre allocate specific instance configuration. @@ -606,7 +622,7 @@ export namespace compute_v1 { /** * Specifies the number of resources that are allocated. */ - count?: string; + count?: string | null; /** * The instance properties for the reservation. */ @@ -614,7 +630,7 @@ export namespace compute_v1 { /** * [OutputOnly] Indicates how many instances are in use. */ - inUseCount?: string; + inUseCount?: string | null; } /** * An instance-attached disk resource. @@ -623,15 +639,15 @@ export namespace compute_v1 { /** * 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; + 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; + boot?: boolean | null; /** * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. */ - deviceName?: string; + deviceName?: string | null; /** * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ @@ -643,7 +659,7 @@ export namespace compute_v1 { /** * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. */ - index?: number; + index?: number | null; /** * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ @@ -651,27 +667,27 @@ export namespace compute_v1 { /** * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported. */ - interface?: string; + interface?: string | null; /** * [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. */ - kind?: string; + kind?: string | null; /** * [Output Only] Any valid publicly visible licenses. */ - licenses?: string[]; + licenses?: 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; + mode?: string | null; /** - * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. */ - source?: string; + source?: string | null; /** * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. */ - type?: string; + type?: string | null; } /** * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. @@ -680,39 +696,39 @@ export namespace compute_v1 { /** * An optional description. Provide this property when creating the disk. */ - description?: string; + description?: string | null; /** * Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. */ - diskName?: string; + 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. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. */ - diskType?: string; + diskType?: string | null; /** * Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; /** - * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. */ - sourceImage?: string; + sourceImage?: string | null; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. + * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. */ - sourceSnapshot?: string; + sourceSnapshot?: string | null; /** * The customer-supplied encryption key of the source snapshot. */ @@ -726,11 +742,11 @@ export namespace compute_v1 { * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ - service?: string; + 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. @@ -739,15 +755,15 @@ export namespace compute_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. */ - ignoreChildExemptions?: boolean; + ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Authorization-related information used by Cloud Audit Logging. @@ -756,7 +772,7 @@ export namespace compute_v1 { /** * The type of the permission that was checked. */ - permissionType?: string; + permissionType?: string | null; } /** * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) @@ -769,35 +785,35 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of the autoscaler configuration. */ - status?: string; + status?: string | null; /** * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. */ @@ -805,33 +821,33 @@ export namespace compute_v1 { /** * URL of the managed instance group that this autoscaler will scale. */ - target?: string; + target?: string | null; /** * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). */ - zone?: string; + zone?: string | null; } export interface Schema$AutoscalerAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of AutoscalersScopedList resources. */ - items?: {[key: string]: Schema$AutoscalersScopedList}; + items?: {[key: string]: Schema$AutoscalersScopedList} | null; /** * [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -839,7 +855,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Autoscaler resources. @@ -848,7 +864,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Autoscaler resources. */ @@ -856,15 +872,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -872,7 +888,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AutoscalersScopedList { /** @@ -886,17 +902,17 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$AutoscalerStatusDetails { /** * The status message. */ - message?: string; + message?: string | null; /** * The type of error returned. */ - type?: string; + type?: string | null; } /** * Cloud Autoscaler policy. @@ -905,7 +921,7 @@ export namespace compute_v1 { /** * The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. */ - coolDownPeriodSec?: number; + coolDownPeriodSec?: number | null; /** * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. */ @@ -921,11 +937,11 @@ export namespace compute_v1 { /** * The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. */ - maxNumReplicas?: number; + maxNumReplicas?: number | null; /** * 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; + minNumReplicas?: number | null; } /** * CPU utilization policy. @@ -934,7 +950,7 @@ export namespace compute_v1 { /** * The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. */ - utilizationTarget?: number; + utilizationTarget?: number | null; } /** * Custom utilization metric policy. @@ -943,15 +959,15 @@ export namespace compute_v1 { /** * The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. */ - metric?: string; + metric?: string | null; /** * The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances. */ - utilizationTarget?: number; + utilizationTarget?: number | null; /** * Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. */ - utilizationTargetType?: string; + utilizationTargetType?: string | null; } /** * Configuration parameters of autoscaling based on load balancing. @@ -960,7 +976,7 @@ export namespace compute_v1 { /** * Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. */ - utilizationTarget?: number; + utilizationTarget?: number | null; } /** * Message containing information of one individual backend. @@ -969,47 +985,47 @@ export namespace compute_v1 { /** * Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol. */ - balancingMode?: string; + balancingMode?: string | null; /** * A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing. */ - capacityScaler?: number; + capacityScaler?: number | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. */ - group?: string; + group?: string | null; /** * Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION. */ - maxConnections?: number; + maxConnections?: number | null; /** * Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION. */ - maxConnectionsPerEndpoint?: number; + maxConnectionsPerEndpoint?: number | null; /** * Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION. */ - maxConnectionsPerInstance?: number; + maxConnectionsPerInstance?: number | null; /** * The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ - maxRate?: number; + maxRate?: number | null; /** * Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION. */ - maxRatePerEndpoint?: number; + maxRatePerEndpoint?: number | null; /** * Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION. */ - maxRatePerInstance?: number; + maxRatePerInstance?: number | null; /** * Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance. */ - maxUtilization?: number; + maxUtilization?: number | null; } /** * Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. @@ -1018,7 +1034,7 @@ export namespace compute_v1 { /** * Cloud Storage bucket name. */ - bucketName?: string; + bucketName?: string | null; /** * Cloud CDN configuration for this BackendBucket. */ @@ -1026,31 +1042,31 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; + description?: string | null; /** * If true, enable Cloud CDN for this BackendBucket. */ - enableCdn?: boolean; + enableCdn?: boolean | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * Type of the resource. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * Message containing Cloud CDN configuration for a backend bucket. @@ -1059,11 +1075,11 @@ export namespace compute_v1 { /** * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ - signedUrlCacheMaxAgeSec?: string; + signedUrlCacheMaxAgeSec?: string | null; /** * [Output Only] Names of the keys for signing request URLs. */ - signedUrlKeyNames?: string[]; + signedUrlKeyNames?: string[] | null; } /** * Contains a list of BackendBucket resources. @@ -1072,7 +1088,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of BackendBucket resources. */ @@ -1080,15 +1096,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1096,7 +1112,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) @@ -1105,7 +1121,7 @@ export namespace compute_v1 { /** * If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400). */ - affinityCookieTtlSec?: number; + affinityCookieTtlSec?: number | null; /** * The list of backends that serve this BackendService. */ @@ -1118,76 +1134,76 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * Headers that the HTTP/S load balancer should add to proxied requests. */ - customRequestHeaders?: string[]; + customRequestHeaders?: string[] | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS. */ - enableCDN?: boolean; + enableCDN?: boolean | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ - healthChecks?: string[]; + healthChecks?: string[] | null; iap?: Schema$BackendServiceIAP; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#backendService for backend services. */ - kind?: string; + kind?: string | null; /** * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. */ - loadBalancingScheme?: string; + loadBalancingScheme?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). */ - port?: number; + port?: number | null; /** * A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing). */ - portName?: string; + portName?: string | null; /** * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. */ - protocol?: string; + protocol?: string | null; /** * [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] The resource URL for the security policy associated with this backend service. */ - securityPolicy?: string; + securityPolicy?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + 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. */ - sessionAffinity?: string; + sessionAffinity?: string | null; /** * The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds. */ - timeoutSec?: number; + timeoutSec?: number | null; } /** * Contains a list of BackendServicesScopedList. @@ -1196,23 +1212,23 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of BackendServicesScopedList resources. */ - items?: {[key: string]: Schema$BackendServicesScopedList}; + items?: {[key: string]: Schema$BackendServicesScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1220,7 +1236,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Message containing Cloud CDN configuration for a backend service. @@ -1233,11 +1249,11 @@ export namespace compute_v1 { /** * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ - signedUrlCacheMaxAgeSec?: string; + signedUrlCacheMaxAgeSec?: string | null; /** * [Output Only] Names of the keys for signing request URLs. */ - signedUrlKeyNames?: string[]; + signedUrlKeyNames?: string[] | null; } export interface Schema$BackendServiceGroupHealth { /** @@ -1247,19 +1263,19 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. */ - kind?: string; + kind?: string | null; } /** * Identity-Aware Proxy */ export interface Schema$BackendServiceIAP { - enabled?: boolean; - oauth2ClientId?: string; - oauth2ClientSecret?: string; + enabled?: boolean | null; + oauth2ClientId?: string | null; + oauth2ClientSecret?: string | null; /** * [Output Only] SHA256 hash value for the field oauth2_client_secret above. */ - oauth2ClientSecretSha256?: string; + oauth2ClientSecretSha256?: string | null; } /** * Contains a list of BackendService resources. @@ -1268,7 +1284,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of BackendService resources. */ @@ -1276,15 +1292,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1292,10 +1308,10 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$BackendServiceReference { - backendService?: string; + backendService?: string | null; } export interface Schema$BackendServicesScopedList { /** @@ -1309,7 +1325,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Associates `members` with a `role`. @@ -1322,18 +1338,18 @@ export namespace compute_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } export interface Schema$CacheInvalidationRule { /** * If set, this invalidation rule will only apply to requests with a Host header matching host. */ - host?: string; - path?: string; + host?: string | null; + path?: string | null; } /** * Message containing what to include in the cache key for a request for Cloud CDN. @@ -1342,23 +1358,23 @@ export namespace compute_v1 { /** * If true, requests to different hosts will be cached separately. */ - includeHost?: boolean; + includeHost?: boolean | null; /** * If true, http and https requests will be cached separately. */ - includeProtocol?: boolean; + includeProtocol?: boolean | null; /** * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. */ - includeQueryString?: boolean; + includeQueryString?: boolean | null; /** * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ - queryStringBlacklist?: string[]; + queryStringBlacklist?: string[] | null; /** * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ - queryStringWhitelist?: string[]; + queryStringWhitelist?: string[] | null; } /** * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) @@ -1367,35 +1383,35 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] Commitment end time in RFC3339 text format. */ - endTimestamp?: string; + endTimestamp?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#commitment for commitments. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ - plan?: string; + plan?: string | null; /** * [Output Only] URL of the region where this commitment may be used. */ - region?: string; + region?: string | null; /** * List of reservations in this commitment. */ @@ -1407,41 +1423,41 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Commitment start time in RFC3339 text format. */ - startTimestamp?: string; + startTimestamp?: string | null; /** * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. */ - status?: string; + status?: string | null; /** * [Output Only] An optional, human-readable explanation of the status. */ - statusMessage?: string; + statusMessage?: string | null; } export interface Schema$CommitmentAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of CommitmentsScopedList resources. */ - items?: {[key: string]: Schema$CommitmentsScopedList}; + items?: {[key: string]: Schema$CommitmentsScopedList} | null; /** * [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1449,7 +1465,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Commitment resources. @@ -1458,7 +1474,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Commitment resources. */ @@ -1466,15 +1482,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1482,7 +1498,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$CommitmentsScopedList { /** @@ -1496,7 +1512,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A condition to be met. @@ -1505,23 +1521,23 @@ export namespace compute_v1 { /** * Trusted attributes supplied by the IAM system. */ - iam?: string; + iam?: string | null; /** * An operator to apply the subject with. */ - op?: string; + op?: string | null; /** * Trusted attributes discharged by the service. */ - svc?: string; + svc?: string | null; /** * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ - sys?: string; + sys?: string | null; /** * The objects of the condition. */ - values?: string[]; + values?: string[] | null; } /** * Message containing connection draining configuration. @@ -1530,7 +1546,7 @@ export namespace compute_v1 { /** * The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]. */ - drainingTimeoutSec?: number; + drainingTimeoutSec?: number | null; } /** * Represents a customer-supplied encryption key @@ -1539,15 +1555,15 @@ export namespace compute_v1 { /** * The name of the encryption key that is stored in Google Cloud KMS. */ - kmsKeyName?: string; + kmsKeyName?: string | null; /** * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. */ - rawKey?: string; + rawKey?: string | null; /** * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. */ - sha256?: string; + sha256?: string | null; } export interface Schema$CustomerEncryptionKeyProtectedDisk { /** @@ -1557,7 +1573,7 @@ export namespace compute_v1 { /** * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. */ - source?: string; + source?: string | null; } /** * Deprecation status for a public resource. @@ -1566,23 +1582,23 @@ export namespace compute_v1 { /** * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. */ - deleted?: string; + deleted?: string | null; /** * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. */ - deprecated?: string; + deprecated?: string | null; /** * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. */ - obsolete?: string; + obsolete?: string | null; /** * The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. */ - replacement?: string; + replacement?: string | null; /** * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. */ - state?: string; + state?: string | null; } /** * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) @@ -1591,11 +1607,11 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * 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. */ @@ -1607,71 +1623,71 @@ export namespace compute_v1 { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#disk for disks. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this disk. These can be later modified by the setLabels method. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Output Only] Last attach timestamp in RFC3339 text format. */ - lastAttachTimestamp?: string; + lastAttachTimestamp?: string | null; /** * [Output Only] Last detach timestamp in RFC3339 text format. */ - lastDetachTimestamp?: string; + lastDetachTimestamp?: string | null; /** * Integer license codes indicating which licenses are attached to this disk. */ - licenseCodes?: string[]; + licenseCodes?: string[] | null; /** * A list of publicly visible licenses. Reserved for Google's use. */ - licenses?: string[]; + licenses?: string[] | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Internal use only. */ - options?: string; + options?: string | null; /** * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. */ - physicalBlockSizeBytes?: string; + physicalBlockSizeBytes?: string | null; /** * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ - replicaZones?: string[]; + replicaZones?: string[] | null; /** * Resource policies applied to this disk for automatic snapshot creations. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. */ - sizeGb?: string; + sizeGb?: string | null; /** * The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family */ - sourceImage?: string; + sourceImage?: string | null; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ @@ -1679,11 +1695,11 @@ export namespace compute_v1 { /** * [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. */ - sourceImageId?: string; + sourceImageId?: string | null; /** * The source snapshot used to create this disk. 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/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot */ - sourceSnapshot?: string; + sourceSnapshot?: string | null; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ @@ -1691,45 +1707,45 @@ export namespace compute_v1 { /** * [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; + sourceSnapshotId?: 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. */ - status?: string; + status?: string | null; /** * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ - type?: string; + type?: string | null; /** * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance */ - users?: string[]; + users?: string[] | null; /** * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$DiskAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DisksScopedList resources. */ - items?: {[key: string]: Schema$DisksScopedList}; + items?: {[key: string]: Schema$DisksScopedList} | null; /** * [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1737,7 +1753,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. @@ -1746,19 +1762,19 @@ export namespace compute_v1 { /** * 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; + autoDelete?: boolean | null; /** * The custom source image to be used to restore this disk when instantiating this instance template. */ - customImage?: string; + customImage?: string | null; /** * Specifies the device name of the disk to which the configurations apply to. */ - deviceName?: string; + deviceName?: string | null; /** * Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. */ - instantiateFrom?: string; + instantiateFrom?: string | null; } /** * A list of Disk resources. @@ -1767,7 +1783,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Disk resources. */ @@ -1775,15 +1791,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#diskList for lists of disks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1791,35 +1807,35 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$DiskMoveRequest { /** * The URL of the destination zone to move the disk. 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 */ - destinationZone?: string; + destinationZone?: string | null; /** * The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ - targetDisk?: string; + targetDisk?: string | null; } export interface Schema$DisksAddResourcePoliciesRequest { /** * Resource policies to be added to this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$DisksRemoveResourcePoliciesRequest { /** * Resource policies to be removed from this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$DisksResizeRequest { /** * The new size of the persistent disk, which is specified in GB. */ - sizeGb?: string; + sizeGb?: string | null; } export interface Schema$DisksScopedList { /** @@ -1833,7 +1849,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) @@ -1842,11 +1858,11 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] Server-defined default disk size in GB. */ - defaultDiskSizeGb?: string; + defaultDiskSizeGb?: string | null; /** * [Output Only] The deprecation status associated with this disk type. */ @@ -1854,57 +1870,57 @@ export namespace compute_v1 { /** * [Output Only] An optional description of this resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#diskType for disk types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". */ - validDiskSize?: string; + validDiskSize?: string | null; /** * [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$DiskTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DiskTypesScopedList resources. */ - items?: {[key: string]: Schema$DiskTypesScopedList}; + items?: {[key: string]: Schema$DiskTypesScopedList} | null; /** * [Output Only] Type of resource. Always compute#diskTypeAggregatedList. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1912,7 +1928,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of disk types. @@ -1921,7 +1937,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DiskType resources. */ @@ -1929,15 +1945,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#diskTypeList for disk types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -1945,7 +1961,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$DiskTypesScopedList { /** @@ -1959,7 +1975,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A set of Display Device options @@ -1968,7 +1984,7 @@ export namespace compute_v1 { /** * Defines whether the instance has Display enabled. */ - enableDisplay?: boolean; + enableDisplay?: boolean | null; } export interface Schema$DistributionPolicy { /** @@ -1980,7 +1996,7 @@ export namespace compute_v1 { /** * The URL of the zone. The zone must exist in the region where the managed instance group is located. */ - zone?: string; + zone?: 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" @@ -1989,19 +2005,19 @@ export namespace compute_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. @@ -2010,15 +2026,15 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * List of interfaces for this external VPN gateway. */ @@ -2026,27 +2042,27 @@ export namespace compute_v1 { /** * [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this ExternalVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Indicates the user-supplied redundancy type of this external VPN gateway. */ - redundancyType?: string; + redundancyType?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * The interface for the external VPN gateway. @@ -2055,21 +2071,21 @@ export namespace compute_v1 { /** * The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 */ - id?: number; + id?: number | null; /** * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. */ - ipAddress?: string; + ipAddress?: string | null; } /** * Response to the list request, and contains a list of externalVpnGateways. */ export interface Schema$ExternalVpnGatewayList { - etag?: string; + etag?: string | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ExternalVpnGateway resources. */ @@ -2077,15 +2093,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2093,7 +2109,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. @@ -2102,39 +2118,39 @@ export namespace compute_v1 { /** * The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. */ - allowed?: Array<{IPProtocol?: string; ports?: string[]}>; + allowed?: Array<{IPProtocol?: string; ports?: string[]}> | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. */ - denied?: Array<{IPProtocol?: string; ports?: string[]}>; + denied?: Array<{IPProtocol?: string; ports?: string[]}> | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ - destinationRanges?: string[]; + destinationRanges?: string[] | null; /** * Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields. */ - direction?: string; + direction?: string | null; /** * Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ - disabled?: boolean; + disabled?: boolean | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#firewall for firewall rules. */ - kind?: string; + kind?: string | null; /** * This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ @@ -2142,39 +2158,39 @@ 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])?. 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; + name?: string | null; /** * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ - network?: string; + network?: string | null; /** * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ - priority?: number; + priority?: number | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported. */ - sourceRanges?: string[]; + sourceRanges?: string[] | null; /** * If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ - sourceServiceAccounts?: string[]; + sourceServiceAccounts?: string[] | null; /** * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. */ - sourceTags?: string[]; + sourceTags?: string[] | null; /** * A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. */ - targetServiceAccounts?: string[]; + targetServiceAccounts?: string[] | null; /** * A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. */ - targetTags?: string[]; + targetTags?: string[] | null; } /** * Contains a list of firewalls. @@ -2183,7 +2199,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Firewall resources. */ @@ -2191,15 +2207,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#firewallList for lists of firewalls. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2207,7 +2223,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * The available logging options for a firewall rule. @@ -2216,7 +2232,7 @@ export namespace compute_v1 { /** * This field denotes whether to enable logging for a particular firewall rule. */ - enable?: boolean; + enable?: boolean | null; } /** * Encapsulates numeric value that can be either absolute or relative. @@ -2225,15 +2241,15 @@ export namespace compute_v1 { /** * [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up. */ - calculated?: number; + calculated?: number | null; /** * Specifies a fixed number of VM instances. This must be a positive integer. */ - fixed?: number; + fixed?: number | null; /** * Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. */ - percent?: number; + percent?: number | null; } /** * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) @@ -2242,109 +2258,109 @@ export namespace compute_v1 { /** * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. */ - allPorts?: boolean; + allPorts?: boolean | null; /** * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. */ - backendService?: string; + backendService?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: * projects/project_id/regions/region/addresses/address-name * regions/region/addresses/address-name * global/addresses/address-name * address-name The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). */ - IPAddress?: string; + IPAddress?: string | null; /** * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. */ - IPProtocol?: string; + IPProtocol?: string | null; /** * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. */ - ipVersion?: string; + ipVersion?: string | null; /** * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. */ - kind?: string; + kind?: string | null; /** * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) */ - loadBalancingScheme?: string; + loadBalancingScheme?: string | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * This field is not used for external load balancing. For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. */ - network?: string; + network?: string | null; /** * This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. */ - networkTier?: string; + networkTier?: string | null; /** * This field is deprecated. See the port field. */ - portRange?: string; + 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. */ - ports?: string[]; + ports?: string[] | null; /** * [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. This field is only used for internal load balancing. */ - serviceLabel?: string; + serviceLabel?: string | null; /** * [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. */ - serviceName?: string; + serviceName?: string | null; /** * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. */ - subnetwork?: string; + subnetwork?: string | null; /** * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. */ - target?: string; + target?: string | null; } export interface Schema$ForwardingRuleAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ForwardingRulesScopedList resources. */ - items?: {[key: string]: Schema$ForwardingRulesScopedList}; + items?: {[key: string]: Schema$ForwardingRulesScopedList} | null; /** * [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2352,7 +2368,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of ForwardingRule resources. @@ -2361,7 +2377,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ForwardingRule resources. */ @@ -2369,15 +2385,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2385,10 +2401,10 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ForwardingRuleReference { - forwardingRule?: string; + forwardingRule?: string | null; } export interface Schema$ForwardingRulesScopedList { /** @@ -2402,17 +2418,17 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$GlobalSetLabelsRequest { /** * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } export interface Schema$GlobalSetPolicyRequest { /** @@ -2422,7 +2438,7 @@ export namespace compute_v1 { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -2435,11 +2451,11 @@ export namespace compute_v1 { /** * [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. */ - kind?: string; + kind?: string | null; /** * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') */ - queryPath?: string; + queryPath?: string | null; /** * [Output Only] The value of the requested queried path. */ @@ -2447,15 +2463,15 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The key to search for. */ - variableKey?: string; + variableKey?: string | null; /** * [Output Only] The value found for the requested key. */ - variableValue?: string; + variableValue?: string | null; } /** * A guest attributes namespace/key/value entry. @@ -2464,15 +2480,15 @@ export namespace compute_v1 { /** * Key for the guest attribute entry. */ - key?: string; + key?: string | null; /** * Namespace for the guest attribute entry. */ - namespace?: string; + namespace?: string | null; /** * Value for the guest attribute entry. */ - value?: string; + value?: string | null; } /** * Array of guest attribute namespace/key/value tuples. @@ -2487,7 +2503,7 @@ export namespace compute_v1 { /** * The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. */ - type?: string; + type?: string | null; } /** * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. @@ -2496,52 +2512,56 @@ export namespace compute_v1 { /** * How often (in seconds) to send a health check. The default value is 5 seconds. */ - checkIntervalSec?: number; + checkIntervalSec?: number | null; /** * [Output Only] Creation timestamp in 3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ - healthyThreshold?: number; + healthyThreshold?: number | null; http2HealthCheck?: Schema$HTTP2HealthCheck; httpHealthCheck?: Schema$HTTPHealthCheck; httpsHealthCheck?: Schema$HTTPSHealthCheck; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Type of the resource. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; + /** + * [Output Only] Region where the health check resides. Not applicable to global health checks. + */ + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; sslHealthCheck?: Schema$SSLHealthCheck; tcpHealthCheck?: Schema$TCPHealthCheck; /** * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ - timeoutSec?: number; + timeoutSec?: number | null; /** * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. */ - type?: string; + type?: string | null; /** * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } /** * Contains a list of HealthCheck resources. @@ -2550,7 +2570,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of HealthCheck resources. */ @@ -2558,15 +2578,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2574,31 +2594,75 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ export interface Schema$HealthCheckReference { - healthCheck?: string; + healthCheck?: string | null; + } + export interface Schema$HealthChecksAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthChecksScopedList resources. + */ + items?: {[key: string]: Schema$HealthChecksScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HealthChecksScopedList { + /** + * A list of HealthChecks contained in this scope. + */ + healthChecks?: Schema$HealthCheck[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; } export interface Schema$HealthStatus { /** * Health state of the instance. */ - healthState?: string; + healthState?: string | null; /** * URL of the instance resource. */ - instance?: string; + instance?: string | null; /** * The IP address represented by this resource. */ - ipAddress?: string; + ipAddress?: string | null; /** * The port on the instance. */ - port?: number; + port?: number | null; } export interface Schema$HealthStatusForNetworkEndpoint { /** @@ -2616,7 +2680,7 @@ export namespace compute_v1 { /** * Health state of the network endpoint determined based on the health checks configured. */ - healthState?: string; + healthState?: string | null; } /** * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. @@ -2625,75 +2689,75 @@ export namespace compute_v1 { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. */ - hosts?: string[]; + hosts?: string[] | null; /** * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. */ - pathMatcher?: string; + pathMatcher?: string | null; } export interface Schema$HTTP2HealthCheck { /** * The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The request path of the HTTP/2 health check request. The default value is /. */ - requestPath?: string; + requestPath?: string | null; /** * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } export interface Schema$HTTPHealthCheck { /** * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The request path of the HTTP health check request. The default value is /. */ - requestPath?: string; + requestPath?: string | null; /** * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } /** * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. @@ -2702,55 +2766,55 @@ export namespace compute_v1 { /** * How often (in seconds) to send a health check. The default value is 5 seconds. */ - checkIntervalSec?: number; + checkIntervalSec?: number | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ - healthyThreshold?: number; + healthyThreshold?: number | null; /** * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The TCP port number for the HTTP health check request. The default value is 80. */ - port?: number; + port?: number | null; /** * The request path of the HTTP health check request. The default value is /. This field does not support query parameters. */ - requestPath?: string; + requestPath?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ - timeoutSec?: number; + timeoutSec?: number | null; /** * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } /** * Contains a list of HttpHealthCheck resources. @@ -2759,7 +2823,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of HttpHealthCheck resources. */ @@ -2767,15 +2831,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2783,37 +2847,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; - } - export interface Schema$HTTPSHealthCheck { - /** - * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. - */ - host?: string; - /** - * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. - */ - port?: number; - /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. - */ - portName?: string; - /** - * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. - */ - portSpecification?: string; - /** - * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - */ - proxyHeader?: string; - /** - * The request path of the HTTPS health check request. The default value is /. - */ - requestPath?: string; - /** - * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. - */ - response?: string; + } | null; } /** * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. @@ -2822,55 +2856,85 @@ export namespace compute_v1 { /** * How often (in seconds) to send a health check. The default value is 5 seconds. */ - checkIntervalSec?: number; + checkIntervalSec?: number | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ - healthyThreshold?: number; + healthyThreshold?: number | null; /** * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ - host?: string; + host?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Type of the resource. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The TCP port number for the HTTPS health check request. The default value is 443. */ - port?: number; + port?: number | null; /** * The request path of the HTTPS health check request. The default value is "/". */ - requestPath?: string; + requestPath?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. */ - timeoutSec?: number; + timeoutSec?: number | null; /** * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; + } + export interface Schema$HTTPSHealthCheck { + /** + * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The request path of the HTTPS health check request. The default value is /. + */ + requestPath?: string | null; + /** + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + */ + response?: string | null; } /** * Contains a list of HttpsHealthCheck resources. @@ -2879,7 +2943,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of HttpsHealthCheck resources. */ @@ -2887,15 +2951,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -2903,7 +2967,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) @@ -2912,11 +2976,11 @@ export namespace compute_v1 { /** * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ - archiveSizeBytes?: string; + archiveSizeBytes?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * The deprecation status associated with this image. */ @@ -2924,15 +2988,15 @@ export namespace compute_v1 { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Size of the image when restored onto a persistent disk (in GB). */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. */ - family?: string; + family?: string | null; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -2940,7 +3004,7 @@ export namespace compute_v1 { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. */ @@ -2948,39 +3012,43 @@ export namespace compute_v1 { /** * [Output Only] Type of the resource. Always compute#image for images. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this image. These can be later modified by the setLabels method. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Integer license codes indicating which licenses are attached to this image. */ - licenseCodes?: string[]; + licenseCodes?: string[] | null; /** * Any applicable license URI. */ - licenses?: string[]; + licenses?: string[] | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The parameters of the raw disk image. */ - rawDisk?: {containerType?: string; sha1Checksum?: string; source?: string}; + rawDisk?: { + containerType?: string; + sha1Checksum?: string; + source?: string; + } | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ - sourceDisk?: string; + sourceDisk?: string | null; /** * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ @@ -2988,11 +3056,11 @@ export namespace compute_v1 { /** * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. */ - sourceDiskId?: string; + sourceDiskId?: string | null; /** * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ - sourceImage?: string; + sourceImage?: string | null; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ @@ -3000,11 +3068,11 @@ export namespace compute_v1 { /** * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. */ - sourceImageId?: string; + sourceImageId?: string | null; /** * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ - sourceSnapshot?: string; + sourceSnapshot?: string | null; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ @@ -3012,15 +3080,15 @@ export namespace compute_v1 { /** * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. */ - sourceSnapshotId?: string; + sourceSnapshotId?: string | null; /** * The type of the image used to create this disk. The default and only value is RAW */ - sourceType?: string; + sourceType?: string | null; /** * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ - status?: string; + status?: string | null; } /** * Contains a list of images. @@ -3029,7 +3097,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Image resources. */ @@ -3037,15 +3105,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3053,7 +3121,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) @@ -3062,23 +3130,23 @@ export namespace compute_v1 { /** * Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. */ - canIpForward?: boolean; + canIpForward?: boolean | null; /** * [Output Only] The CPU platform used by this instance. */ - cpuPlatform?: string; + cpuPlatform?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * Whether the resource should be protected against deletion. */ - deletionProtection?: boolean; + deletionProtection?: boolean | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Array of disks associated with this instance. Persistent disks must be created before you can assign them. */ @@ -3094,27 +3162,27 @@ export namespace compute_v1 { /** * Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. */ - hostname?: string; + hostname?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#instance for instances. */ - kind?: string; + kind?: string | null; /** * A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this instance. These can be later modified by the setLabels method. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. */ - machineType?: string; + machineType?: string | null; /** * The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. */ @@ -3122,11 +3190,11 @@ export namespace compute_v1 { /** * Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". */ - minCpuPlatform?: string; + minCpuPlatform?: 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. */ - name?: string; + name?: string | null; /** * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. */ @@ -3142,7 +3210,7 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. */ @@ -3152,15 +3220,15 @@ export namespace compute_v1 { /** * [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. */ - startRestricted?: boolean; + startRestricted?: boolean | null; /** * [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. */ - status?: string; + status?: string | null; /** * [Output Only] An optional, human-readable explanation of the status. */ - statusMessage?: string; + statusMessage?: string | null; /** * Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. */ @@ -3168,29 +3236,29 @@ export namespace compute_v1 { /** * [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$InstanceAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * An object that contains a list of instances scoped by zone. */ - items?: {[key: string]: Schema$InstancesScopedList}; + items?: {[key: string]: Schema$InstancesScopedList} | null; /** * [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3198,7 +3266,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | 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 ==) @@ -3207,27 +3275,27 @@ export namespace compute_v1 { /** * [Output Only] The creation timestamp for this instance group in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] A unique identifier for this instance group, generated by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The resource type, which is always compute#instanceGroup for instance groups. */ - kind?: string; + kind?: string | null; /** * The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. */ - name?: string; + name?: string | null; /** * Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. */ @@ -3235,49 +3303,49 @@ export namespace compute_v1 { /** * The URL of the network to which all instances in the instance group belong. */ - network?: string; + network?: string | null; /** * [Output Only] The URL of the region where the instance group is located (for regional resources). */ - region?: string; + region?: string | null; /** * [Output Only] The URL for this instance group. The server generates this URL. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The total number of instances in the instance group. */ - size?: number; + size?: number | null; /** * [Output Only] The URL of the subnetwork to which all instances in the instance group belong. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output Only] The URL of the zone where the instance group is located (for zonal resources). */ - zone?: string; + zone?: string | null; } export interface Schema$InstanceGroupAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupsScopedList resources. */ - items?: {[key: string]: Schema$InstanceGroupsScopedList}; + items?: {[key: string]: Schema$InstanceGroupsScopedList} | null; /** * [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3285,7 +3353,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A list of InstanceGroup resources. @@ -3294,7 +3362,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroup resources. */ @@ -3302,15 +3370,15 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3318,7 +3386,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) @@ -3331,11 +3399,11 @@ export namespace compute_v1 { /** * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. */ - baseInstanceName?: string; + baseInstanceName?: string | null; /** * [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. */ @@ -3343,7 +3411,7 @@ export namespace compute_v1 { /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Policy specifying intended distribution of instances in regional managed instance group. */ @@ -3351,27 +3419,27 @@ export namespace compute_v1 { /** * Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] A unique identifier for this resource type. The server generates this identifier. */ - id?: string; + id?: string | null; /** * [Output Only] The URL of the Instance Group resource. */ - instanceGroup?: string; + instanceGroup?: string | null; /** * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ - instanceTemplate?: string; + instanceTemplate?: string | null; /** * [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. */ - kind?: string; + kind?: string | null; /** * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. */ - name?: string; + name?: string | null; /** * Named ports configured for the Instance Groups complementary to this Instance Group Manager. */ @@ -3379,11 +3447,11 @@ export namespace compute_v1 { /** * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ - region?: string; + region?: string | null; /** * [Output Only] The URL for this managed instance group. The server defines this URL. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of this managed instance group. */ @@ -3391,11 +3459,11 @@ export namespace compute_v1 { /** * The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ - targetPools?: string[]; + targetPools?: string[] | null; /** * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. */ - targetSize?: number; + targetSize?: number | null; /** * The update policy for this managed instance group. */ @@ -3407,67 +3475,67 @@ export namespace compute_v1 { /** * [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). */ - zone?: string; + zone?: string | null; } export interface Schema$InstanceGroupManagerActionsSummary { /** * [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. */ - abandoning?: number; + abandoning?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. */ - creating?: number; + creating?: number | null; /** * [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. */ - creatingWithoutRetries?: number; + creatingWithoutRetries?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. */ - deleting?: number; + deleting?: number | null; /** * [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. */ - none?: number; + none?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. */ - recreating?: number; + recreating?: number | null; /** * [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. */ - refreshing?: number; + refreshing?: number | null; /** * [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. */ - restarting?: number; + restarting?: number | null; /** * [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. */ - verifying?: number; + verifying?: number | null; } export interface Schema$InstanceGroupManagerAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupManagersScopedList resources. */ - items?: {[key: string]: Schema$InstanceGroupManagersScopedList}; + items?: {[key: string]: Schema$InstanceGroupManagersScopedList} | null; /** * [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3475,17 +3543,17 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupManagerAutoHealingPolicy { /** * The URL for the health check that signals autohealing. */ - healthCheck?: string; + healthCheck?: string | null; /** * The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. */ - initialDelaySec?: number; + initialDelaySec?: number | null; } /** * [Output Only] A list of managed instance groups. @@ -3494,7 +3562,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupManager resources. */ @@ -3502,15 +3570,15 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3518,19 +3586,19 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** * 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]. */ - instances?: string[]; + instances?: string[] | null; } 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$InstanceGroupManagersListManagedInstancesResponse { /** @@ -3542,7 +3610,7 @@ export namespace compute_v1 { /** * 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$InstanceGroupManagersScopedList { /** @@ -3556,29 +3624,29 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupManagersSetInstanceTemplateRequest { /** * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ - instanceTemplate?: string; + instanceTemplate?: string | null; } export interface Schema$InstanceGroupManagersSetTargetPoolsRequest { /** * The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings. */ - targetPools?: string[]; + targetPools?: string[] | null; } export interface Schema$InstanceGroupManagerStatus { /** * [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; + isStable?: boolean | null; } export interface Schema$InstanceGroupManagerUpdatePolicy { /** @@ -3592,21 +3660,21 @@ export namespace compute_v1 { /** * Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. */ - minimalAction?: string; + minimalAction?: 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). */ - type?: string; + type?: string | null; } export interface Schema$InstanceGroupManagerVersion { /** * The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. */ - instanceTemplate?: string; + instanceTemplate?: string | null; /** * Name of the version. Unique among all versions in the scope of this managed instance group. */ - name?: string; + name?: string | null; /** * Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. */ @@ -3622,7 +3690,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceWithNamedPorts resources. */ @@ -3630,15 +3698,15 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3646,13 +3714,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupsListInstancesRequest { /** * A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. */ - instanceState?: string; + instanceState?: string | null; } export interface Schema$InstanceGroupsRemoveInstancesRequest { /** @@ -3672,13 +3740,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of named ports to set for this instance group. */ @@ -3691,7 +3759,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Instance resources. */ @@ -3699,15 +3767,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3715,7 +3783,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of instance referrers. @@ -3724,7 +3792,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Reference resources. */ @@ -3732,15 +3800,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3748,27 +3816,27 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; 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 */ - destinationZone?: string; + destinationZone?: string | null; /** * The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ - targetInstance?: string; + targetInstance?: string | null; } export interface Schema$InstanceProperties { /** * Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. */ - canIpForward?: boolean; + canIpForward?: boolean | null; /** * An optional text description for the instances that are created from this instance template. */ - description?: string; + description?: string | null; /** * An array of disks that are associated with the instances that are created from this template. */ @@ -3780,11 +3848,11 @@ export namespace compute_v1 { /** * Labels to apply to instances that are created from this template. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The machine type to use for instances that are created from this template. */ - machineType?: string; + machineType?: string | null; /** * The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. */ @@ -3792,7 +3860,7 @@ export namespace compute_v1 { /** * 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 minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * An array of network access configurations for this interface. */ @@ -3819,7 +3887,7 @@ export namespace compute_v1 { /** * The URL for a specific instance. */ - instance?: string; + instance?: string | null; } export interface Schema$InstancesScopedList { /** @@ -3833,14 +3901,14 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstancesSetLabelsRequest { /** * Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels. */ - labelFingerprint?: string; - labels?: {[key: string]: string}; + labelFingerprint?: string | null; + labels?: {[key: string]: string} | null; } export interface Schema$InstancesSetMachineResourcesRequest { /** @@ -3852,23 +3920,23 @@ export namespace compute_v1 { /** * Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1 */ - machineType?: string; + machineType?: string | null; } export interface Schema$InstancesSetMinCpuPlatformRequest { /** * Minimum cpu/platform this instance should be started at. */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; } export interface Schema$InstancesSetServiceAccountRequest { /** * Email address of the service account. */ - email?: string; + email?: string | null; /** * The list of scopes to be made available for this service account. */ - scopes?: string[]; + scopes?: string[] | null; } export interface Schema$InstancesStartWithEncryptionKeyRequest { /** @@ -3883,23 +3951,23 @@ export namespace compute_v1 { /** * [Output Only] The creation timestamp for this instance template in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] A unique identifier for this instance template. The server defines this identifier. */ - id?: string; + id?: string | null; /** * [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. */ - kind?: string; + kind?: string | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The instance properties for this instance template. */ @@ -3907,11 +3975,11 @@ export namespace compute_v1 { /** * [Output Only] The URL for this instance template. The server defines this URL. */ - selfLink?: string; + selfLink?: string | null; /** * The source instance used to create the template. 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; + sourceInstance?: string | null; /** * The source instance params to use to create this instance template. */ @@ -3924,7 +3992,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceTemplate resources. */ @@ -3932,15 +4000,15 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -3948,13 +4016,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$InstanceWithNamedPorts { /** * [Output Only] The URL of the instance. */ - instance?: string; + instance?: string | null; /** * [Output Only] The named ports that belong to this instance group. */ @@ -3962,7 +4030,7 @@ export namespace compute_v1 { /** * [Output Only] The status of the instance. */ - status?: string; + status?: string | null; } /** * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) @@ -3971,7 +4039,7 @@ export namespace compute_v1 { /** * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. */ - adminEnabled?: boolean; + adminEnabled?: boolean | null; /** * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. */ @@ -3979,15 +4047,15 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. */ - customerName?: string; + customerName?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] A list of outages expected for this Interconnect. */ @@ -3995,67 +4063,67 @@ export namespace compute_v1 { /** * [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. */ - googleIpAddress?: string; + googleIpAddress?: string | null; /** * [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ - googleReferenceId?: string; + googleReferenceId?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. */ - interconnectAttachments?: string[]; + interconnectAttachments?: string[] | null; /** * Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. */ - interconnectType?: string; + interconnectType?: string | null; /** * [Output Only] Type of the resource. Always compute#interconnect for interconnects. */ - kind?: string; + kind?: string | null; /** * Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. */ - linkType?: string; + linkType?: string | null; /** * URL of the InterconnectLocation object that represents where this connection is to be provisioned. */ - location?: string; + location?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. */ - nocContactEmail?: string; + nocContactEmail?: string | null; /** * [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ - operationalStatus?: string; + operationalStatus?: string | null; /** * [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. */ - peerIpAddress?: string; + peerIpAddress?: string | null; /** * [Output Only] Number of links actually provisioned in this interconnect. */ - provisionedLinkCount?: number; + provisionedLinkCount?: number | null; /** * Target number of physical links in the link bundle, as requested by the customer. */ - requestedLinkCount?: number; + requestedLinkCount?: number | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ - state?: string; + state?: string | null; } /** * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) @@ -4064,67 +4132,67 @@ export namespace compute_v1 { /** * Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. */ - adminEnabled?: boolean; + adminEnabled?: boolean | null; /** * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s */ - bandwidth?: string; + bandwidth?: string | null; /** * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ - candidateSubnets?: string[]; + candidateSubnets?: string[] | null; /** * [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. */ - cloudRouterIpAddress?: string; + cloudRouterIpAddress?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. */ - customerRouterIpAddress?: string; + customerRouterIpAddress?: string | null; /** * An optional description of this resource. */ - description?: string; + description?: string | null; /** * Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ - edgeAvailabilityDomain?: string; + edgeAvailabilityDomain?: string | null; /** * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. */ - googleReferenceId?: string; + googleReferenceId?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * URL of the underlying Interconnect object that this attachment's traffic will traverse through. */ - interconnect?: string; + interconnect?: string | null; /** * [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. */ - operationalStatus?: string; + operationalStatus?: string | null; /** * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" */ - pairingKey?: string; + pairingKey?: string | null; /** * Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ - partnerAsn?: string; + partnerAsn?: string | null; /** * Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. */ @@ -4136,49 +4204,49 @@ export namespace compute_v1 { /** * [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. */ - router?: string; + router?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. */ - state?: string; + state?: string | null; /** * The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. */ - type?: string; + type?: string | null; /** * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. */ - vlanTag8021q?: number; + vlanTag8021q?: number | null; } export interface Schema$InterconnectAttachmentAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InterconnectAttachmentsScopedList resources. */ - items?: {[key: string]: Schema$InterconnectAttachmentsScopedList}; + items?: {[key: string]: Schema$InterconnectAttachmentsScopedList} | null; /** * [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4186,7 +4254,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Response to the list request, and contains a list of interconnect attachments. @@ -4195,7 +4263,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InterconnectAttachment resources. */ @@ -4203,15 +4271,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4219,7 +4287,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. @@ -4228,15 +4296,15 @@ export namespace compute_v1 { /** * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ - interconnectName?: string; + interconnectName?: string | null; /** * Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values. */ - partnerName?: string; + partnerName?: string | null; /** * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ - portalUrl?: string; + portalUrl?: string | null; } /** * Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. @@ -4245,7 +4313,7 @@ export namespace compute_v1 { /** * [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region. */ - tag8021q?: number; + tag8021q?: number | null; } export interface Schema$InterconnectAttachmentsScopedList { /** @@ -4259,7 +4327,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 @@ -4268,15 +4336,15 @@ export namespace compute_v1 { /** * Customer-side demarc ID for this circuit. */ - customerDemarcId?: string; + customerDemarcId?: string | null; /** * Google-assigned unique ID for this circuit. Assigned at circuit turn-up. */ - googleCircuitId?: string; + googleCircuitId?: string | null; /** * Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. */ - googleDemarcId?: string; + googleDemarcId?: string | null; } /** * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. @@ -4293,7 +4361,7 @@ export namespace compute_v1 { /** * The MAC address of the Interconnect's bundle interface. */ - macAddress?: string; + macAddress?: string | null; } /** * Describing the ARP neighbor entries seen on this link @@ -4302,35 +4370,35 @@ export namespace compute_v1 { /** * The IP address of this ARP neighbor. */ - ipAddress?: string; + ipAddress?: string | null; /** * The MAC address of this ARP neighbor. */ - macAddress?: string; + macAddress?: string | null; } export interface Schema$InterconnectDiagnosticsLinkLACPStatus { /** * System ID of the port on Google?s side of the LACP exchange. */ - googleSystemId?: string; + googleSystemId?: string | null; /** * System ID of the port on the neighbor?s side of the LACP exchange. */ - neighborSystemId?: string; + neighborSystemId?: string | null; /** * The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. */ - state?: string; + state?: string | null; } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { /** * The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. */ - state?: string; + state?: string | null; /** * Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. */ - value?: number; + value?: number | null; } export interface Schema$InterconnectDiagnosticsLinkStatus { /** @@ -4340,11 +4408,11 @@ export namespace compute_v1 { /** * The unique ID for this link assigned during turn up by Google. */ - circuitId?: string; + circuitId?: string | null; /** * The Demarc address assigned by Google and provided in the LoA. */ - googleDemarc?: string; + googleDemarc?: string | null; lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; /** * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. @@ -4362,7 +4430,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Interconnect resources. */ @@ -4370,15 +4438,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4386,7 +4454,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. @@ -4395,51 +4463,51 @@ export namespace compute_v1 { /** * [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. */ - address?: string; + address?: string | null; /** * [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". */ - availabilityZone?: string; + availabilityZone?: string | null; /** * [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". */ - city?: string; + city?: string | null; /** * [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA */ - continent?: string; + continent?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] An optional description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The name of the provider for this facility (e.g., EQUINIX). */ - facilityProvider?: string; + facilityProvider?: string | null; /** * [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). */ - facilityProviderFacilityId?: string; + facilityProviderFacilityId?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). */ - peeringdbFacilityId?: string; + peeringdbFacilityId?: string | null; /** * [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. */ @@ -4447,11 +4515,11 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. */ - status?: string; + status?: string | null; } /** * Response to the list request, and contains a list of interconnect locations. @@ -4460,7 +4528,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InterconnectLocation resources. */ @@ -4468,15 +4536,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4484,7 +4552,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. @@ -4493,15 +4561,15 @@ export namespace compute_v1 { /** * Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. */ - expectedRttMs?: string; + expectedRttMs?: string | null; /** * Identifies the network presence of this location. */ - locationPresence?: string; + locationPresence?: string | null; /** * URL for the region of this location. */ - region?: string; + region?: string | null; } /** * Description of a planned outage on this Interconnect. Next id: 9 @@ -4510,35 +4578,35 @@ export namespace compute_v1 { /** * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. */ - affectedCircuits?: string[]; + affectedCircuits?: string[] | null; /** * A description about the purpose of the outage. */ - description?: string; + description?: string | null; /** * Scheduled end time for the outage (milliseconds since Unix epoch). */ - endTime?: string; + endTime?: string | null; /** * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. */ - issueType?: string; + issueType?: string | null; /** * Unique identifier for this outage notification. */ - name?: string; + name?: string | null; /** * The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. */ - source?: string; + source?: string | null; /** * Scheduled start time for the outage (milliseconds since Unix epoch). */ - startTime?: string; + startTime?: string | null; /** * State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. */ - state?: string; + state?: string | null; } /** * Response for the InterconnectsGetDiagnosticsRequest. @@ -4553,58 +4621,58 @@ export namespace compute_v1 { /** * [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. */ - chargesUseFee?: boolean; + chargesUseFee?: boolean | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#license for licenses. */ - kind?: string; + kind?: string | null; /** * [Output Only] The unique code used to attach this license to images, snapshots, and disks. */ - licenseCode?: string; + licenseCode?: string | null; /** * Name of the resource. The name must be 1-63 characters long and comply with RFC1035. */ - name?: string; + name?: string | null; resourceRequirements?: Schema$LicenseResourceRequirements; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. */ - transferable?: boolean; + transferable?: boolean | null; } export interface Schema$LicenseCode { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] Description of this License Code. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#licenseCode for licenses. */ - kind?: string; + kind?: string | null; /** * [Output Only] URL and description aliases of Licenses with the same License Code. */ @@ -4612,45 +4680,45 @@ export namespace compute_v1 { /** * [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Current state of this License Code. */ - state?: string; + state?: string | null; /** * [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. */ - transferable?: boolean; + transferable?: boolean | null; } export interface Schema$LicenseCodeLicenseAlias { /** * [Output Only] Description of this License Code. */ - description?: string; + description?: string | null; /** * [Output Only] URL of license corresponding to this License Code. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$LicenseResourceRequirements { /** * Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. */ - minGuestCpuCount?: number; + minGuestCpuCount?: number | null; /** * Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. */ - minMemoryMb?: number; + minMemoryMb?: number | null; } export interface Schema$LicensesListResponse { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of License resources. */ @@ -4658,11 +4726,11 @@ export namespace compute_v1 { /** * [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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4670,7 +4738,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Specifies what kind of log the caller must write @@ -4700,7 +4768,7 @@ export namespace compute_v1 { /** * The log_name to populate in the Cloud Audit Record. */ - logName?: string; + logName?: string | null; } /** * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). @@ -4709,11 +4777,11 @@ export namespace compute_v1 { /** * The field value to attribute. */ - field?: string; + field?: string | null; /** * The metric to update. */ - metric?: string; + metric?: string | null; } /** * Write a Data Access (Gin) log @@ -4722,7 +4790,7 @@ export namespace compute_v1 { /** * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. */ - logMode?: string; + logMode?: string | null; } /** * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) @@ -4731,7 +4799,7 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this machine type. */ @@ -4739,77 +4807,77 @@ export namespace compute_v1 { /** * [Output Only] An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The number of virtual CPUs that are available to the instance. */ - guestCpus?: number; + guestCpus?: number | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Deprecated] This property is deprecated and will never be populated with any relevant values. */ - imageSpaceGb?: number; + imageSpaceGb?: number | null; /** * [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. */ - isSharedCpu?: boolean; + isSharedCpu?: boolean | null; /** * [Output Only] The type of the resource. Always compute#machineType for machine types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Maximum persistent disks allowed. */ - maximumPersistentDisks?: number; + maximumPersistentDisks?: number | null; /** * [Output Only] Maximum total persistent disks size (GB) allowed. */ - maximumPersistentDisksSizeGb?: string; + maximumPersistentDisksSizeGb?: string | null; /** * [Output Only] The amount of physical memory available to the instance, defined in MB. */ - memoryMb?: number; + memoryMb?: number | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] A list of extended scratch disks assigned to the instance. */ - scratchDisks?: Array<{diskGb?: number}>; + scratchDisks?: Array<{diskGb?: number}> | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The name of the zone where the machine type resides, such as us-central1-a. */ - zone?: string; + zone?: string | null; } export interface Schema$MachineTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of MachineTypesScopedList resources. */ - items?: {[key: string]: Schema$MachineTypesScopedList}; + items?: {[key: string]: Schema$MachineTypesScopedList} | null; /** * [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4817,7 +4885,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of machine types. @@ -4826,7 +4894,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of MachineType resources. */ @@ -4834,15 +4902,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -4850,7 +4918,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$MachineTypesScopedList { /** @@ -4864,7 +4932,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A Managed Instance resource. @@ -4873,19 +4941,19 @@ export namespace compute_v1 { /** * [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. */ - currentAction?: string; + currentAction?: string | null; /** * [Output only] The unique identifier for this resource. This field is empty when instance does not exist. */ - id?: string; + id?: string | null; /** * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ - instance?: string; + instance?: string | null; /** * [Output Only] The status of the instance. This field is empty when the instance does not exist. */ - instanceStatus?: string; + instanceStatus?: string | null; /** * [Output Only] Information about the last attempt to create or delete the instance. */ @@ -4901,17 +4969,17 @@ export namespace compute_v1 { */ errors?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; } export interface Schema$ManagedInstanceVersion { /** * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. */ - instanceTemplate?: string; + instanceTemplate?: string | null; /** * [Output Only] Name of the version. */ - name?: string; + name?: string | null; } /** * A metadata key/value entry. @@ -4920,15 +4988,15 @@ export namespace compute_v1 { /** * Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. */ - fingerprint?: string; + fingerprint?: string | null; /** * Array of key/value pairs. The total size of all keys and values must be less than 512 KB. */ - items?: Array<{key?: string; value?: string}>; + items?: Array<{key?: string; value?: string}> | null; /** * [Output Only] Type of the resource. Always compute#metadata for metadata. */ - kind?: string; + kind?: string | null; } /** * The named port. For example: . @@ -4937,11 +5005,11 @@ export namespace compute_v1 { /** * The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. */ - name?: string; + name?: string | null; /** * The port number, which can be a value between 1 and 65535. */ - port?: number; + port?: number | null; } /** * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) @@ -4950,35 +5018,35 @@ export namespace compute_v1 { /** * When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. */ - autoCreateSubnetworks?: boolean; + autoCreateSubnetworks?: boolean | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The gateway address for default routing out of the network, selected by GCP. */ - gatewayIPv4?: string; + gatewayIPv4?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. */ - IPv4Range?: string; + IPv4Range?: string | null; /** * [Output Only] Type of the resource. Always compute#network for networks. */ - kind?: string; + 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?: string; + name?: string | null; /** * [Output Only] A list of network peerings for the resource. */ @@ -4990,11 +5058,11 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. */ - subnetworks?: string[]; + subnetworks?: string[] | null; } /** * The network endpoint. @@ -5003,15 +5071,15 @@ export namespace compute_v1 { /** * The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035. */ - instance?: string; + instance?: string | null; /** * Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. */ - ipAddress?: string; + ipAddress?: string | null; /** * Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used. */ - port?: number; + port?: number | null; } /** * Represents a collection of network endpoints. @@ -5020,73 +5088,73 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * The default port used if the port number is not specified in the network endpoint. */ - defaultPort?: number; + defaultPort?: number | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. */ - kind?: string; + kind?: string | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. */ - network?: string; + network?: string | null; /** * Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT. */ - networkEndpointType?: string; + networkEndpointType?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] Number of network endpoints in the network endpoint group. */ - size?: number; + size?: number | null; /** * Optional URL of the subnetwork to which all network endpoints in the NEG belong. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output Only] The URL of the zone where the network endpoint group is located. */ - zone?: string; + zone?: string | null; } export interface Schema$NetworkEndpointGroupAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NetworkEndpointGroupsScopedList resources. */ - items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList}; + items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList} | null; /** * [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5094,13 +5162,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NetworkEndpointGroupList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NetworkEndpointGroup resources. */ @@ -5108,15 +5176,15 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5124,7 +5192,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NetworkEndpointGroupsAttachEndpointsRequest { /** @@ -5142,13 +5210,13 @@ export namespace compute_v1 { /** * Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided. */ - healthStatus?: string; + healthStatus?: string | null; } export interface Schema$NetworkEndpointGroupsListNetworkEndpoints { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NetworkEndpointWithHealthStatus resources. */ @@ -5156,11 +5224,11 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Informational warning message. */ @@ -5168,7 +5236,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NetworkEndpointGroupsScopedList { /** @@ -5182,7 +5250,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NetworkEndpointWithHealthStatus { /** @@ -5209,27 +5277,27 @@ export namespace compute_v1 { /** * 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; + fingerprint?: string | null; /** * [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. */ - kind?: string; + kind?: string | null; /** * [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. */ - name?: string; + name?: string | null; /** * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ - network?: string; + network?: string | null; /** * An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ - networkIP?: string; + networkIP?: string | null; /** * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ - subnetwork?: string; + subnetwork?: string | null; } /** * Contains a list of networks. @@ -5238,7 +5306,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Network resources. */ @@ -5246,15 +5314,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#networkList for lists of networks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5262,7 +5330,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. @@ -5271,35 +5339,35 @@ export namespace compute_v1 { /** * This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ - autoCreateRoutes?: boolean; + autoCreateRoutes?: boolean | null; /** * Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ - exchangeSubnetRoutes?: boolean; + exchangeSubnetRoutes?: boolean | null; /** * Whether to export the custom routes to peer network. */ - exportCustomRoutes?: boolean; + exportCustomRoutes?: boolean | null; /** * Whether to import the custom routes from peer network. */ - importCustomRoutes?: boolean; + importCustomRoutes?: boolean | null; /** * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ - network?: string; + network?: string | null; /** * [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. */ - state?: string; + state?: string | null; /** * [Output Only] Details about the current state of the peering. */ - stateDetails?: string; + stateDetails?: string | null; } /** * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. @@ -5308,17 +5376,17 @@ export namespace compute_v1 { /** * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. */ - routingMode?: string; + routingMode?: string | null; } export interface Schema$NetworksAddPeeringRequest { /** * This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ - autoCreateRoutes?: boolean; + autoCreateRoutes?: boolean | null; /** * Name of the peering, which should conform to RFC1035. */ - name?: string; + name?: string | null; /** * Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ @@ -5326,13 +5394,13 @@ export namespace compute_v1 { /** * URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ - peerNetwork?: string; + peerNetwork?: string | null; } export interface Schema$NetworksRemovePeeringRequest { /** * Name of the peering, which should conform to RFC1035. */ - name?: string; + name?: string | null; } export interface Schema$NetworksUpdatePeeringRequest { networkPeering?: Schema$NetworkPeering; @@ -5344,62 +5412,62 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ - kind?: string; + kind?: 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. */ - name?: string; + name?: string | null; /** * The URL of the node template to which this node group belongs. */ - nodeTemplate?: string; + nodeTemplate?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The total number of nodes in the node group. */ - size?: number; - status?: string; + size?: number | null; + status?: string | null; /** * [Output Only] The name of the zone where the node group resides, such as us-central1-a. */ - zone?: string; + zone?: string | null; } export interface Schema$NodeGroupAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeGroupsScopedList resources. */ - items?: {[key: string]: Schema$NodeGroupsScopedList}; + items?: {[key: string]: Schema$NodeGroupsScopedList} | null; /** * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5407,7 +5475,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of nodeGroups. @@ -5416,7 +5484,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeGroup resources. */ @@ -5424,15 +5492,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5440,44 +5508,44 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeGroupNode { /** * Instances scheduled on this node. */ - instances?: string[]; + instances?: string[] | null; /** * The name of the node. */ - name?: string; + name?: string | null; /** * The type of this node. */ - nodeType?: string; + nodeType?: string | null; /** * Binding properties for the physical server. */ serverBinding?: Schema$ServerBinding; - status?: string; + status?: string | null; } export interface Schema$NodeGroupsAddNodesRequest { /** * Count of additional nodes to be added to the node group. */ - additionalNodeCount?: number; + additionalNodeCount?: number | null; } export interface Schema$NodeGroupsDeleteNodesRequest { /** * Names of the nodes to delete. */ - nodes?: string[]; + nodes?: string[] | null; } export interface Schema$NodeGroupsListNodes { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Node resources. */ @@ -5485,15 +5553,15 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5501,7 +5569,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeGroupsScopedList { /** @@ -5515,13 +5583,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** * Full or partial URL of the node template resource to be updated for this node group. */ - nodeTemplate?: string; + 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 ==) @@ -5530,31 +5598,31 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. */ - kind?: string; + kind?: 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. */ - name?: string; + name?: string | null; /** * Labels to use for node affinity, which will be used in instance scheduling. */ - nodeAffinityLabels?: {[key: string]: string}; + nodeAffinityLabels?: {[key: string]: string} | null; /** * The node type to use for nodes group that are created from this template. */ - nodeType?: string; + nodeType?: string | null; /** * The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. */ @@ -5562,11 +5630,11 @@ export namespace compute_v1 { /** * [Output Only] The name of the region where the node template resides, such as us-central1. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. */ @@ -5574,33 +5642,33 @@ export namespace compute_v1 { /** * [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. */ - status?: string; + status?: string | null; /** * [Output Only] An optional, human-readable explanation of the status. */ - statusMessage?: string; + statusMessage?: string | null; } export interface Schema$NodeTemplateAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeTemplatesScopedList resources. */ - items?: {[key: string]: Schema$NodeTemplatesScopedList}; + items?: {[key: string]: Schema$NodeTemplatesScopedList} | null; /** * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5608,7 +5676,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of node templates. @@ -5617,7 +5685,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeTemplate resources. */ @@ -5625,15 +5693,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5641,12 +5709,12 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeTemplateNodeTypeFlexibility { - cpus?: string; - localSsd?: string; - memory?: string; + cpus?: string | null; + localSsd?: string | null; + memory?: string | null; } export interface Schema$NodeTemplatesScopedList { /** @@ -5660,7 +5728,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) @@ -5669,11 +5737,11 @@ export namespace compute_v1 { /** * [Output Only] The CPU platform used by this node type. */ - cpuPlatform?: string; + cpuPlatform?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this node type. */ @@ -5681,61 +5749,61 @@ export namespace compute_v1 { /** * [Output Only] An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The number of virtual CPUs that are available to the node type. */ - guestCpus?: number; + guestCpus?: number | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The type of the resource. Always compute#nodeType for node types. */ - kind?: string; + kind?: string | null; /** * [Output Only] Local SSD available to the node type, defined in GB. */ - localSsdGb?: number; + localSsdGb?: number | null; /** * [Output Only] The amount of physical memory available to the node type, defined in MB. */ - memoryMb?: number; + memoryMb?: number | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The name of the zone where the node type resides, such as us-central1-a. */ - zone?: string; + zone?: string | null; } export interface Schema$NodeTypeAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeTypesScopedList resources. */ - items?: {[key: string]: Schema$NodeTypesScopedList}; + items?: {[key: string]: Schema$NodeTypesScopedList} | null; /** * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5743,7 +5811,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of node types. @@ -5752,7 +5820,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of NodeType resources. */ @@ -5760,15 +5828,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5776,7 +5844,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$NodeTypesScopedList { /** @@ -5790,7 +5858,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) @@ -5799,89 +5867,89 @@ export namespace compute_v1 { /** * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ - clientOperationId?: string; + clientOperationId?: string | null; /** * [Deprecated] This field is deprecated. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] A textual description of the operation, which is set when the operation is created. */ - description?: string; + description?: string | null; /** * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ - endTime?: string; + endTime?: string | null; /** * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ - httpErrorMessage?: string; + httpErrorMessage?: string | null; /** * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ - httpErrorStatusCode?: number; + httpErrorStatusCode?: number | null; /** * [Output Only] The unique identifier for the operation. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the operation. */ - name?: string; + name?: string | null; /** * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ - operationType?: string; + operationType?: string | null; /** * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ - progress?: number; + progress?: number | null; /** * [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ - status?: string; + status?: string | null; /** * [Output Only] An optional textual description of the current status of the operation. */ - statusMessage?: string; + statusMessage?: string | null; /** * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ - targetId?: string; + targetId?: string | null; /** * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ - targetLink?: string; + targetLink?: string | null; /** * [Output Only] User who requested the operation, for example: user@example.com. */ - user?: string; + user?: string | null; /** * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ @@ -5889,33 +5957,33 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; /** * [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. */ - zone?: string; + zone?: string | null; } export interface Schema$OperationAggregatedList { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A map of scoped operation lists. */ - items?: {[key: string]: Schema$OperationsScopedList}; + items?: {[key: string]: Schema$OperationsScopedList} | null; /** * [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5923,7 +5991,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Operation resources. @@ -5932,7 +6000,7 @@ export namespace compute_v1 { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of Operation resources. */ @@ -5940,15 +6008,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#operations for Operations resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -5956,7 +6024,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$OperationsScopedList { /** @@ -5970,7 +6038,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. @@ -5979,15 +6047,15 @@ export namespace compute_v1 { /** * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use */ - defaultService?: string; + defaultService?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * The name to which this PathMatcher is referred by the HostRule. */ - name?: string; + name?: string | null; /** * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. */ @@ -6000,11 +6068,11 @@ export namespace compute_v1 { /** * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. */ - paths?: string[]; + paths?: string[] | null; /** * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ - service?: string; + service?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -6021,8 +6089,8 @@ export namespace compute_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; - iamOwned?: boolean; + etag?: string | null; + iamOwned?: boolean | null; /** * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ @@ -6030,7 +6098,7 @@ export namespace compute_v1 { /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) @@ -6043,35 +6111,35 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. */ - defaultNetworkTier?: string; + defaultNetworkTier?: string | null; /** * [Output Only] Default service account used by VMs running in this project. */ - defaultServiceAccount?: string; + defaultServiceAccount?: string | null; /** * An optional textual description of the resource. */ - description?: string; + description?: string | null; /** * Restricted features enabled for use on this project. */ - enabledFeatures?: string[]; + enabledFeatures?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#project for projects. */ - kind?: string; + kind?: string | null; /** * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. */ - name?: string; + name?: string | null; /** * [Output Only] Quotas assigned to this project. */ @@ -6079,7 +6147,7 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. */ @@ -6087,7 +6155,7 @@ export namespace compute_v1 { /** * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. */ - xpnProjectStatus?: string; + xpnProjectStatus?: string | null; } export interface Schema$ProjectsDisableXpnResourceRequest { /** @@ -6105,11 +6173,11 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Service resources (a.k.a service projects) attached to this project as their shared VPC host. */ @@ -6119,13 +6187,13 @@ export namespace compute_v1 { /** * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. */ - organization?: string; + organization?: string | null; } export interface Schema$ProjectsSetDefaultNetworkTierRequest { /** * Default network tier to be set. */ - networkTier?: string; + networkTier?: string | null; } /** * A quotas entry. @@ -6134,19 +6202,19 @@ export namespace compute_v1 { /** * [Output Only] Quota limit for this metric. */ - limit?: number; + limit?: number | null; /** * [Output Only] Name of the quota metric. */ - metric?: string; + metric?: string | null; /** * [Output Only] Owning resource. This is the resource on which this quota is applied. */ - owner?: string; + owner?: string | null; /** * [Output Only] Current usage of this metric. */ - usage?: number; + usage?: number | null; } /** * Represents a reference to a resource. @@ -6155,19 +6223,19 @@ export namespace compute_v1 { /** * [Output Only] Type of the resource. Always compute#reference for references. */ - kind?: string; + kind?: string | null; /** * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF */ - referenceType?: string; + referenceType?: string | null; /** * URL of the resource which refers to the target. */ - referrer?: string; + referrer?: string | null; /** * URL of the resource to which this reference points. */ - target?: string; + target?: string | null; } /** * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) @@ -6176,7 +6244,7 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this region. */ @@ -6184,19 +6252,19 @@ export namespace compute_v1 { /** * [Output Only] Textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#region for regions. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Quotas assigned to this region. */ @@ -6204,15 +6272,15 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Status of the region, either UP or DOWN. */ - status?: string; + status?: string | null; /** * [Output Only] A list of zones available in this region, in the form of resource URLs. */ - zones?: string[]; + zones?: string[] | null; } /** * Contains a list of autoscalers. @@ -6221,7 +6289,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Autoscaler resources. */ @@ -6229,15 +6297,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6245,31 +6313,31 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RegionDisksAddResourcePoliciesRequest { /** * Resource policies to be added to this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$RegionDisksRemoveResourcePoliciesRequest { /** * Resource policies to be removed from this disk. */ - resourcePolicies?: string[]; + resourcePolicies?: string[] | null; } export interface Schema$RegionDisksResizeRequest { /** * The new size of the regional persistent disk, which is specified in GB. */ - sizeGb?: string; + sizeGb?: string | null; } export interface Schema$RegionDiskTypeList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of DiskType resources. */ @@ -6277,15 +6345,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6293,7 +6361,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of InstanceGroup resources. @@ -6302,7 +6370,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroup resources. */ @@ -6310,15 +6378,15 @@ export namespace compute_v1 { /** * The resource type. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6326,7 +6394,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of managed instance groups. @@ -6335,7 +6403,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceGroupManager resources. */ @@ -6343,15 +6411,15 @@ export namespace compute_v1 { /** * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6359,19 +6427,19 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } 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]. */ - instances?: string[]; + instances?: string[] | null; } 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$RegionInstanceGroupManagersListInstancesResponse { /** @@ -6383,29 +6451,29 @@ export namespace compute_v1 { /** * 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]. */ - instances?: string[]; + instances?: string[] | null; } export interface Schema$RegionInstanceGroupManagersSetTargetPoolsRequest { /** * Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional. */ - fingerprint?: string; + fingerprint?: string | null; /** * The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ - targetPools?: string[]; + targetPools?: string[] | null; } export interface Schema$RegionInstanceGroupManagersSetTemplateRequest { /** * URL of the InstanceTemplate resource from which all new instances will be created. */ - instanceTemplate?: string; + instanceTemplate?: string | null; } export interface Schema$RegionInstanceGroupsListInstances { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of InstanceWithNamedPorts resources. */ @@ -6413,15 +6481,15 @@ export namespace compute_v1 { /** * The resource type. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6429,23 +6497,23 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. */ - instanceState?: string; + instanceState?: string | null; /** * Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. */ - portName?: string; + portName?: string | null; } export interface Schema$RegionInstanceGroupsSetNamedPortsRequest { /** * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of named ports to set for this instance group. */ @@ -6458,7 +6526,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Region resources. */ @@ -6466,15 +6534,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#regionList for lists of regions. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6482,17 +6550,17 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RegionSetLabelsRequest { /** * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * The labels to set for this resource. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } export interface Schema$RegionSetPolicyRequest { /** @@ -6502,12 +6570,24 @@ export namespace compute_v1 { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } + export interface Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest { + /** + * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. + */ + sslCertificates?: string[] | null; + } + export interface Schema$RegionUrlMapsValidateRequest { + /** + * Content of the UrlMap to be validated. + */ + resource?: Schema$UrlMap; + } /** * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) */ @@ -6515,31 +6595,31 @@ export namespace compute_v1 { /** * [OutputOnly] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. */ - commitment?: string; + commitment?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#reservations for reservations. */ - kind?: string; + kind?: 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. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Reservation for instances with specific machine shapes. */ @@ -6547,15 +6627,15 @@ export namespace compute_v1 { /** * Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. */ - specificReservationRequired?: boolean; + specificReservationRequired?: boolean | null; /** * [Output Only] The status of the reservation. */ - status?: string; + status?: string | null; /** * Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. */ - zone?: string; + zone?: string | null; } /** * Specifies the reservations that this instance can consume from. @@ -6564,15 +6644,15 @@ export namespace compute_v1 { /** * Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. */ - consumeReservationType?: string; + consumeReservationType?: string | null; /** * Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */ - key?: string; + key?: string | null; /** * Corresponds to the label values of a reservation resource. */ - values?: string[]; + values?: string[] | null; } /** * Contains a list of reservations. @@ -6581,23 +6661,23 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Allocation resources. */ - items?: {[key: string]: Schema$ReservationsScopedList}; + items?: {[key: string]: Schema$ReservationsScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6605,13 +6685,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ReservationList { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of Allocation resources. */ @@ -6619,15 +6699,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource.Always compute#reservationsList for listsof reservations */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6635,13 +6715,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ReservationsResizeRequest { /** * Number of allocated resources can be resized with minimum = 1 and maximum = 1000. */ - specificSkuCount?: string; + specificSkuCount?: string | null; } export interface Schema$ReservationsScopedList { /** @@ -6655,7 +6735,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -6664,21 +6744,21 @@ export namespace compute_v1 { /** * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. */ - acceleratorType?: string; + acceleratorType?: string | null; /** * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. */ - amount?: string; + amount?: string | null; /** * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY */ - type?: string; + type?: string | null; } export interface Schema$ResourceGroupReference { /** * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. */ - group?: string; + group?: string | null; } export interface Schema$ResourcePoliciesScopedList { /** @@ -6692,31 +6772,31 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ResourcePolicy { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; - description?: string; + creationTimestamp?: string | null; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#resource_policies for resource policies. */ - kind?: string; + kind?: 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. */ - name?: string; - region?: string; + name?: string | null; + region?: string | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Resource policy for persistent disks for creating snapshots. */ @@ -6724,33 +6804,33 @@ export namespace compute_v1 { /** * [Output Only] The status of resource policy creation. */ - status?: string; + status?: string | null; } /** * Contains a list of resourcePolicies. */ export interface Schema$ResourcePolicyAggregatedList { - etag?: string; + etag?: string | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of ResourcePolicy resources. */ - items?: {[key: string]: Schema$ResourcePoliciesScopedList}; + items?: {[key: string]: Schema$ResourcePoliciesScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6758,7 +6838,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Time window specified for daily operations. @@ -6767,15 +6847,15 @@ export namespace compute_v1 { /** * Defines a schedule that runs every nth day of the month. */ - daysInCycle?: number; + daysInCycle?: number | null; /** * [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. */ - duration?: string; + duration?: string | null; /** * Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid. */ - startTime?: string; + startTime?: string | null; } /** * Time window specified for hourly operations. @@ -6784,22 +6864,22 @@ export namespace compute_v1 { /** * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ - duration?: string; + duration?: string | null; /** * Allows to define schedule that runs every nth hour. */ - hoursInCycle?: number; + hoursInCycle?: number | null; /** * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ - startTime?: string; + startTime?: string | null; } export interface Schema$ResourcePolicyList { - etag?: string; + etag?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of ResourcePolicy resources. */ @@ -6807,15 +6887,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -6823,7 +6903,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. @@ -6849,11 +6929,11 @@ export namespace compute_v1 { /** * Maximum age of the snapshot that is allowed to be kept. */ - maxRetentionDays?: number; + maxRetentionDays?: number | null; /** * Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. */ - onSourceDiskDelete?: string; + onSourceDiskDelete?: string | null; } /** * A schedule for disks where the schedueled operations are performed. @@ -6870,15 +6950,15 @@ export namespace compute_v1 { /** * Indication to perform a ?guest aware? snapshot. */ - guestFlush?: boolean; + guestFlush?: boolean | null; /** * Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). */ - storageLocations?: string[]; + storageLocations?: string[] | null; } /** * Time window specified for weekly operations. @@ -6893,15 +6973,15 @@ export namespace compute_v1 { /** * Allows to define schedule that runs specified day of the week. */ - day?: string; + day?: string | null; /** * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ - duration?: string; + duration?: string | null; /** * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ - startTime?: string; + startTime?: string | null; } /** * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) @@ -6910,67 +6990,67 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this field when you create the resource. */ - description?: string; + description?: string | null; /** * The destination range of outgoing packets that this route applies to. Only IPv4 is supported. */ - destRange?: string; + destRange?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of this resource. Always compute#routes for Route resources. */ - kind?: string; + 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?: string; + name?: string | null; /** * Fully-qualified URL of the network that this route applies to. */ - network?: string; + network?: string | null; /** * The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway */ - nextHopGateway?: string; + nextHopGateway?: string | null; /** * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ - nextHopInstance?: string; + nextHopInstance?: string | null; /** * The network IP address of an instance that should handle matching packets. Only IPv4 is supported. */ - nextHopIp?: string; + nextHopIp?: string | null; /** * The URL of the local network if it should handle matching packets. */ - nextHopNetwork?: string; + nextHopNetwork?: string | null; /** * [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. */ - nextHopPeering?: string; + nextHopPeering?: string | null; /** * The URL to a VpnTunnel that should handle matching packets. */ - nextHopVpnTunnel?: string; + nextHopVpnTunnel?: string | null; /** * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. */ - priority?: number; + priority?: number | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * A list of instance tags to which this route applies. */ - tags?: string[]; + tags?: string[] | null; /** * [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. */ @@ -6978,7 +7058,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * Contains a list of Route resources. @@ -6987,7 +7067,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Route resources. */ @@ -6995,15 +7075,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7011,7 +7091,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Cloud Router resource. For more information about Cloud Router, read the the Cloud Router overview. @@ -7028,15 +7108,15 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. */ @@ -7044,11 +7124,11 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#router for routers. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * A list of NAT services created in this router. */ @@ -7056,15 +7136,15 @@ export namespace compute_v1 { /** * URI of the network to which this router belongs. */ - network?: string; + network?: string | null; /** * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * Description-tagged IP ranges for the router to advertise. @@ -7073,11 +7153,11 @@ export namespace compute_v1 { /** * User-specified description for the IP range. */ - description?: string; + description?: string | null; /** * The IP range to advertise. The value must be a CIDR-formatted string. */ - range?: string; + range?: string | null; } /** * Contains a list of routers. @@ -7086,23 +7166,23 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Router resources. */ - items?: {[key: string]: Schema$RoutersScopedList}; + items?: {[key: string]: Schema$RoutersScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7110,13 +7190,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RouterBgp { /** * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ - advertisedGroups?: string[]; + advertisedGroups?: string[] | null; /** * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ @@ -7124,17 +7204,17 @@ export namespace compute_v1 { /** * User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. */ - advertiseMode?: string; + advertiseMode?: string | null; /** * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN. */ - asn?: number; + asn?: number | null; } export interface Schema$RouterBgpPeer { /** * User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ - advertisedGroups?: string[]; + advertisedGroups?: string[] | null; /** * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ @@ -7142,57 +7222,57 @@ export namespace compute_v1 { /** * The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. */ - advertisedRoutePriority?: number; + advertisedRoutePriority?: number | null; /** * User-specified flag to indicate which mode to use for advertisement. */ - advertiseMode?: string; + advertiseMode?: string | null; /** * Name of the interface the BGP peer is associated with. */ - interfaceName?: string; + interfaceName?: string | null; /** * IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. */ - ipAddress?: string; + ipAddress?: string | null; /** * [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ - managementType?: string; + managementType?: string | null; /** * Name of this BGP peer. 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; + name?: string | null; /** * Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. */ - peerAsn?: number; + peerAsn?: number | null; /** * IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. */ - peerIpAddress?: string; + peerIpAddress?: string | null; } export interface Schema$RouterInterface { /** * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ - ipRange?: string; + ipRange?: string | null; /** * URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be either be a VPN tunnel or an Interconnect attachment. */ - linkedInterconnectAttachment?: string; + linkedInterconnectAttachment?: string | null; /** * URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be either a VPN tunnel or an Interconnect attachment. */ - linkedVpnTunnel?: string; + linkedVpnTunnel?: string | null; /** * [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ - managementType?: string; + managementType?: string | null; /** * Name of this interface entry. 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; + name?: string | null; } /** * Contains a list of Router resources. @@ -7201,7 +7281,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Router resources. */ @@ -7209,15 +7289,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#router for routers. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7225,7 +7305,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided. @@ -7234,7 +7314,7 @@ export namespace compute_v1 { /** * Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. */ - icmpIdleTimeoutSec?: number; + icmpIdleTimeoutSec?: number | null; /** * Configure logging on this NAT. */ @@ -7242,23 +7322,23 @@ export namespace compute_v1 { /** * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM. */ - minPortsPerVm?: number; + minPortsPerVm?: number | null; /** * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. */ - name?: string; + name?: string | null; /** * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. */ - natIpAllocateOption?: string; + natIpAllocateOption?: string | null; /** * A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project. */ - natIps?: string[]; + natIps?: string[] | null; /** * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ - sourceSubnetworkIpRangesToNat?: string; + sourceSubnetworkIpRangesToNat?: string | null; /** * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. */ @@ -7266,15 +7346,15 @@ export namespace compute_v1 { /** * Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. */ - tcpEstablishedIdleTimeoutSec?: number; + tcpEstablishedIdleTimeoutSec?: number | null; /** * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. */ - tcpTransitoryIdleTimeoutSec?: number; + tcpTransitoryIdleTimeoutSec?: number | null; /** * Timeout (in seconds) for UDP connections. Defaults to 30s if not set. */ - udpIdleTimeoutSec?: number; + udpIdleTimeoutSec?: number | null; } /** * Configuration of logging on a NAT. @@ -7283,11 +7363,11 @@ export namespace compute_v1 { /** * Indicates whether or not to export logs. This is false by default. */ - enable?: boolean; + enable?: boolean | null; /** * Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. */ - filter?: string; + filter?: string | null; } /** * Defines the IP ranges that want to use NAT for a subnetwork. @@ -7296,15 +7376,15 @@ export namespace compute_v1 { /** * URL for the subnetwork resource that will use NAT. */ - name?: string; + name?: string | null; /** * A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat. */ - secondaryIpRangeNames?: string[]; + secondaryIpRangeNames?: string[] | null; /** * Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ - sourceIpRangesToNat?: string[]; + sourceIpRangesToNat?: string[] | null; } export interface Schema$RoutersPreviewResponse { /** @@ -7324,7 +7404,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$RouterStatus { /** @@ -7340,7 +7420,7 @@ export namespace compute_v1 { /** * URI of the network to which this router belongs. */ - network?: string; + network?: string | null; } export interface Schema$RouterStatusBgpPeerStatus { /** @@ -7350,39 +7430,39 @@ export namespace compute_v1 { /** * IP address of the local BGP interface. */ - ipAddress?: string; + ipAddress?: string | null; /** * URL of the VPN tunnel that this BGP peer controls. */ - linkedVpnTunnel?: string; + linkedVpnTunnel?: string | null; /** * Name of this BGP peer. Unique within the Routers resource. */ - name?: string; + name?: string | null; /** * Number of routes learned from the remote BGP Peer. */ - numLearnedRoutes?: number; + numLearnedRoutes?: number | null; /** * IP address of the remote BGP interface. */ - peerIpAddress?: string; + peerIpAddress?: string | null; /** * BGP state as specified in RFC1771. */ - state?: string; + state?: string | null; /** * Status of the BGP peer: {UP, DOWN} */ - status?: string; + status?: string | null; /** * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds */ - uptime?: string; + uptime?: string | null; /** * Time this session has been up, in seconds. Format: 145 */ - uptimeSeconds?: string; + uptimeSeconds?: string | null; } /** * Status of a NAT contained in this router. Next tag: 9 @@ -7391,33 +7471,33 @@ export namespace compute_v1 { /** * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] */ - autoAllocatedNatIps?: string[]; + autoAllocatedNatIps?: string[] | null; /** * The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. */ - minExtraNatIpsNeeded?: number; + minExtraNatIpsNeeded?: number | null; /** * Unique name of this NAT. */ - name?: string; + name?: string | null; /** * Number of VM endpoints (i.e., Nics) that can use NAT. */ - numVmEndpointsWithNatMappings?: number; + numVmEndpointsWithNatMappings?: number | null; /** * A list of fully qualified URLs of reserved IP address resources. */ - userAllocatedNatIpResources?: string[]; + userAllocatedNatIpResources?: string[] | null; /** * A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133". */ - userAllocatedNatIps?: string[]; + userAllocatedNatIps?: string[] | null; } export interface Schema$RouterStatusResponse { /** * Type of resource. */ - kind?: string; + kind?: string | null; result?: Schema$RouterStatus; } /** @@ -7427,7 +7507,7 @@ export namespace compute_v1 { /** * Required */ - action?: string; + action?: string | null; /** * Additional restrictions that must be met. All conditions must pass for the rule to match. */ @@ -7435,11 +7515,11 @@ export namespace compute_v1 { /** * Human-readable description of the rule. */ - description?: string; + description?: string | null; /** * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ - ins?: string[]; + ins?: string[] | null; /** * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ @@ -7447,11 +7527,11 @@ export namespace compute_v1 { /** * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ - notIns?: string[]; + notIns?: string[] | null; /** * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Sets the scheduling options for an Instance. NextID: 9 @@ -7460,7 +7540,7 @@ export namespace compute_v1 { /** * 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; + automaticRestart?: boolean | null; /** * A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. */ @@ -7468,11 +7548,11 @@ export namespace compute_v1 { /** * Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. */ - onHostMaintenance?: string; + onHostMaintenance?: string | null; /** * Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. */ - preemptible?: boolean; + preemptible?: boolean | null; } /** * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. @@ -7481,15 +7561,15 @@ export namespace compute_v1 { /** * Corresponds to the label key of Node resource. */ - key?: string; + key?: string | null; /** * Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. */ - operator?: string; + operator?: string | null; /** * Corresponds to the label values of Node resource. */ - values?: string[]; + values?: string[] | null; } /** * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) @@ -7498,27 +7578,27 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output only] Type of the resource. Always compute#securityPolicyfor security policies */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. */ @@ -7526,13 +7606,13 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$SecurityPolicyList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SecurityPolicy resources. */ @@ -7540,11 +7620,11 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Informational warning message. */ @@ -7552,10 +7632,10 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$SecurityPolicyReference { - securityPolicy?: string; + securityPolicy?: string | null; } /** * Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). @@ -7564,15 +7644,15 @@ export namespace compute_v1 { /** * The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. */ - action?: string; + action?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules */ - kind?: string; + kind?: string | null; /** * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. */ @@ -7580,11 +7660,11 @@ export namespace compute_v1 { /** * If set to true, the specified action is not enforced. */ - preview?: boolean; + preview?: boolean | null; /** * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. */ - priority?: number; + priority?: number | null; } /** * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. @@ -7597,13 +7677,13 @@ export namespace compute_v1 { /** * Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. */ - versionedExpr?: string; + versionedExpr?: string | null; } export interface Schema$SecurityPolicyRuleMatcherConfig { /** * CIDR IP address range. */ - srcIpRanges?: string[]; + srcIpRanges?: string[] | null; } /** * An instance's serial console output. @@ -7612,26 +7692,26 @@ export namespace compute_v1 { /** * [Output Only] The contents of the console output. */ - contents?: string; + contents?: string | null; /** * [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. */ - kind?: string; + kind?: string | null; /** * [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter. */ - next?: string; + next?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched. */ - start?: string; + start?: string | null; } export interface Schema$ServerBinding { - type?: string; + type?: string | null; } /** * A service account. @@ -7640,11 +7720,11 @@ export namespace compute_v1 { /** * Email address of the service account. */ - email?: string; + email?: string | null; /** * The list of scopes to be made available for this service account. */ - scopes?: string[]; + scopes?: string[] | null; } /** * A set of Shielded Instance options. @@ -7653,15 +7733,15 @@ export namespace compute_v1 { /** * Defines whether the instance has integrity monitoring enabled. */ - enableIntegrityMonitoring?: boolean; + enableIntegrityMonitoring?: boolean | null; /** * Defines whether the instance has Secure Boot enabled. */ - enableSecureBoot?: boolean; + enableSecureBoot?: boolean | null; /** * Defines whether the instance has the vTPM enabled. */ - enableVtpm?: boolean; + enableVtpm?: boolean | null; } /** * A shielded Instance identity entry. @@ -7674,7 +7754,7 @@ export namespace compute_v1 { /** * [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. */ - kind?: string; + kind?: string | null; /** * An Attestation Key (AK) issued to the Shielded Instance's vTPM. */ @@ -7687,11 +7767,11 @@ export namespace compute_v1 { /** * A PEM-encoded X.509 certificate. This field can be empty. */ - ekCert?: string; + ekCert?: string | null; /** * A PEM-encoded public key. */ - ekPub?: string; + ekPub?: string | null; } /** * The policy describes the baseline against which Instance boot integrity is measured. @@ -7700,7 +7780,7 @@ export namespace compute_v1 { /** * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ - updateAutoLearnPolicy?: boolean; + updateAutoLearnPolicy?: boolean | null; } /** * Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs @@ -7709,11 +7789,11 @@ export namespace compute_v1 { /** * Name of the key. 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. */ - keyName?: string; + keyName?: string | null; /** * 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. */ - keyValue?: string; + keyValue?: string | null; } /** * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) @@ -7722,51 +7802,51 @@ export namespace compute_v1 { /** * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. */ - autoCreated?: boolean; + autoCreated?: boolean | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] Size of the snapshot, specified in GB. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * [Output Only] Integer license codes indicating which licenses are attached to this snapshot. */ - licenseCodes?: string[]; + licenseCodes?: string[] | null; /** * [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). */ - licenses?: string[]; + licenses?: string[] | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ @@ -7774,7 +7854,7 @@ export namespace compute_v1 { /** * [Output Only] The source disk used to create this snapshot. */ - sourceDisk?: string; + sourceDisk?: string | null; /** * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ @@ -7782,23 +7862,23 @@ export namespace compute_v1 { /** * [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. */ - sourceDiskId?: string; + sourceDiskId?: string | null; /** * [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. */ - status?: string; + status?: string | null; /** * [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. */ - storageBytes?: string; + 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; + storageBytesStatus?: string | null; /** * Cloud Storage bucket storage location of the snapshot (regional or multi-regional). */ - storageLocations?: string[]; + storageLocations?: string[] | null; } /** * Contains a list of Snapshot resources. @@ -7807,7 +7887,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Snapshot resources. */ @@ -7815,15 +7895,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7831,7 +7911,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * A specification of the parameters to use when creating the instance template from a source instance. @@ -7849,35 +7929,69 @@ export namespace compute_v1 { /** * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ - certificate?: string; + certificate?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * A write-only private key in PEM format. Only insert requests will include this field. */ - privateKey?: string; + privateKey?: string | null; + /** + * [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. + */ + region?: string | null; /** * [Output only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; + } + export interface Schema$SslCertificateAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SslCertificatesScopedList resources. + */ + items?: {[key: string]: Schema$SslCertificatesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates. + */ + 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; } /** * Contains a list of SslCertificate resources. @@ -7886,7 +8000,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SslCertificate resources. */ @@ -7894,15 +8008,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7910,39 +8024,53 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; + } + export interface Schema$SslCertificatesScopedList { + /** + * List of SslCertificates contained in this scope. + */ + sslCertificates?: Schema$SslCertificate[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; } export interface Schema$SSLHealthCheck { /** * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ - request?: string; + request?: string | null; /** * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } export interface Schema$SslPoliciesList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SslPolicy resources. */ @@ -7950,15 +8078,15 @@ export namespace compute_v1 { /** * [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -7966,10 +8094,10 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$SslPoliciesListAvailableFeaturesResponse { - features?: string[]; + features?: string[] | null; } /** * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) @@ -7978,47 +8106,47 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * A list of features enabled when the selected profile is CUSTOM. The - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. */ - customFeatures?: string[]; + customFeatures?: string[] | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The list of features enabled in the SSL policy. */ - enabledFeatures?: string[]; + enabledFeatures?: string[] | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. */ - kind?: string; + kind?: string | null; /** * The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. */ - minTlsVersion?: string; + minTlsVersion?: string | null; /** * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. */ - profile?: string; + profile?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. */ @@ -8026,13 +8154,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } export interface Schema$SslPolicyReference { /** * URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. */ - sslPolicy?: string; + sslPolicy?: string | null; } /** * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) @@ -8041,35 +8169,35 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. */ - description?: string; + description?: string | null; /** * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ - enableFlowLogs?: boolean; + enableFlowLogs?: boolean | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. */ - fingerprint?: string; + fingerprint?: string | null; /** * [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. */ - gatewayAddress?: string; + gatewayAddress?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * 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; + ipCidrRange?: string | null; /** * [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. */ - kind?: string; + kind?: string | null; /** * This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver. */ @@ -8077,19 +8205,27 @@ export namespace compute_v1 { /** * The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. */ - network?: string; + network?: string | null; /** * 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; + privateIpGoogleAccess?: boolean | 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. + */ + purpose?: string | null; /** * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. */ - region?: string; + region?: string | null; + /** + * The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. + */ + role?: string | null; /** * An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. */ @@ -8097,29 +8233,33 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; + /** + * [Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY. + */ + state?: string | null; } export interface Schema$SubnetworkAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of SubnetworksScopedList resources. */ - items?: {[key: string]: Schema$SubnetworksScopedList}; + items?: {[key: string]: Schema$SubnetworksScopedList} | null; /** * [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8127,7 +8267,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of Subnetwork resources. @@ -8136,7 +8276,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Subnetwork resources. */ @@ -8144,15 +8284,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8160,7 +8300,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * The available logging options for this subnetwork. @@ -8169,19 +8309,19 @@ export namespace compute_v1 { /** * Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. */ - aggregationInterval?: string; + aggregationInterval?: string | null; /** * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ - enable?: boolean; + enable?: boolean | null; /** * Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5, which means half of all collected logs are reported. */ - flowSampling?: number; + flowSampling?: number | null; /** * Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. */ - metadata?: string; + metadata?: string | null; } /** * Represents a secondary IP range of a subnetwork. @@ -8190,17 +8330,17 @@ export namespace compute_v1 { /** * The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ - rangeName?: string; + rangeName?: string | null; } export interface Schema$SubnetworksExpandIpCidrRangeRequest { /** * The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. */ - ipCidrRange?: string; + ipCidrRange?: string | null; } export interface Schema$SubnetworksScopedList { /** @@ -8214,10 +8354,10 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { - privateIpGoogleAccess?: boolean; + privateIpGoogleAccess?: boolean | null; } /** * A set of instance tags. @@ -8226,11 +8366,25 @@ export namespace compute_v1 { /** * Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. */ - fingerprint?: string; + fingerprint?: string | null; /** * An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. */ - items?: string[]; + items?: string[] | null; + } + export interface Schema$TargetHttpProxiesScopedList { + /** + * A list of TargetHttpProxies contained in this scope. + */ + targetHttpProxies?: Schema$TargetHttpProxy[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | 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 ==) @@ -8239,31 +8393,57 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; + /** + * [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. + */ + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL to the UrlMap resource that defines the mapping from URL to the BackendService. */ - urlMap?: string; + urlMap?: string | null; + } + export interface Schema$TargetHttpProxyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetHttpProxiesScopedList resources. + */ + items?: {[key: string]: Schema$TargetHttpProxiesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. + */ + 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; } /** * A list of TargetHttpProxy resources. @@ -8272,7 +8452,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetHttpProxy resources. */ @@ -8280,15 +8460,15 @@ export namespace compute_v1 { /** * Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8296,19 +8476,33 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; + } + export interface Schema$TargetHttpsProxiesScopedList { + /** + * A list of TargetHttpsProxies contained in this scope. + */ + targetHttpsProxies?: Schema$TargetHttpsProxy[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; } export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { /** * QUIC policy for the TargetHttpsProxy resource. */ - quicOverride?: string; + quicOverride?: string | null; } export interface Schema$TargetHttpsProxiesSetSslCertificatesRequest { /** * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. */ - sslCertificates?: string[]; + 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 ==) @@ -8317,43 +8511,77 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. */ - quicOverride?: string; + quicOverride?: string | null; + /** + * [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. + */ + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ - sslCertificates?: string[]; + sslCertificates?: string[] | null; /** * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. */ - sslPolicy?: string; + sslPolicy?: string | null; /** * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map */ - urlMap?: string; + urlMap?: string | null; + } + export interface Schema$TargetHttpsProxyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of TargetHttpsProxiesScopedList resources. + */ + items?: {[key: string]: Schema$TargetHttpsProxiesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. + */ + 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; } /** * Contains a list of TargetHttpsProxy resources. @@ -8362,7 +8590,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetHttpsProxy resources. */ @@ -8370,15 +8598,15 @@ export namespace compute_v1 { /** * Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8386,7 +8614,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) @@ -8395,61 +8623,61 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ - instance?: string; + instance?: string | null; /** * [Output Only] The type of the resource. Always compute#targetInstance for target instances. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. */ - natPolicy?: string; + natPolicy?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } export interface Schema$TargetInstanceAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetInstance resources. */ - items?: {[key: string]: Schema$TargetInstancesScopedList}; + items?: {[key: string]: Schema$TargetInstancesScopedList} | null; /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8457,7 +8685,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of TargetInstance resources. @@ -8466,7 +8694,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetInstance resources. */ @@ -8474,15 +8702,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8490,7 +8718,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetInstancesScopedList { /** @@ -8504,7 +8732,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) @@ -8513,73 +8741,73 @@ export namespace compute_v1 { /** * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ - backupPool?: string; + backupPool?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ - failoverRatio?: number; + failoverRatio?: number | null; /** * The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. */ - healthChecks?: string[]; + healthChecks?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. */ - instances?: string[]; + instances?: string[] | null; /** * [Output Only] Type of the resource. Always compute#targetPool for target pools. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * [Output Only] URL of the region where the target pool resides. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. */ - sessionAffinity?: string; + sessionAffinity?: string | null; } export interface Schema$TargetPoolAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetPool resources. */ - items?: {[key: string]: Schema$TargetPoolsScopedList}; + items?: {[key: string]: Schema$TargetPoolsScopedList} | null; /** * [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8587,14 +8815,14 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; /** * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. */ - kind?: string; + kind?: string | null; } /** * Contains a list of TargetPool resources. @@ -8603,7 +8831,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetPool resources. */ @@ -8611,15 +8839,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8627,7 +8855,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetPoolsAddHealthCheckRequest { /** @@ -8665,28 +8893,28 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetReference { - target?: string; + target?: string | null; } export interface Schema$TargetSslProxiesSetBackendServiceRequest { /** * The URL of the new BackendService resource for the targetSslProxy. */ - service?: string; + service?: string | null; } export interface Schema$TargetSslProxiesSetProxyHeaderRequest { /** * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ - proxyHeader?: string; + proxyHeader?: string | null; } export interface Schema$TargetSslProxiesSetSslCertificatesRequest { /** * New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. */ - sslCertificates?: string[]; + sslCertificates?: string[] | null; } /** * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) @@ -8695,43 +8923,43 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL to the BackendService resource. */ - service?: string; + service?: string | null; /** * URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ - sslCertificates?: string[]; + sslCertificates?: string[] | null; /** * URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. */ - sslPolicy?: string; + sslPolicy?: string | null; } /** * Contains a list of TargetSslProxy resources. @@ -8740,7 +8968,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetSslProxy resources. */ @@ -8748,15 +8976,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8764,56 +8992,56 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetTcpProxiesSetBackendServiceRequest { /** * The URL of the new BackendService resource for the targetTcpProxy. */ - service?: string; + service?: string | null; } export interface Schema$TargetTcpProxiesSetProxyHeaderRequest { /** * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ - proxyHeader?: string; + proxyHeader?: string | null; } /** - * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference ta target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * URL to the BackendService resource. */ - service?: string; + service?: string | null; } /** * Contains a list of TargetTcpProxy resources. @@ -8822,7 +9050,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetTcpProxy resources. */ @@ -8830,15 +9058,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8846,7 +9074,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) @@ -8855,69 +9083,69 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. */ - forwardingRules?: string[]; + forwardingRules?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ - network?: string; + network?: string | null; /** * [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. */ - status?: string; + status?: string | null; /** * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. */ - tunnels?: string[]; + tunnels?: string[] | null; } export interface Schema$TargetVpnGatewayAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetVpnGateway resources. */ - items?: {[key: string]: Schema$TargetVpnGatewaysScopedList}; + items?: {[key: string]: Schema$TargetVpnGatewaysScopedList} | null; /** * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8925,7 +9153,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of TargetVpnGateway resources. @@ -8934,7 +9162,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of TargetVpnGateway resources. */ @@ -8942,15 +9170,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -8958,7 +9186,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TargetVpnGatewaysScopedList { /** @@ -8972,51 +9200,51 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$TCPHealthCheck { /** * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ - port?: number; + port?: number | null; /** * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ - portName?: string; + portName?: string | null; /** * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. */ - portSpecification?: string; + portSpecification?: string | null; /** * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ - proxyHeader?: string; + proxyHeader?: string | null; /** * The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ - request?: string; + request?: string | null; /** * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ - response?: string; + response?: string | null; } export interface Schema$TestFailure { - actualService?: string; - expectedService?: string; - host?: string; - path?: string; + actualService?: string | null; + expectedService?: string | null; + host?: string | null; + path?: string | null; } export interface Schema$TestPermissionsRequest { /** * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export interface Schema$TestPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. @@ -9025,19 +9253,19 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. */ - defaultService?: string; + defaultService?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. */ - fingerprint?: string; + fingerprint?: string | null; /** * The list of HostRules to use against the URL. */ @@ -9045,23 +9273,27 @@ export namespace compute_v1 { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#urlMaps for url maps. */ - kind?: string; + kind?: string | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * The list of named PathMatchers to use against the URL. */ pathMatchers?: Schema$PathMatcher[]; + /** + * [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. */ @@ -9074,7 +9306,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of UrlMap resources. */ @@ -9082,15 +9314,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9098,10 +9330,54 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$UrlMapReference { - urlMap?: string; + urlMap?: string | null; + } + export interface Schema$UrlMapsAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of UrlMapsScopedList resources. + */ + items?: {[key: string]: Schema$UrlMapsScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$UrlMapsScopedList { + /** + * A list of UrlMaps contained in this scope. + */ + urlMaps?: Schema$UrlMap[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; } export interface Schema$UrlMapsValidateRequest { /** @@ -9119,34 +9395,34 @@ export namespace compute_v1 { /** * Description of this test case. */ - description?: string; + description?: string | null; /** * Host portion of the URL. */ - host?: string; + host?: string | null; /** * Path portion of the URL. */ - path?: string; + path?: string | null; /** * Expected BackendService resource the given URL should be mapped to. */ - service?: string; + service?: string | null; } /** * Message representing the validation result for a UrlMap. */ export interface Schema$UrlMapValidationResult { - loadErrors?: string[]; + loadErrors?: string[] | null; /** * Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons. */ - loadSucceeded?: boolean; + loadSucceeded?: boolean | null; testFailures?: Schema$TestFailure[]; /** * If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure. */ - testPassed?: boolean; + testPassed?: boolean | null; } /** * Subnetwork which the current user has compute.subnetworks.use permission on. @@ -9155,11 +9431,11 @@ export namespace compute_v1 { /** * The range of internal addresses that are owned by this subnetwork. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Network URL. */ - network?: string; + network?: string | null; /** * Secondary IP ranges. */ @@ -9167,13 +9443,13 @@ export namespace compute_v1 { /** * Subnetwork URL. */ - subnetwork?: string; + subnetwork?: string | null; } export interface Schema$UsableSubnetworksAggregatedList { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output] A list of usable subnetwork URLs. */ @@ -9181,15 +9457,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9197,7 +9473,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Secondary IP range of a usable subnetwork. @@ -9206,11 +9482,11 @@ export namespace compute_v1 { /** * The range of IP addresses belonging to this subnetwork secondary range. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ - rangeName?: string; + rangeName?: string | null; } /** * The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. @@ -9219,11 +9495,11 @@ export namespace compute_v1 { /** * The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. */ - bucketName?: string; + bucketName?: string | null; /** * An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. */ - reportNamePrefix?: string; + reportNamePrefix?: string | null; } /** * Contain information of Nat mapping for a VM endpoint (i.e., NIC). @@ -9232,7 +9508,7 @@ export namespace compute_v1 { /** * Name of the VM instance which the endpoint belongs to */ - instanceName?: string; + instanceName?: string | null; interfaceNatMappings?: Schema$VmEndpointNatMappingsInterfaceNatMappings[]; } /** @@ -9242,19 +9518,19 @@ export namespace compute_v1 { /** * A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ - natIpPortRanges?: string[]; + natIpPortRanges?: string[] | null; /** * Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. */ - numTotalNatPorts?: number; + numTotalNatPorts?: number | null; /** * Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". */ - sourceAliasIpRange?: string; + sourceAliasIpRange?: string | null; /** * Primary IP of the VM for this NIC. */ - sourceVirtualIp?: string; + sourceVirtualIp?: string | null; } /** * Contains a list of VmEndpointNatMappings. @@ -9263,15 +9539,15 @@ export namespace compute_v1 { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] A list of Nat mapping information of VM endpoints. */ @@ -9279,7 +9555,7 @@ export namespace compute_v1 { /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9287,7 +9563,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Represents a VPN gateway resource. @@ -9296,43 +9572,43 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ - kind?: string; + kind?: string | null; /** * A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an VpnGateway. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ - network?: string; + network?: string | null; /** * [Output Only] URL of the region where the VPN gateway resides. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] A list of interfaces on this VPN gateway. */ @@ -9342,23 +9618,23 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnGateway resources. */ - items?: {[key: string]: Schema$VpnGatewaysScopedList}; + items?: {[key: string]: Schema$VpnGatewaysScopedList} | null; /** * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9366,7 +9642,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of VpnGateway resources. @@ -9375,7 +9651,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnGateway resources. */ @@ -9383,15 +9659,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9399,7 +9675,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$VpnGatewaysGetStatusResponse { result?: Schema$VpnGatewayStatus; @@ -9416,7 +9692,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$VpnGatewayStatus { /** @@ -9431,11 +9707,11 @@ export namespace compute_v1 { /** * Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. */ - state?: string; + state?: string | null; /** * Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. */ - unsatisfiedReason?: string; + unsatisfiedReason?: string | null; } /** * Contains some information about a VPN tunnel. @@ -9444,15 +9720,15 @@ export namespace compute_v1 { /** * The VPN gateway interface this VPN tunnel is associated with. */ - localGatewayInterface?: number; + localGatewayInterface?: number | null; /** * The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway. */ - peerGatewayInterface?: number; + peerGatewayInterface?: number | null; /** * URL reference to the VPN tunnel. */ - tunnelUrl?: string; + tunnelUrl?: string | null; } /** * A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway. @@ -9461,11 +9737,11 @@ export namespace compute_v1 { /** * URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ - peerExternalGateway?: string; + peerExternalGateway?: string | null; /** * URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ - peerGcpGateway?: string; + peerGcpGateway?: string | null; /** * HighAvailabilityRequirementState for the VPN connection. */ @@ -9482,11 +9758,11 @@ export namespace compute_v1 { /** * The numeric ID of this VPN gateway interface. */ - id?: number; + id?: number | null; /** * The external IP address for this VPN gateway interface. */ - ipAddress?: string; + ipAddress?: string | null; } /** * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) @@ -9495,113 +9771,113 @@ export namespace compute_v1 { /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ - description?: string; + description?: string | null; /** * [Output Only] Detailed status message for the VPN tunnel. */ - detailedStatus?: string; + detailedStatus?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. */ - ikeVersion?: number; + ikeVersion?: number | null; /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ - kind?: string; + kind?: string | null; /** * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. */ - localTrafficSelector?: string[]; + localTrafficSelector?: string[] | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. */ - peerExternalGateway?: string; + peerExternalGateway?: string | null; /** * The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. */ - peerExternalGatewayInterface?: number; + peerExternalGatewayInterface?: number | null; /** * URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. */ - peerGcpGateway?: string; + peerGcpGateway?: string | null; /** * IP address of the peer VPN gateway. Only IPv4 is supported. */ - peerIp?: string; + peerIp?: string | null; /** * [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. */ - remoteTrafficSelector?: string[]; + remoteTrafficSelector?: string[] | null; /** * URL of the router resource to be used for dynamic routing. */ - router?: string; + router?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. */ - sharedSecret?: string; + sharedSecret?: string | null; /** * Hash of the shared secret. */ - sharedSecretHash?: string; + sharedSecretHash?: string | null; /** * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. */ - status?: string; + status?: string | null; /** * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. */ - targetVpnGateway?: string; + targetVpnGateway?: string | null; /** * URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. */ - vpnGateway?: string; + vpnGateway?: string | null; /** * The interface ID of the VPN gateway with which this VPN tunnel is associated. */ - vpnGatewayInterface?: number; + vpnGatewayInterface?: number | null; } export interface Schema$VpnTunnelAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnTunnelsScopedList resources. */ - items?: {[key: string]: Schema$VpnTunnelsScopedList}; + items?: {[key: string]: Schema$VpnTunnelsScopedList} | null; /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9609,7 +9885,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Contains a list of VpnTunnel resources. @@ -9618,7 +9894,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of VpnTunnel resources. */ @@ -9626,15 +9902,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9642,7 +9918,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$VpnTunnelsScopedList { /** @@ -9656,13 +9932,13 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$XpnHostList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] A list of shared VPC host project URLs. */ @@ -9670,15 +9946,15 @@ export namespace compute_v1 { /** * [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9686,7 +9962,7 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } /** * Service resource (a.k.a service project) ID. @@ -9695,11 +9971,11 @@ export namespace compute_v1 { /** * The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). */ - id?: string; + id?: string | null; /** * The type of the service resource. */ - type?: string; + type?: string | null; } /** * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) @@ -9708,11 +9984,11 @@ export namespace compute_v1 { /** * [Output Only] Available cpu/platform selections for the zone. */ - availableCpuPlatforms?: string[]; + availableCpuPlatforms?: string[] | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] The deprecation status associated with this zone. */ @@ -9720,31 +9996,31 @@ export namespace compute_v1 { /** * [Output Only] Textual description of the resource. */ - description?: string; + description?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] Type of the resource. Always compute#zone for zones. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] Full URL reference to the region which hosts the zone. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Status of the zone, either UP or DOWN. */ - status?: string; + status?: string | null; } /** * Contains a list of zone resources. @@ -9753,7 +10029,7 @@ export namespace compute_v1 { /** * [Output Only] Unique identifier for the resource; defined by the server. */ - id?: string; + id?: string | null; /** * A list of Zone resources. */ @@ -9761,15 +10037,15 @@ export namespace compute_v1 { /** * Type of resource. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * [Output Only] Server-defined URL for this resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Informational warning message. */ @@ -9777,17 +10053,17 @@ export namespace compute_v1 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }; + } | null; } export interface Schema$ZoneSetLabelsRequest { /** * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * The labels to set for this resource. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } export interface Schema$ZoneSetPolicyRequest { /** @@ -9797,7 +10073,7 @@ export namespace compute_v1 { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -21897,102 +22173,55 @@ export namespace compute_v1 { } /** - * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. - * @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. - * - * // Name of the HealthCheck resource to delete. - * healthCheck: 'my-health-check', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.healthChecks.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.healthChecks.delete + * compute.healthChecks.aggregatedList + * @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.healthCheck Name of the HealthCheck resource to delete. - * @param {string} params.project Project ID for this request. - * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string=} params.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 Name of the project 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 */ - delete( - params?: Params$Resource$Healthchecks$Delete, + aggregatedList( + params?: Params$Resource$Healthchecks$Aggregatedlist, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Healthchecks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Healthchecks$Delete, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Healthchecks$Delete - | BodyResponseCallback, + | Params$Resource$Healthchecks$Aggregatedlist + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Delete; + {}) as Params$Resource$Healthchecks$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Delete; + params = {} as Params$Resource$Healthchecks$Aggregatedlist; options = {}; } @@ -22006,28 +22235,30 @@ export namespace compute_v1 { options: Object.assign( { url: ( - rootUrl + - '/compute/v1/projects/{project}/global/healthChecks/{healthCheck}' + rootUrl + '/compute/v1/projects/{project}/aggregated/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * compute.healthChecks.delete + * @desc Deletes the specified HealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -22051,13 +22282,13 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the HealthCheck resource to return. + * // Name of the HealthCheck resource to delete. * healthCheck: 'my-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.healthChecks.get(request, function(err, response) { + * compute.healthChecks.delete(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -22081,45 +22312,47 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.healthChecks.get + * @alias compute.healthChecks.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.healthCheck Name of the HealthCheck resource to return. + * @param {string} params.healthCheck Name of the HealthCheck resource to delete. * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Healthchecks$Get, + delete( + params?: Params$Resource$Healthchecks$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Healthchecks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Healthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Healthchecks$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Healthchecks$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Healthchecks$Get - | BodyResponseCallback, + | Params$Resource$Healthchecks$Delete + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Healthchecks$Get; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Get; + params = {} as Params$Resource$Healthchecks$Delete; options = {}; } @@ -22136,7 +22369,7 @@ export namespace compute_v1 { rootUrl + '/compute/v1/projects/{project}/global/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), @@ -22146,15 +22379,15 @@ export namespace compute_v1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * compute.healthChecks.get + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -22178,14 +22411,141 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * resource: { - * // TODO: Add desired properties to the request body. - * }, + * // Name of the HealthCheck resource to return. + * healthCheck: 'my-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.healthChecks.insert(request, function(err, response) { + * compute.healthChecks.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.healthChecks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck 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 + */ + get( + params?: Params$Resource$Healthchecks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Healthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Healthchecks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Healthchecks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Healthchecks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.insert + * @desc Creates a HealthCheck resource in the specified project using the data included in the 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. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.healthChecks.insert(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -22692,6 +23052,34 @@ export namespace compute_v1 { } } + export interface Params$Resource$Healthchecks$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Healthchecks$Delete extends StandardParameters { /** @@ -50234,105 +50622,44 @@ export namespace compute_v1 { region?: string; } - export class Resource$Regioninstancegroupmanagers { + export class Resource$Regionhealthchecks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. - * @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. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // 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.regionInstanceGroupManagers.abandonInstances(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.abandonInstances + * compute.regionHealthChecks.delete + * @desc Deletes the specified HealthCheck resource. + * @alias compute.regionHealthChecks.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. + * @param {string} params.healthCheck Name of the HealthCheck resource to delete. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {().RegionInstanceGroupManagersAbandonInstancesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - abandonInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + delete( + params?: Params$Resource$Regionhealthchecks$Delete, options?: MethodOptions ): GaxiosPromise; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + delete( + params: Params$Resource$Regionhealthchecks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + delete( + params: Params$Resource$Regionhealthchecks$Delete, callback: BodyResponseCallback ): void; - abandonInstances(callback: BodyResponseCallback): void; - abandonInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Abandoninstances + | Params$Resource$Regionhealthchecks$Delete | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -50340,12 +50667,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + {}) as Params$Resource$Regionhealthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + params = {} as Params$Resource$Regionhealthchecks$Delete; options = {}; } @@ -50360,15 +50687,15 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' + '/compute/v1/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -50379,106 +50706,49 @@ export namespace compute_v1 { } /** - * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. - * @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. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroupManagers.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.regionInstanceGroupManagers.delete + * compute.regionHealthChecks.get + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @alias compute.regionHealthChecks.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group to delete. + * @param {string} params.healthCheck Name of the HealthCheck resource to return. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. - * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Regioninstancegroupmanagers$Delete, + get( + params?: Params$Resource$Regionhealthchecks$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Regionhealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Regionhealthchecks$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Delete - | BodyResponseCallback, + | Params$Resource$Regionhealthchecks$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Delete; + {}) as Params$Resource$Regionhealthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; + params = {} as Params$Resource$Regionhealthchecks$Get; options = {}; } @@ -50493,117 +50763,56 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/v1/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. - * @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. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // 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.regionInstanceGroupManagers.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.regionInstanceGroupManagers.deleteInstances + * compute.regionHealthChecks.insert + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.regionHealthChecks.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. * @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 {().RegionInstanceGroupManagersDeleteInstancesRequest} params.resource Request body data + * @param {().HealthCheck} params.resource Request body data * @param {object} [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$Regioninstancegroupmanagers$Deleteinstances, + insert( + params?: Params$Resource$Regionhealthchecks$Insert, options?: MethodOptions ): GaxiosPromise; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + insert( + params: Params$Resource$Regionhealthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + insert( + params: Params$Resource$Regionhealthchecks$Insert, callback: BodyResponseCallback ): void; - deleteInstances(callback: BodyResponseCallback): void; - deleteInstances( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Deleteinstances + | Params$Resource$Regionhealthchecks$Insert | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -50611,12 +50820,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + {}) as Params$Resource$Regionhealthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + params = {} as Params$Resource$Regionhealthchecks$Insert; options = {}; } @@ -50631,15 +50840,15 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + '/compute/v1/projects/{project}/regions/{region}/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -50650,107 +50859,52 @@ export namespace compute_v1 { } /** - * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. - * @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. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the managed instance group to return. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroupManagers.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroupManagers.get + * compute.regionHealthChecks.list + * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @alias compute.regionHealthChecks.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group to return. + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Regioninstancegroupmanagers$Get, + list( + params?: Params$Resource$Regionhealthchecks$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Regionhealthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + params: Params$Resource$Regionhealthchecks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Get - | BodyResponseCallback, + | Params$Resource$Regionhealthchecks$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Get; + {}) as Params$Resource$Regionhealthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Get; + params = {} as Params$Resource$Regionhealthchecks$List; options = {}; } @@ -50765,27 +50919,350 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/v1/projects/{project}/regions/{region}/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * 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. + * @alias compute.regionHealthChecks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheck} params.resource Request body data + * @param {object} [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$Regionhealthchecks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionhealthchecks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthchecks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthChecks.update + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.regionHealthChecks.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to update. + * @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 {().HealthCheck} params.resource Request body data + * @param {object} [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$Regionhealthchecks$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regionhealthchecks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regionhealthchecks$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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/v1/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionhealthchecks$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to delete. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionhealthchecks$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to return. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthchecks$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthchecks$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to patch. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to update. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } + + export class Resource$Regioninstancegroupmanagers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * @example * * // BEFORE RUNNING: * // --------------- @@ -50812,6 +51289,9 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * + * // Name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * * resource: { * // TODO: Add desired properties to the request body. * }, @@ -50819,7 +51299,7 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.insert(request, function(err, response) { + * compute.regionInstanceGroupManagers.abandonInstances(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -50843,35 +51323,36 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.insert + * @alias compute.regionInstanceGroupManagers.abandonInstances * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. * @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.resource Request body data + * @param {().RegionInstanceGroupManagersAbandonInstancesRequest} params.resource Request body data * @param {object} [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$Regioninstancegroupmanagers$Insert, + abandonInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options?: MethodOptions ): GaxiosPromise; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + abandonInstances(callback: BodyResponseCallback): void; + abandonInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Insert + | Params$Resource$Regioninstancegroupmanagers$Abandoninstances | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -50879,12 +51360,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Insert; + {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; + params = {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; options = {}; } @@ -50899,15 +51380,15 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -50918,8 +51399,8 @@ export namespace compute_v1 { } /** - * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. + * compute.regionInstanceGroupManagers.delete + * @desc Deletes the specified managed instance group and all of the instances in that group. * @example * * // BEFORE RUNNING: * // --------------- @@ -50946,31 +51427,21 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * + * // Name of the managed instance group to delete. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * * auth: authClient, * }; * - * var handlePage = function(err, response) { + * compute.regionInstanceGroupManagers.delete(request, function(err, response) { * if (err) { * console.error(err); * return; * } * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regionInstanceGroupManagers.list(request, handlePage); - * } - * }; - * - * compute.regionInstanceGroupManagers.list(request, handlePage); + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); * }); * * function authorize(callback) { @@ -50986,54 +51457,48 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.list + * @alias compute.regionInstanceGroupManagers.delete * @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.instanceGroupManager Name of the managed instance group to delete. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Regioninstancegroupmanagers$List, + delete( + params?: Params$Resource$Regioninstancegroupmanagers$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$List - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$Delete + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$List; + {}) as Params$Resource$Regioninstancegroupmanagers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$List; + params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; options = {}; } @@ -51048,32 +51513,27 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(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. + * 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. * @example * * // BEFORE RUNNING: * // --------------- @@ -51100,13 +51560,17 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // The name of the managed instance group. + * // 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.regionInstanceGroupManagers.listManagedInstances(request, function(err, response) { + * compute.regionInstanceGroupManagers.deleteInstances(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -51130,71 +51594,49 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.listManagedInstances + * @alias compute.regionInstanceGroupManagers.deleteInstances * @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 Name of the managed instance group. * @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 {().RegionInstanceGroupManagersDeleteInstancesRequest} params.resource Request body data * @param {object} [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, + deleteInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options?: MethodOptions - ): GaxiosPromise; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options: - | MethodOptions - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > + ): GaxiosPromise; + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > - ): void; - listManagedInstances( - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + callback: BodyResponseCallback ): void; - listManagedInstances( + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, + | Params$Resource$Regioninstancegroupmanagers$Deleteinstances + | 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$Deleteinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; options = {}; } @@ -51209,7 +51651,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -51221,62 +51663,114 @@ export namespace compute_v1 { 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. - * @alias compute.regionInstanceGroupManagers.patch + * compute.regionInstanceGroupManagers.get + * @desc Returns all of the details about the specified managed instance group. + * @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. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the managed instance group to return. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroupManagers.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the instance group manager. + * @param {string} params.instanceGroupManager Name of the managed instance group to return. * @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.resource Request body data * @param {object} [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, + get( + params?: Params$Resource$Regioninstancegroupmanagers$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Patch - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Patch; + {}) as Params$Resource$Regioninstancegroupmanagers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; + params = {} as Params$Resource$Regioninstancegroupmanagers$Get; options = {}; } @@ -51293,7 +51787,7 @@ export namespace compute_v1 { rootUrl + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', }, options ), @@ -51303,15 +51797,15 @@ export namespace compute_v1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * 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. * @example * * // BEFORE RUNNING: * // --------------- @@ -51338,9 +51832,6 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * * resource: { * // TODO: Add desired properties to the request body. * }, @@ -51348,7 +51839,7 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.recreateInstances(request, function(err, response) { + * compute.regionInstanceGroupManagers.insert(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -51372,36 +51863,35 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.recreateInstances + * @alias compute.regionInstanceGroupManagers.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. * @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 {().RegionInstanceGroupManagersRecreateRequest} params.resource Request body data + * @param {().InstanceGroupManager} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - recreateInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + insert( + params?: Params$Resource$Regioninstancegroupmanagers$Insert, options?: MethodOptions ): GaxiosPromise; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, callback: BodyResponseCallback ): void; - recreateInstances(callback: BodyResponseCallback): void; - recreateInstances( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Recreateinstances + | Params$Resource$Regioninstancegroupmanagers$Insert | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -51409,12 +51899,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; options = {}; } @@ -51429,15 +51919,15 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -51448,8 +51938,8 @@ 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. + * compute.regionInstanceGroupManagers.list + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -51476,24 +51966,31 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * // Number of instances that should exist in this instance group manager. - * size: 0, // TODO: Update placeholder value. - * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.resize(request, function(err, response) { + * var handlePage = 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)); - * }); + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regionInstanceGroupManagers.list(request, handlePage); + * } + * }; + * + * compute.regionInstanceGroupManagers.list(request, handlePage); * }); * * function authorize(callback) { @@ -51509,49 +52006,54 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.resize + * @alias compute.regionInstanceGroupManagers.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. - * @param {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 {integer} params.size Number of instances that should exist in this instance group manager. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - resize( - params?: Params$Resource$Regioninstancegroupmanagers$Resize, + list( + params?: Params$Resource$Regioninstancegroupmanagers$List, options?: MethodOptions - ): GaxiosPromise; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resize - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + {}) as Params$Resource$Regioninstancegroupmanagers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + params = {} as Params$Resource$Regioninstancegroupmanagers$List; options = {}; } @@ -51566,27 +52068,32 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * 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. * @example * * // BEFORE RUNNING: * // --------------- @@ -51616,14 +52123,10 @@ export namespace compute_v1 { * // 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.regionInstanceGroupManagers.setInstanceTemplate(request, function(err, response) { + * compute.regionInstanceGroupManagers.listManagedInstances(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -51647,36 +52150,140 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.setInstanceTemplate + * @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/v1/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.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. + * @alias compute.regionInstanceGroupManagers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @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 {().RegionInstanceGroupManagersSetTemplateRequest} params.resource Request body data + * @param {().InstanceGroupManager} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - setInstanceTemplate( - params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + patch( + params?: Params$Resource$Regioninstancegroupmanagers$Patch, options?: MethodOptions ): GaxiosPromise; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, callback: BodyResponseCallback ): void; - setInstanceTemplate(callback: BodyResponseCallback): void; - setInstanceTemplate( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + | Params$Resource$Regioninstancegroupmanagers$Patch | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -51684,12 +52291,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + {}) as Params$Resource$Regioninstancegroupmanagers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; options = {}; } @@ -51704,9 +52311,9 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', }, options ), @@ -51723,8 +52330,8 @@ 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. + * 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. * @example * * // BEFORE RUNNING: * // --------------- @@ -51761,7 +52368,7 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setTargetPools(request, function(err, response) { + * compute.regionInstanceGroupManagers.recreateInstances(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -51785,7 +52392,7 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.setTargetPools + * @alias compute.regionInstanceGroupManagers.recreateInstances * @memberOf! () * * @param {object} params Parameters for request @@ -51793,28 +52400,28 @@ export namespace compute_v1 { * @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 {().RegionInstanceGroupManagersSetTargetPoolsRequest} params.resource Request body data + * @param {().RegionInstanceGroupManagersRecreateRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - setTargetPools( - params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + recreateInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options?: MethodOptions ): GaxiosPromise; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, callback: BodyResponseCallback ): void; - setTargetPools(callback: BodyResponseCallback): void; - setTargetPools( + recreateInstances(callback: BodyResponseCallback): void; + recreateInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | Params$Resource$Regioninstancegroupmanagers$Recreateinstances | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -51822,12 +52429,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + params = {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; options = {}; } @@ -51842,7 +52449,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -51859,43 +52466,456 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * 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. + * @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. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * // Number of instances that should exist in this instance group manager. + * size: 0, // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.resize(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.resize + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {integer} params.size Number of instances that should exist in this instance group manager. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resize( + params?: Params$Resource$Regioninstancegroupmanagers$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Resize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + 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}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @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. + * + * // 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. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.setInstanceTemplate(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.setInstanceTemplate + * @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.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 {().RegionInstanceGroupManagersSetTemplateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setInstanceTemplate( + params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + options?: MethodOptions + ): GaxiosPromise; + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + callback: BodyResponseCallback + ): void; + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + 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}/setInstanceTemplate' + ).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.setTargetPools + * @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: + * // --------------- + * // 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. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // 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.regionInstanceGroupManagers.setTargetPools(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.setTargetPools + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersSetTargetPoolsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setTargetPools( + params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options?: MethodOptions + ): GaxiosPromise; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + callback: BodyResponseCallback + ): void; + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + 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}/setTargetPools' + ).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 + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the managed instance group to delete. @@ -53390,283 +54410,2585 @@ export namespace compute_v1 { */ project?: string; /** - * Name of the region for this request. + * Name of the region for this request. + */ + region?: string; + } + + export class Resource$Regions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regions.get + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() 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. + * + * // Name of the region resource to return. + * region: 'my-region', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.regions.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/projects/{project}/regions/{region}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regions.list + * @desc Retrieves the list of region resources available to the specified project. + * @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. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regions.list(request, handlePage); + * } + * }; + * + * compute.regions.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regions.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$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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/compute/v1/projects/{project}/regions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regions$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region resource to return. + */ + region?: string; + } + export interface Params$Resource$Regions$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 class Resource$Regionsslcertificates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionSslCertificates.delete + * @desc Deletes the specified SslCertificate resource in the region. + * @alias compute.regionSslCertificates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.sslCertificate Name of the SslCertificate resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionsslcertificates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionsslcertificates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionsslcertificates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionSslCertificates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.sslCertificate Name of the SslCertificate resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionsslcertificates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionsslcertificates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionsslcertificates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionSslCertificates.insert + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request + * @alias compute.regionSslCertificates.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().SslCertificate} params.resource Request body data + * @param {object} [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$Regionsslcertificates$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionsslcertificates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionsslcertificates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/sslCertificates' + ).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.regionSslCertificates.list + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. + * @alias compute.regionSslCertificates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionsslcertificates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionsslcertificates$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionsslcertificates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionsslcertificates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsslcertificates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/sslCertificates' + ).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$Regionsslcertificates$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the SslCertificate resource to delete. + */ + sslCertificate?: string; + } + export interface Params$Resource$Regionsslcertificates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the SslCertificate resource to return. + */ + sslCertificate?: string; + } + export interface Params$Resource$Regionsslcertificates$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslCertificate; + } + export interface Params$Resource$Regionsslcertificates$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + + export class Resource$Regiontargethttpproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionTargetHttpProxies.delete + * @desc Deletes the specified TargetHttpProxy resource. + * @alias compute.regionTargetHttpProxies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regiontargethttpproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regiontargethttpproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regiontargethttpproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionTargetHttpProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regiontargethttpproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiontargethttpproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiontargethttpproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpProxies.insert + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. + * @alias compute.regionTargetHttpProxies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().TargetHttpProxy} params.resource Request body data + * @param {object} [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$Regiontargethttpproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regiontargethttpproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regiontargethttpproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpProxies' + ).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.regionTargetHttpProxies.list + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. + * @alias compute.regionTargetHttpProxies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regiontargethttpproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiontargethttpproxies$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiontargethttpproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpProxies.setUrlMap + * @desc Changes the URL map for TargetHttpProxy. + * @alias compute.regionTargetHttpProxies.setUrlMap + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy to set a URL map for. + * @param {().UrlMapReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUrlMap( + params?: Params$Resource$Regiontargethttpproxies$Seturlmap, + options?: MethodOptions + ): GaxiosPromise; + setUrlMap( + params: Params$Resource$Regiontargethttpproxies$Seturlmap, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUrlMap( + params: Params$Resource$Regiontargethttpproxies$Seturlmap, + callback: BodyResponseCallback + ): void; + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( + paramsOrCallback?: + | Params$Resource$Regiontargethttpproxies$Seturlmap + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpproxies$Seturlmap; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Seturlmap; + 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}/targetHttpProxies/{targetHttpProxy}/setUrlMap' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regiontargethttpproxies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpProxy resource to delete. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the TargetHttpProxy resource to return. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpProxy; + } + export interface Params$Resource$Regiontargethttpproxies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Seturlmap + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpProxy to set a URL map for. + */ + targetHttpProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapReference; + } + + export class Resource$Regiontargethttpsproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionTargetHttpsProxies.delete + * @desc Deletes the specified TargetHttpsProxy resource. + * @alias compute.regionTargetHttpsProxies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regiontargethttpsproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regiontargethttpsproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regiontargethttpsproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionTargetHttpsProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regiontargethttpsproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiontargethttpsproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiontargethttpsproxies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpsProxies.insert + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. + * @alias compute.regionTargetHttpsProxies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().TargetHttpsProxy} params.resource Request body data + * @param {object} [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$Regiontargethttpsproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regiontargethttpsproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regiontargethttpsproxies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpsProxies' + ).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.regionTargetHttpsProxies.list + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. + * @alias compute.regionTargetHttpsProxies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regiontargethttpsproxies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiontargethttpsproxies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiontargethttpsproxies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/targetHttpsProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpsProxies.setSslCertificates + * @desc Replaces SslCertificates for TargetHttpsProxy. + * @alias compute.regionTargetHttpsProxies.setSslCertificates + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + * @param {().RegionTargetHttpsProxiesSetSslCertificatesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSslCertificates( + params?: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + options?: MethodOptions + ): GaxiosPromise; + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + callback: BodyResponseCallback + ): void; + setSslCertificates(callback: BodyResponseCallback): void; + setSslCertificates( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Setsslcertificates + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Setsslcertificates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Setsslcertificates; + 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}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionTargetHttpsProxies.setUrlMap + * @desc Changes the URL map for TargetHttpsProxy. + * @alias compute.regionTargetHttpsProxies.setUrlMap + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy to set a URL map for. + * @param {().UrlMapReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUrlMap( + params?: Params$Resource$Regiontargethttpsproxies$Seturlmap, + options?: MethodOptions + ): GaxiosPromise; + setUrlMap( + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setUrlMap( + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, + callback: BodyResponseCallback + ): void; + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Seturlmap + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Seturlmap; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Seturlmap; + 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}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regiontargethttpsproxies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpsProxy resource to delete. + */ + targetHttpsProxy?: string; + } + export interface Params$Resource$Regiontargethttpsproxies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the TargetHttpsProxy resource to return. + */ + targetHttpsProxy?: string; + } + export interface Params$Resource$Regiontargethttpsproxies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpsProxy; + } + export interface Params$Resource$Regiontargethttpsproxies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regiontargethttpsproxies$Setsslcertificates + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest; + } + export interface Params$Resource$Regiontargethttpsproxies$Seturlmap + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpsProxy to set a URL map for. + */ + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapReference; + } + + export class Resource$Regionurlmaps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionUrlMaps.delete + * @desc Deletes the specified UrlMap resource. + * @alias compute.regionUrlMaps.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionurlmaps$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionurlmaps$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionurlmaps$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.get + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @alias compute.regionUrlMaps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.urlMap Name of the UrlMap resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionurlmaps$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionurlmaps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionurlmaps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.insert + * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @alias compute.regionUrlMaps.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Regionurlmaps$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionurlmaps$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionurlmaps$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/urlMaps' + ).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.regionUrlMaps.list + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. + * @alias compute.regionUrlMaps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionurlmaps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionurlmaps$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionurlmaps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.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. + * @alias compute.regionUrlMaps.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap resource to patch. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Regionurlmaps$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionurlmaps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionurlmaps$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.update + * @desc Updates the specified UrlMap resource with the data included in the request. + * @alias compute.regionUrlMaps.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap resource to update. + * @param {().UrlMap} params.resource Request body data + * @param {object} [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$Regionurlmaps$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regionurlmaps$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regionurlmaps$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$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/v1/projects/{project}/regions/{region}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * @alias compute.regionUrlMaps.validate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.urlMap Name of the UrlMap resource to be validated as. + * @param {().RegionUrlMapsValidateRequest} params.resource Request body data + * @param {object} [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$Regionurlmaps$Validate, + options?: MethodOptions + ): GaxiosPromise; + validate( + params: Params$Resource$Regionurlmaps$Validate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validate( + params: Params$Resource$Regionurlmaps$Validate, + callback: BodyResponseCallback + ): void; + validate( + callback: BodyResponseCallback + ): void; + validate( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Validate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Validate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Validate; + 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}/urlMaps/{urlMap}/validate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionurlmaps$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to delete. + */ + urlMap?: string; + } + export interface Params$Resource$Regionurlmaps$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the UrlMap resource to return. + */ + urlMap?: string; + } + export interface Params$Resource$Regionurlmaps$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. */ region?: string; } - - export class Resource$Regions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + export interface Params$Resource$Regionurlmaps$Patch + extends StandardParameters { /** - * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() 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. - * - * // Name of the region resource to return. - * region: 'my-region', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regions.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region resource 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 + * Auth client or API Key for the request */ - get( - params?: Params$Resource$Regions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Regions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Regions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/compute/v1/projects/{project}/regions/{region}' - ).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); - } - } + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. - * @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. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regions.list(request, handlePage); - * } - * }; - * - * compute.regions.list(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regions.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 + * Project ID for this request. */ - 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 = {}; - } + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to patch. + */ + urlMap?: string; - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/compute/v1/projects/{project}/regions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; } - - export interface Params$Resource$Regions$Get extends StandardParameters { + export interface Params$Resource$Regionurlmaps$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53677,36 +56999,47 @@ export namespace compute_v1 { */ project?: string; /** - * Name of the region resource to return. + * Name of the region scoping this request. */ region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to update. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; } - export interface Params$Resource$Regions$List extends StandardParameters { + export interface Params$Resource$Regionurlmaps$Validate + 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) + * Project ID for this request. */ - maxResults?: number; + project?: 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. + * Name of the region scoping this request. */ - orderBy?: string; + region?: 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. + * Name of the UrlMap resource to be validated as. */ - pageToken?: string; + urlMap?: string; + /** - * Project ID for this request. + * Request body metadata */ - project?: string; + requestBody?: Schema$RegionUrlMapsValidateRequest; } export class Resource$Reservations { @@ -59469,6 +62802,93 @@ export namespace compute_v1 { this.context = context; } + /** + * compute.sslCertificates.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Sslcertificates$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Sslcertificates$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Sslcertificates$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Sslcertificates$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcertificates$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/aggregated/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.sslCertificates.delete * @desc Deletes the specified SslCertificate resource. @@ -59996,6 +63416,34 @@ export namespace compute_v1 { } } + export interface Params$Resource$Sslcertificates$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Sslcertificates$Delete extends StandardParameters { /** @@ -62384,6 +65832,93 @@ export namespace compute_v1 { this.context = context; } + /** + * compute.targetHttpProxies.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Targethttpproxies$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targethttpproxies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targethttpproxies$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/aggregated/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.targetHttpProxies.delete * @desc Deletes the specified TargetHttpProxy resource. @@ -63047,6 +66582,34 @@ export namespace compute_v1 { } } + export interface Params$Resource$Targethttpproxies$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Targethttpproxies$Delete extends StandardParameters { /** @@ -63164,6 +66727,93 @@ export namespace compute_v1 { this.context = context; } + /** + * compute.targetHttpsProxies.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Targethttpsproxies$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targethttpsproxies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targethttpsproxies$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targethttpsproxies$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpsproxies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/aggregated/targetHttpsProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.targetHttpsProxies.delete * @desc Deletes the specified TargetHttpsProxy resource. @@ -64117,6 +67767,34 @@ export namespace compute_v1 { } } + export interface Params$Resource$Targethttpsproxies$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Targethttpsproxies$Delete extends StandardParameters { /** @@ -69935,6 +73613,87 @@ export namespace compute_v1 { this.context = context; } + /** + * compute.urlMaps.aggregatedList + * @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 {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 Name of the project 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 + */ + aggregatedList( + params?: Params$Resource$Urlmaps$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Urlmaps$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Urlmaps$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Urlmaps$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Urlmaps$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/projects/{project}/aggregated/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.urlMaps.delete * @desc Deletes the specified UrlMap resource. @@ -70990,6 +74749,34 @@ export namespace compute_v1 { } } + export interface Params$Resource$Urlmaps$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Urlmaps$Delete extends StandardParameters { /** * Auth client or API Key for the request diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index b0fefd2a829..ef4eb09555d 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -124,11 +124,11 @@ export namespace container_v1 { /** * The number of the accelerator cards exposed to an instance. */ - acceleratorCount?: string; + acceleratorCount?: string | null; /** - * The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus/#Introduction) + * The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus) */ - acceleratorType?: string; + acceleratorType?: string | null; } /** * Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. @@ -158,11 +158,11 @@ export namespace container_v1 { /** * [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - autoUpgradeStartTime?: string; + autoUpgradeStartTime?: string | null; /** * [Output only] This field is set when upgrades are about to commence with the description of the upgrade. */ - description?: string; + description?: string | null; } /** * Parameters for using BigQuery as the destination of resource usage export. @@ -171,7 +171,7 @@ export namespace container_v1 { /** * The ID of a BigQuery Dataset. */ - datasetId?: string; + datasetId?: string | null; } /** * CancelOperationRequest cancels a single operation. @@ -180,19 +180,19 @@ export namespace container_v1 { /** * The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ - operationId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * CidrBlock contains an optional name and one CIDR block. @@ -201,11 +201,11 @@ export namespace container_v1 { /** * cidr_block must be specified in CIDR notation. */ - cidrBlock?: string; + cidrBlock?: string | null; /** * display_name is an optional field for users to identify CIDR blocks. */ - displayName?: string; + displayName?: string | null; } /** * Configuration for client certificates on the cluster. @@ -214,7 +214,7 @@ export namespace container_v1 { /** * Issue a client certificate. */ - issueClientCertificate?: boolean; + issueClientCertificate?: boolean | null; } /** * A Google Kubernetes Engine cluster. @@ -227,7 +227,7 @@ export namespace container_v1 { /** * 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; + clusterIpv4Cidr?: string | null; /** * Which conditions caused the current cluster state. */ @@ -235,19 +235,19 @@ export namespace container_v1 { /** * [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - createTime?: string; + createTime?: string | null; /** * [Output only] The current software version of the master endpoint. */ - currentMasterVersion?: string; + currentMasterVersion?: string | null; /** * [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. */ - currentNodeCount?: number; + currentNodeCount?: number | null; /** * [Output only] Deprecated, use [NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ - currentNodeVersion?: string; + currentNodeVersion?: string | null; /** * The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support. */ @@ -255,35 +255,35 @@ export namespace container_v1 { /** * An optional description of this cluster. */ - description?: string; + description?: string | null; /** * Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. */ - enableKubernetesAlpha?: boolean; + enableKubernetesAlpha?: boolean | null; /** * Enable the ability to use Cloud TPUs in this cluster. */ - enableTpu?: boolean; + enableTpu?: boolean | null; /** * [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. */ - endpoint?: string; + endpoint?: string | null; /** * [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - expireTime?: string; + expireTime?: string | null; /** * The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. 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 */ - initialClusterVersion?: string; + initialClusterVersion?: string | null; /** * The number of nodes to create in this cluster. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. */ - initialNodeCount?: number; + initialNodeCount?: number | null; /** * Deprecated. Use node_pools.instance_group_urls. */ - instanceGroupUrls?: string[]; + instanceGroupUrls?: string[] | null; /** * Configuration for cluster IP allocation. */ @@ -291,7 +291,7 @@ export namespace container_v1 { /** * The fingerprint of the set of labels for this cluster. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Configuration for the legacy ABAC authorization mode. */ @@ -299,15 +299,15 @@ export namespace container_v1 { /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ - location?: string; + location?: string | null; /** * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. */ - locations?: string[]; + locations?: string[] | null; /** * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. */ - loggingService?: string; + loggingService?: string | null; /** * Configure the maintenance policy for this cluster. */ @@ -323,15 +323,15 @@ export namespace container_v1 { /** * 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. * if left as an empty string, `monitoring.googleapis.com` will be used. */ - monitoringService?: string; + monitoringService?: string | null; /** * The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. */ - name?: string; + name?: string | null; /** * The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. */ - network?: string; + network?: string | null; /** * Configuration for cluster networking. */ @@ -347,7 +347,7 @@ export namespace container_v1 { /** * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. */ - nodeIpv4CidrSize?: number; + nodeIpv4CidrSize?: number | null; /** * The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. */ @@ -359,7 +359,7 @@ export namespace container_v1 { /** * The resource labels for the cluster to use to annotate any related Google Compute Engine resources. */ - resourceLabels?: {[key: string]: string}; + resourceLabels?: {[key: string]: string} | null; /** * Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified. */ @@ -367,31 +367,31 @@ export namespace container_v1 { /** * [Output only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ - servicesIpv4Cidr?: string; + servicesIpv4Cidr?: string | null; /** * [Output only] The current status of this cluster. */ - status?: string; + status?: string | null; /** * [Output only] Additional information about the current status of this cluster, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected. */ - subnetwork?: string; + subnetwork?: string | null; /** * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ - tpuIpv4CidrBlock?: string; + tpuIpv4CidrBlock?: string | null; /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ - zone?: string; + zone?: 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. @@ -404,7 +404,7 @@ export namespace container_v1 { /** * The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. */ - desiredImageType?: string; + desiredImageType?: string | null; /** * The desired config of Intra-node visibility. */ @@ -412,11 +412,11 @@ export namespace container_v1 { /** * 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. */ - desiredLocations?: string[]; + desiredLocations?: string[] | null; /** * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster */ - desiredLoggingService?: string; + desiredLoggingService?: string | null; /** * The desired configuration options for master authorized networks feature. */ @@ -424,11 +424,11 @@ export namespace container_v1 { /** * 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 */ - desiredMasterVersion?: string; + desiredMasterVersion?: string | null; /** * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ - desiredMonitoringService?: string; + desiredMonitoringService?: string | null; /** * Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. */ @@ -436,11 +436,11 @@ export namespace container_v1 { /** * The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. */ - desiredNodePoolId?: string; + desiredNodePoolId?: 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 */ - desiredNodeVersion?: string; + desiredNodeVersion?: string | null; /** * The desired configuration for exporting resource usage. */ @@ -453,19 +453,19 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * Parameters for controlling consumption metering. @@ -474,7 +474,7 @@ export namespace container_v1 { /** * Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records. */ - enabled?: boolean; + enabled?: boolean | null; } /** * CreateClusterRequest creates a cluster. @@ -487,15 +487,15 @@ export namespace container_v1 { /** * The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/*'. */ - parent?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * CreateNodePoolRequest creates a node pool for a cluster. @@ -504,7 +504,7 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ - clusterId?: string; + clusterId?: string | null; /** * The node pool to create. */ @@ -512,15 +512,15 @@ export namespace container_v1 { /** * The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/*'. */ - parent?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * Time window specified for daily maintenance operations. @@ -529,11 +529,11 @@ export namespace container_v1 { /** * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". */ - duration?: string; + duration?: string | null; /** * Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. */ - startTime?: string; + startTime?: 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 `{}`. @@ -563,31 +563,31 @@ export namespace container_v1 { /** * Supported claims. */ - claims_supported?: string[]; + claims_supported?: string[] | null; /** * Supported grant types. */ - grant_types?: string[]; + grant_types?: string[] | null; /** * supported ID Token signing Algorithms. */ - id_token_signing_alg_values_supported?: string[]; + id_token_signing_alg_values_supported?: string[] | null; /** * OIDC Issuer. */ - issuer?: string; + issuer?: string | null; /** * JSON Web Key uri. */ - jwks_uri?: string; + jwks_uri?: string | null; /** * Supported response types. */ - response_types_supported?: string[]; + response_types_supported?: string[] | null; /** * Supported subject types. */ - subject_types_supported?: string[]; + subject_types_supported?: string[] | null; } /** * Configuration options 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. @@ -596,7 +596,7 @@ export namespace container_v1 { /** * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service. */ - disabled?: boolean; + disabled?: boolean | null; } /** * RFC-2616: cache control support @@ -605,15 +605,15 @@ export namespace container_v1 { /** * 14.6 response cache age, in seconds since the response is generated */ - age?: string; + age?: string | null; /** * 14.9 request and response directives */ - directive?: string; + directive?: string | null; /** * 14.21 response cache expires, in RFC 1123 date format */ - expires?: string; + expires?: string | null; } /** * Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. @@ -622,7 +622,7 @@ export namespace container_v1 { /** * Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. */ - disabled?: boolean; + disabled?: boolean | null; } /** * IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. @@ -631,7 +631,7 @@ export namespace container_v1 { /** * Enables intra node visibility for this cluster. */ - enabled?: boolean; + enabled?: boolean | null; } /** * Configuration for controlling how IPs are allocated in the cluster. @@ -640,51 +640,51 @@ export namespace container_v1 { /** * This field is deprecated, use cluster_ipv4_cidr_block. */ - clusterIpv4Cidr?: string; + clusterIpv4Cidr?: string | null; /** * The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - clusterIpv4CidrBlock?: string; + clusterIpv4CidrBlock?: string | null; /** * The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. */ - clusterSecondaryRangeName?: string; + clusterSecondaryRangeName?: string | null; /** * Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. */ - createSubnetwork?: boolean; + createSubnetwork?: boolean | null; /** * This field is deprecated, use node_ipv4_cidr_block. */ - nodeIpv4Cidr?: string; + nodeIpv4Cidr?: string | null; /** * The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - nodeIpv4CidrBlock?: string; + nodeIpv4CidrBlock?: string | null; /** * This field is deprecated, use services_ipv4_cidr_block. */ - servicesIpv4Cidr?: string; + servicesIpv4Cidr?: string | null; /** * The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - servicesIpv4CidrBlock?: string; + servicesIpv4CidrBlock?: string | null; /** * The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. */ - servicesSecondaryRangeName?: string; + servicesSecondaryRangeName?: string | null; /** * A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. */ - subnetworkName?: string; + subnetworkName?: string | null; /** * The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - tpuIpv4CidrBlock?: string; + tpuIpv4CidrBlock?: string | null; /** * Whether alias IPs will be used for pod IPs in the cluster. */ - useIpAliases?: boolean; + useIpAliases?: boolean | null; } /** * Jwk is a JSON Web Key as specified in RFC 7517 @@ -693,39 +693,39 @@ export namespace container_v1 { /** * Algorithm. */ - alg?: string; + alg?: string | null; /** * Used for ECDSA keys. */ - crv?: string; + crv?: string | null; /** * Used for RSA keys. */ - e?: string; + e?: string | null; /** * Key ID. */ - kid?: string; + kid?: string | null; /** * Key Type. */ - kty?: string; + kty?: string | null; /** * Used for RSA keys. */ - n?: string; + n?: string | null; /** * Permitted uses for the public keys. */ - use?: string; + use?: string | null; /** * Used for ECDSA keys. */ - x?: string; + x?: string | null; /** * Used for ECDSA keys. */ - y?: string; + y?: string | null; } /** * Configuration for the Kubernetes Dashboard. @@ -734,7 +734,7 @@ export namespace container_v1 { /** * Whether the Kubernetes Dashboard is enabled for this cluster. */ - disabled?: boolean; + disabled?: boolean | null; } /** * Configuration for the legacy Attribute Based Access Control authorization mode. @@ -743,7 +743,7 @@ export namespace container_v1 { /** * Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. */ - enabled?: boolean; + enabled?: boolean | null; } /** * ListClustersResponse is the result of ListClustersRequest. @@ -756,7 +756,7 @@ export namespace container_v1 { /** * If any zones are listed here, the list of clusters returned may be missing those zones. */ - missingZones?: string[]; + missingZones?: string[] | null; } /** * ListNodePoolsResponse is the result of ListNodePoolsRequest. @@ -774,7 +774,7 @@ export namespace container_v1 { /** * If any zones are listed here, the list of operations returned may be missing the operations from those zones. */ - missingZones?: string[]; + missingZones?: string[] | null; /** * A list of operations in the project in the specified zone. */ @@ -787,7 +787,7 @@ export namespace container_v1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `page_size`, use the `next_page_token` as a value for the query parameter `page_token` in the next request. The value will become empty when there are no more pages. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of usable subnetworks in the specified network project. */ @@ -818,7 +818,7 @@ export namespace container_v1 { /** * [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. */ - clientCertificate?: string; + clientCertificate?: string | null; /** * Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. */ @@ -826,19 +826,19 @@ export namespace container_v1 { /** * [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. */ - clientKey?: string; + clientKey?: string | null; /** * [Output only] Base64-encoded public certificate that is the root of trust for the cluster. */ - clusterCaCertificate?: string; + clusterCaCertificate?: string | null; /** * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. */ - password?: string; + password?: string | null; /** * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). */ - username?: string; + username?: string | null; } /** * Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. @@ -851,7 +851,7 @@ export namespace container_v1 { /** * Whether or not master authorized networks is enabled. */ - enabled?: boolean; + enabled?: boolean | null; } /** * Constraints applied to pods. @@ -860,7 +860,7 @@ export namespace container_v1 { /** * Constraint enforced on the max num of pods per node. */ - maxPodsPerNode?: string; + maxPodsPerNode?: string | null; } /** * NetworkConfig reports the relative names of network & subnetwork. @@ -869,15 +869,15 @@ export namespace container_v1 { /** * Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. */ - enableIntraNodeVisibility?: boolean; + enableIntraNodeVisibility?: boolean | null; /** * Output only. The relative name of the Google Compute Engine network(/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network */ - network?: string; + network?: string | null; /** * Output only. The relative name of the Google Compute Engine [subnetwork](/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ - subnetwork?: string; + subnetwork?: string | null; } /** * Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ @@ -886,11 +886,11 @@ export namespace container_v1 { /** * Whether network policy is enabled on the cluster. */ - enabled?: boolean; + enabled?: boolean | null; /** * The selected network policy provider. */ - provider?: string; + provider?: string | null; } /** * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -899,7 +899,7 @@ export namespace container_v1 { /** * Whether NetworkPolicy is enabled for this cluster. */ - disabled?: boolean; + disabled?: boolean | null; } /** * Parameters that describe the nodes in a cluster. @@ -912,51 +912,51 @@ export namespace container_v1 { /** * Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. */ - diskSizeGb?: number; + diskSizeGb?: number | null; /** * Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard' */ - diskType?: string; + diskType?: string | null; /** * The image type to use for this node. Note that for a given image type, the latest version of it will be used. */ - imageType?: string; + imageType?: string | null; /** * The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** - * The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information. + * The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. */ - localSsdCount?: number; + localSsdCount?: number | null; /** * The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`. */ - machineType?: string; + 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. */ - metadata?: {[key: string]: string}; + 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) */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. */ - oauthScopes?: string[]; + oauthScopes?: string[] | null; /** * 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; + preemptible?: boolean | null; /** * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. */ - tags?: string[]; + tags?: string[] | null; /** * List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ */ @@ -969,11 +969,11 @@ export namespace container_v1 { /** * A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. */ - autoRepair?: boolean; + autoRepair?: boolean | null; /** * A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. */ - autoUpgrade?: boolean; + autoUpgrade?: boolean | null; /** * Specifies the Auto Upgrade knobs for the node pool. */ @@ -998,11 +998,11 @@ export namespace container_v1 { /** * The initial node count for the pool. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. */ - initialNodeCount?: number; + initialNodeCount?: number | null; /** * [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. */ - instanceGroupUrls?: string[]; + instanceGroupUrls?: string[] | null; /** * NodeManagement configuration for this NodePool. */ @@ -1014,27 +1014,27 @@ export namespace container_v1 { /** * The name of the node pool. */ - name?: string; + name?: string | null; /** * [Output only] The pod CIDR block size per node in this node pool. */ - podIpv4CidrSize?: number; + podIpv4CidrSize?: number | null; /** * [Output only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] The status of the nodes in this pool instance. */ - status?: string; + status?: string | null; /** * [Output only] Additional information about the current status of this node pool instance, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * The version of the Kubernetes of this node. */ - version?: string; + version?: string | null; } /** * NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. @@ -1043,15 +1043,15 @@ export namespace container_v1 { /** * Is autoscaling enabled for this node pool. */ - enabled?: boolean; + enabled?: boolean | null; /** * Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster. */ - maxNodeCount?: number; + maxNodeCount?: number | null; /** * Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. */ - minNodeCount?: number; + minNodeCount?: number | null; } /** * Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ @@ -1060,15 +1060,15 @@ export namespace container_v1 { /** * Effect for taint. */ - effect?: string; + effect?: string | null; /** * Key for taint. */ - key?: string; + key?: string | null; /** * Value for taint. */ - value?: string; + value?: string | null; } /** * This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. @@ -1081,19 +1081,19 @@ export namespace container_v1 { /** * Detailed operation progress, if available. */ - detail?: string; + detail?: string | null; /** * [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - endTime?: string; + endTime?: string | null; /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ - location?: string; + location?: string | null; /** * The server-assigned ID for the operation. */ - name?: string; + name?: string | null; /** * Which conditions caused the current node pool state. */ @@ -1101,31 +1101,31 @@ export namespace container_v1 { /** * The operation type. */ - operationType?: string; + operationType?: string | null; /** * Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - startTime?: string; + startTime?: string | null; /** * The current status of the operation. */ - status?: string; + status?: string | null; /** * If an error has occurred, a textual description of the error. */ - statusMessage?: string; + statusMessage?: string | null; /** * Server-defined URL for the target of the operation. */ - targetLink?: string; + targetLink?: string | null; /** * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ - zone?: string; + zone?: string | null; } /** * Configuration options for private clusters. @@ -1134,23 +1134,23 @@ export namespace container_v1 { /** * Whether the master's internal IP address is used as the cluster endpoint. */ - enablePrivateEndpoint?: boolean; + enablePrivateEndpoint?: boolean | null; /** * Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. */ - enablePrivateNodes?: boolean; + enablePrivateNodes?: boolean | null; /** * The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network. */ - masterIpv4CidrBlock?: string; + masterIpv4CidrBlock?: string | null; /** * Output only. The internal IP address of this cluster's master endpoint. */ - privateEndpoint?: string; + privateEndpoint?: string | null; /** * Output only. The external IP address of this cluster's master endpoint. */ - publicEndpoint?: string; + publicEndpoint?: string | null; } /** * Configuration for exporting cluster resource usages. @@ -1167,7 +1167,7 @@ export namespace container_v1 { /** * Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. */ - enableNetworkEgressMetering?: boolean; + enableNetworkEgressMetering?: boolean | null; } /** * RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. @@ -1176,23 +1176,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * Kubernetes Engine service configuration. @@ -1201,23 +1201,23 @@ export namespace container_v1 { /** * Version of Kubernetes the service deploys by default. */ - defaultClusterVersion?: string; + defaultClusterVersion?: string | null; /** * Default image type. */ - defaultImageType?: string; + defaultImageType?: string | null; /** * List of valid image types. */ - validImageTypes?: string[]; + validImageTypes?: string[] | null; /** * List of valid master versions. */ - validMasterVersions?: string[]; + validMasterVersions?: string[] | null; /** * List of valid node upgrade target versions. */ - validNodeVersions?: string[]; + validNodeVersions?: string[] | null; } /** * SetAddonsConfigRequest sets the addons associated with the cluster. @@ -1230,19 +1230,19 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster @@ -1251,27 +1251,27 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * The labels to set for that cluster. */ - resourceLabels?: {[key: string]: string}; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. @@ -1280,23 +1280,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * Whether ABAC authorization will be enabled in the cluster. */ - enabled?: boolean; + enabled?: boolean | null; /** * The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLocationsRequest sets the locations of the cluster. @@ -1305,23 +1305,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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. */ - locations?: string[]; + locations?: string[] | null; /** * The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLoggingServiceRequest sets the logging service of a cluster. @@ -1330,23 +1330,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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 */ - loggingService?: string; + loggingService?: string | null; /** * The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetMaintenancePolicyRequest sets the maintenance policy for a cluster. @@ -1355,7 +1355,7 @@ export namespace container_v1 { /** * The name of the cluster to update. */ - clusterId?: string; + clusterId?: string | null; /** * The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. */ @@ -1363,15 +1363,15 @@ export namespace container_v1 { /** * The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + name?: string | null; /** * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ - projectId?: string; + projectId?: string | null; /** * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ - zone?: string; + zone?: string | null; } /** * SetMasterAuthRequest updates the admin password of a cluster. @@ -1380,19 +1380,19 @@ export namespace container_v1 { /** * The exact form of action to be taken on the master auth. */ - action?: string; + action?: string | null; /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * A description of the update. */ @@ -1400,7 +1400,7 @@ export namespace container_v1 { /** * Deprecated. The name of the 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; + zone?: string | null; } /** * SetMonitoringServiceRequest sets the monitoring service of a cluster. @@ -1409,23 +1409,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ - monitoringService?: string; + monitoringService?: string | null; /** * The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNetworkPolicyRequest enables/disables network policy for a cluster. @@ -1434,11 +1434,11 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + name?: string | null; /** * Configuration options for the NetworkPolicy feature. */ @@ -1446,11 +1446,11 @@ export namespace container_v1 { /** * 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; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. @@ -1463,23 +1463,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNodePoolManagementRequest sets the node management properties of a node pool. @@ -1488,7 +1488,7 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * NodeManagement configuration for the node pool. */ @@ -1496,19 +1496,19 @@ export namespace container_v1 { /** * The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNodePoolSizeRequest sets the size a node pool. @@ -1517,27 +1517,27 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * The desired node count for the pool. */ - nodeCount?: number; + nodeCount?: number | null; /** * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. @@ -1546,23 +1546,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * Whether to rotate credentials during IP rotation. */ - rotateCredentials?: boolean; + 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. */ - zone?: string; + zone?: string | null; } /** * StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1571,11 +1571,11 @@ export namespace container_v1 { /** * Machine-friendly representation of the condition */ - code?: string; + code?: string | null; /** * Human-friendly representation of the condition */ - message?: string; + message?: string | null; } /** * UpdateClusterRequest updates the settings of a cluster. @@ -1584,15 +1584,15 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * A description of the update. */ @@ -1600,7 +1600,7 @@ export namespace container_v1 { /** * Deprecated. The name of the 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; + zone?: string | null; } /** * UpdateMasterRequest updates the master of the cluster. @@ -1609,23 +1609,23 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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 */ - masterVersion?: string; + masterVersion?: string | null; /** * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * UpdateNodePoolRequests update a node pool's image and/or version. @@ -1634,31 +1634,31 @@ export namespace container_v1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The desired image type for the node pool. */ - imageType?: string; + imageType?: string | null; /** * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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 */ - nodeVersion?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range. @@ -1667,11 +1667,11 @@ export namespace container_v1 { /** * The range of internal addresses that are owned by this subnetwork. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Network Name. Example: projects/my-project/global/networks/my-network */ - network?: string; + network?: string | null; /** * Secondary IP ranges. */ @@ -1679,11 +1679,11 @@ export namespace container_v1 { /** * A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message. */ - statusMessage?: string; + statusMessage?: string | null; /** * Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ - subnetwork?: string; + subnetwork?: string | null; } /** * Secondary IP range of a usable subnetwork. @@ -1692,15 +1692,15 @@ export namespace container_v1 { /** * The range of IP addresses belonging to this subnetwork secondary range. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. */ - rangeName?: string; + rangeName?: string | null; /** * This field is to determine the status of the secondary range programmably. */ - status?: string; + status?: string | null; } export class Resource$Projects { diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index fd5549cfa6e..dcc4e18f88f 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -124,11 +124,11 @@ export namespace container_v1beta1 { /** * The number of the accelerator cards exposed to an instance. */ - acceleratorCount?: string; + acceleratorCount?: string | null; /** * The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus/#Introduction) */ - acceleratorType?: string; + acceleratorType?: string | null; } /** * Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. @@ -166,11 +166,11 @@ export namespace container_v1beta1 { /** * Whether this cluster should return group membership lookups during authentication using a group of security groups. */ - enabled?: boolean; + enabled?: boolean | null; /** * The name of the security group-of-groups to be used. Only relevant if enabled = true. */ - securityGroup?: string; + securityGroup?: string | null; } /** * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. @@ -179,11 +179,11 @@ export namespace container_v1beta1 { /** * Scopes that are used by NAP when creating node pools. If oauth_scopes are specified, service_account should be empty. */ - oauthScopes?: string[]; + oauthScopes?: string[] | null; /** * The Google Cloud Platform Service Account to be used by the node VMs. If service_account is specified, scopes should be empty. */ - serviceAccount?: string; + serviceAccount?: string | null; } /** * AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. @@ -192,11 +192,11 @@ export namespace container_v1beta1 { /** * [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - autoUpgradeStartTime?: string; + autoUpgradeStartTime?: string | null; /** * [Output only] This field is set when upgrades are about to commence with the description of the upgrade. */ - description?: string; + description?: string | null; } /** * Parameters for using BigQuery as the destination of resource usage export. @@ -205,7 +205,7 @@ export namespace container_v1beta1 { /** * The ID of a BigQuery Dataset. */ - datasetId?: string; + datasetId?: string | null; } /** * Configuration for Binary Authorization. @@ -214,7 +214,7 @@ export namespace container_v1beta1 { /** * Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binauthz. */ - enabled?: boolean; + enabled?: boolean | null; } /** * CancelOperationRequest cancels a single operation. @@ -223,19 +223,19 @@ export namespace container_v1beta1 { /** * The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ - operationId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * CidrBlock contains an optional name and one CIDR block. @@ -244,11 +244,11 @@ export namespace container_v1beta1 { /** * cidr_block must be specified in CIDR notation. */ - cidrBlock?: string; + cidrBlock?: string | null; /** * display_name is an optional field for users to identify CIDR blocks. */ - displayName?: string; + displayName?: string | null; } /** * Configuration for client certificates on the cluster. @@ -257,7 +257,7 @@ export namespace container_v1beta1 { /** * Issue a client certificate. */ - issueClientCertificate?: boolean; + issueClientCertificate?: boolean | null; } /** * Configuration options for the Cloud Run feature. @@ -266,7 +266,7 @@ export namespace container_v1beta1 { /** * Whether Cloud Run addon is enabled for this cluster. */ - disabled?: boolean; + disabled?: boolean | null; } /** * A Google Kubernetes Engine cluster. @@ -291,7 +291,7 @@ 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; + clusterIpv4Cidr?: string | null; /** * Which conditions caused the current cluster state. */ @@ -299,19 +299,19 @@ export namespace container_v1beta1 { /** * [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - createTime?: string; + createTime?: string | null; /** * [Output only] The current software version of the master endpoint. */ - currentMasterVersion?: string; + currentMasterVersion?: string | null; /** * [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. */ - currentNodeCount?: number; + currentNodeCount?: number | null; /** * [Output only] Deprecated, use [NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ - currentNodeVersion?: string; + currentNodeVersion?: string | null; /** * Configuration of etcd encryption. */ @@ -323,35 +323,35 @@ export namespace container_v1beta1 { /** * An optional description of this cluster. */ - description?: string; + description?: string | null; /** * Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. */ - enableKubernetesAlpha?: boolean; + enableKubernetesAlpha?: boolean | null; /** * Enable the ability to use Cloud TPUs in this cluster. */ - enableTpu?: boolean; + enableTpu?: boolean | null; /** * [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. */ - endpoint?: string; + endpoint?: string | null; /** * [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - expireTime?: string; + expireTime?: string | null; /** * The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. 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 */ - initialClusterVersion?: string; + initialClusterVersion?: string | null; /** * The number of nodes to create in this cluster. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. */ - initialNodeCount?: number; + initialNodeCount?: number | null; /** * Deprecated. Use node_pools.instance_group_urls. */ - instanceGroupUrls?: string[]; + instanceGroupUrls?: string[] | null; /** * Configuration for cluster IP allocation. */ @@ -359,7 +359,7 @@ export namespace container_v1beta1 { /** * The fingerprint of the set of labels for this cluster. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * Configuration for the legacy ABAC authorization mode. */ @@ -367,15 +367,15 @@ export namespace container_v1beta1 { /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ - location?: string; + location?: string | null; /** * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. */ - locations?: string[]; + locations?: string[] | null; /** * The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. */ - loggingService?: string; + loggingService?: string | null; /** * Configure the maintenance policy for this cluster. */ @@ -391,19 +391,19 @@ export namespace container_v1beta1 { /** * The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. */ - masterIpv4CidrBlock?: string; + masterIpv4CidrBlock?: 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. * if left as an empty string, `monitoring.googleapis.com` will be used. */ - monitoringService?: string; + monitoringService?: string | null; /** * The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. */ - name?: string; + name?: string | null; /** * The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. */ - network?: string; + network?: string | null; /** * Configuration for cluster networking. */ @@ -419,7 +419,7 @@ export namespace container_v1beta1 { /** * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. */ - nodeIpv4CidrSize?: number; + nodeIpv4CidrSize?: number | null; /** * The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. */ @@ -431,7 +431,7 @@ export namespace container_v1beta1 { /** * If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead. */ - privateCluster?: boolean; + privateCluster?: boolean | null; /** * Configuration for private cluster. */ @@ -443,7 +443,7 @@ export namespace container_v1beta1 { /** * The resource labels for the cluster to use to annotate any related Google Compute Engine resources. */ - resourceLabels?: {[key: string]: string}; + resourceLabels?: {[key: string]: string} | null; /** * Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified. */ @@ -451,11 +451,11 @@ export namespace container_v1beta1 { /** * [Output only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ - servicesIpv4Cidr?: string; + servicesIpv4Cidr?: string | null; /** * Shielded Nodes configuration. */ @@ -463,15 +463,15 @@ export namespace container_v1beta1 { /** * [Output only] The current status of this cluster. */ - status?: string; + status?: string | null; /** * [Output only] Additional information about the current status of this cluster, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. */ - subnetwork?: string; + subnetwork?: string | null; /** * Cluster tier settings. */ @@ -479,7 +479,7 @@ export namespace container_v1beta1 { /** * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ - tpuIpv4CidrBlock?: string; + tpuIpv4CidrBlock?: string | null; /** * Cluster-level Vertical Pod Autoscaling configuration. */ @@ -491,7 +491,7 @@ export namespace container_v1beta1 { /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ - zone?: string; + zone?: string | null; } /** * ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. @@ -500,7 +500,7 @@ export namespace container_v1beta1 { /** * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. */ - autoprovisioningLocations?: string[]; + autoprovisioningLocations?: string[] | null; /** * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. */ @@ -508,7 +508,7 @@ export namespace container_v1beta1 { /** * Enables automatic node pool creation and deletion. */ - enableNodeAutoprovisioning?: boolean; + enableNodeAutoprovisioning?: boolean | null; /** * Contains global constraints regarding minimum and maximum amount of resources in the cluster. */ @@ -537,7 +537,7 @@ export namespace container_v1beta1 { /** * The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. */ - desiredImageType?: string; + desiredImageType?: string | null; /** * The desired config of Intra-node visibility. */ @@ -545,11 +545,11 @@ export namespace container_v1beta1 { /** * 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. */ - desiredLocations?: string[]; + desiredLocations?: string[] | null; /** * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster */ - desiredLoggingService?: string; + desiredLoggingService?: string | null; /** * The desired configuration options for master authorized networks feature. */ @@ -557,11 +557,11 @@ export namespace container_v1beta1 { /** * The Kubernetes version to change the master to. The only valid value is the latest supported version. 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 */ - desiredMasterVersion?: string; + desiredMasterVersion?: string | null; /** * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ - desiredMonitoringService?: string; + desiredMonitoringService?: string | null; /** * Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. */ @@ -569,11 +569,11 @@ export namespace container_v1beta1 { /** * The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster. */ - desiredNodePoolId?: string; + desiredNodePoolId?: 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 */ - desiredNodeVersion?: string; + desiredNodeVersion?: string | null; /** * The desired configuration options for the PodSecurityPolicy feature. */ @@ -606,19 +606,19 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * Parameters for controlling consumption metering. @@ -627,7 +627,7 @@ export namespace container_v1beta1 { /** * Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records. */ - enabled?: boolean; + enabled?: boolean | null; } /** * CreateClusterRequest creates a cluster. @@ -640,15 +640,15 @@ export namespace container_v1beta1 { /** * The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/*'. */ - parent?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * CreateNodePoolRequest creates a node pool for a cluster. @@ -657,7 +657,7 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ - clusterId?: string; + clusterId?: string | null; /** * The node pool to create. */ @@ -665,15 +665,15 @@ export namespace container_v1beta1 { /** * The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/*'. */ - parent?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * Time window specified for daily maintenance operations. @@ -682,11 +682,11 @@ export namespace container_v1beta1 { /** * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ - duration?: string; + duration?: string | null; /** * Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. */ - startTime?: string; + startTime?: string | null; } /** * Configuration of etcd encryption. @@ -695,11 +695,11 @@ export namespace container_v1beta1 { /** * Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key */ - keyName?: string; + keyName?: string | null; /** * Denotes the state of etcd encryption. */ - state?: string; + state?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -712,11 +712,11 @@ export namespace container_v1beta1 { /** * The feature that is being configured with this value. */ - feature?: string; + feature?: string | null; /** * The tier in which the configured feature resides. */ - tier?: string; + tier?: string | null; } /** * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 @@ -742,31 +742,31 @@ export namespace container_v1beta1 { /** * Supported claims. */ - claims_supported?: string[]; + claims_supported?: string[] | null; /** * Supported grant types. */ - grant_types?: string[]; + grant_types?: string[] | null; /** * supported ID Token signing Algorithms. */ - id_token_signing_alg_values_supported?: string[]; + id_token_signing_alg_values_supported?: string[] | null; /** * OIDC Issuer. */ - issuer?: string; + issuer?: string | null; /** * JSON Web Key uri. */ - jwks_uri?: string; + jwks_uri?: string | null; /** * Supported response types. */ - response_types_supported?: string[]; + response_types_supported?: string[] | null; /** * Supported subject types. */ - subject_types_supported?: string[]; + subject_types_supported?: string[] | null; } /** * Configuration options 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. @@ -775,7 +775,7 @@ export namespace container_v1beta1 { /** * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service. */ - disabled?: boolean; + disabled?: boolean | null; } /** * RFC-2616: cache control support @@ -784,15 +784,15 @@ export namespace container_v1beta1 { /** * 14.6 response cache age, in seconds since the response is generated */ - age?: string; + age?: string | null; /** * 14.9 request and response directives */ - directive?: string; + directive?: string | null; /** * 14.21 response cache expires, in RFC 1123 date format */ - expires?: string; + expires?: string | null; } /** * Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. @@ -801,7 +801,7 @@ export namespace container_v1beta1 { /** * Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. */ - disabled?: boolean; + disabled?: boolean | null; } /** * IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. @@ -810,7 +810,7 @@ export namespace container_v1beta1 { /** * Enables intra node visibility for this cluster. */ - enabled?: boolean; + enabled?: boolean | null; } /** * Configuration for controlling how IPs are allocated in the cluster. @@ -819,55 +819,55 @@ export namespace container_v1beta1 { /** * If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. */ - allowRouteOverlap?: boolean; + allowRouteOverlap?: boolean | null; /** * This field is deprecated, use cluster_ipv4_cidr_block. */ - clusterIpv4Cidr?: string; + clusterIpv4Cidr?: string | null; /** * The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - clusterIpv4CidrBlock?: string; + clusterIpv4CidrBlock?: string | null; /** * The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. */ - clusterSecondaryRangeName?: string; + clusterSecondaryRangeName?: string | null; /** * Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. */ - createSubnetwork?: boolean; + createSubnetwork?: boolean | null; /** * This field is deprecated, use node_ipv4_cidr_block. */ - nodeIpv4Cidr?: string; + nodeIpv4Cidr?: string | null; /** * The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - nodeIpv4CidrBlock?: string; + nodeIpv4CidrBlock?: string | null; /** * This field is deprecated, use services_ipv4_cidr_block. */ - servicesIpv4Cidr?: string; + servicesIpv4Cidr?: string | null; /** * The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - servicesIpv4CidrBlock?: string; + servicesIpv4CidrBlock?: string | null; /** * The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. */ - servicesSecondaryRangeName?: string; + servicesSecondaryRangeName?: string | null; /** * A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. */ - subnetworkName?: string; + subnetworkName?: string | null; /** * The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ - tpuIpv4CidrBlock?: string; + tpuIpv4CidrBlock?: string | null; /** * Whether alias IPs will be used for pod IPs in the cluster. */ - useIpAliases?: boolean; + useIpAliases?: boolean | null; } /** * Configuration options for Istio addon. @@ -876,11 +876,11 @@ export namespace container_v1beta1 { /** * The specified Istio auth mode, either none, or mutual TLS. */ - auth?: string; + auth?: string | null; /** * Whether Istio is enabled for this cluster. */ - disabled?: boolean; + disabled?: boolean | null; } /** * Jwk is a JSON Web Key as specified in RFC 7517 @@ -889,39 +889,39 @@ export namespace container_v1beta1 { /** * Algorithm. */ - alg?: string; + alg?: string | null; /** * Used for ECDSA keys. */ - crv?: string; + crv?: string | null; /** * Used for RSA keys. */ - e?: string; + e?: string | null; /** * Key ID. */ - kid?: string; + kid?: string | null; /** * Key Type. */ - kty?: string; + kty?: string | null; /** * Used for RSA keys. */ - n?: string; + n?: string | null; /** * Permitted uses for the public keys. */ - use?: string; + use?: string | null; /** * Used for ECDSA keys. */ - x?: string; + x?: string | null; /** * Used for ECDSA keys. */ - y?: string; + y?: string | null; } /** * Configuration for the Kubernetes Dashboard. @@ -930,7 +930,7 @@ export namespace container_v1beta1 { /** * Whether the Kubernetes Dashboard is enabled for this cluster. */ - disabled?: boolean; + disabled?: boolean | null; } /** * Configuration for the legacy Attribute Based Access Control authorization mode. @@ -939,7 +939,7 @@ export namespace container_v1beta1 { /** * Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. */ - enabled?: boolean; + enabled?: boolean | null; } /** * ListClustersResponse is the result of ListClustersRequest. @@ -952,7 +952,7 @@ export namespace container_v1beta1 { /** * If any zones are listed here, the list of clusters returned may be missing those zones. */ - missingZones?: string[]; + missingZones?: string[] | null; } /** * ListLocationsResponse returns the list of all GKE locations and their recommendation state. @@ -965,7 +965,7 @@ export namespace container_v1beta1 { /** * Only return ListLocationsResponse that occur after the page_token. This value should be populated from the ListLocationsResponse.next_page_token if that response token was set (which happens when listing more Locations than fit in a single ListLocationsResponse). */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * ListNodePoolsResponse is the result of ListNodePoolsRequest. @@ -983,7 +983,7 @@ export namespace container_v1beta1 { /** * If any zones are listed here, the list of operations returned may be missing the operations from those zones. */ - missingZones?: string[]; + missingZones?: string[] | null; /** * A list of operations in the project in the specified zone. */ @@ -996,7 +996,7 @@ export namespace container_v1beta1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `page_size`, use the `next_page_token` as a value for the query parameter `page_token` in the next request. The value will become empty when there are no more pages. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of usable subnetworks in the specified network project. */ @@ -1009,15 +1009,15 @@ export namespace container_v1beta1 { /** * Contains the name of the resource requested. Specified in the format 'projects/x/locations/*'. */ - name?: string; + name?: string | null; /** * Whether the location is recomended for GKE cluster scheduling. */ - recommended?: boolean; + recommended?: boolean | null; /** * Contains the type of location this Location is for. Regional or Zonal. */ - type?: string; + type?: string | null; } /** * MaintenancePolicy defines the maintenance policy to be used for the cluster. @@ -1044,7 +1044,7 @@ export namespace container_v1beta1 { /** * [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. */ - clientCertificate?: string; + clientCertificate?: string | null; /** * Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. */ @@ -1052,16 +1052,16 @@ export namespace container_v1beta1 { /** * [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. */ - clientKey?: string; - clusterCaCertificate?: string; + clientKey?: string | null; + clusterCaCertificate?: string | null; /** * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. */ - password?: string; + password?: string | null; /** * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). */ - username?: string; + username?: string | null; } /** * Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. @@ -1074,7 +1074,7 @@ export namespace container_v1beta1 { /** * Whether or not master authorized networks is enabled. */ - enabled?: boolean; + enabled?: boolean | null; } /** * Constraints applied to pods. @@ -1083,7 +1083,7 @@ export namespace container_v1beta1 { /** * Constraint enforced on the max num of pods per node. */ - maxPodsPerNode?: string; + maxPodsPerNode?: string | null; } /** * Progress metric is (string, int|float|string) pair. @@ -1092,19 +1092,19 @@ export namespace container_v1beta1 { /** * For metrics with floating point value. */ - doubleValue?: number; + doubleValue?: number | null; /** * For metrics with integer value. */ - intValue?: string; + intValue?: string | null; /** * Metric name, required. e.g., "nodes total", "percent done" */ - name?: string; + name?: string | null; /** * For metrics with custom values (ratios, visual progress, etc.). */ - stringValue?: string; + stringValue?: string | null; } /** * NetworkConfig reports the relative names of network & subnetwork. @@ -1113,15 +1113,15 @@ export namespace container_v1beta1 { /** * Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. */ - enableIntraNodeVisibility?: boolean; + enableIntraNodeVisibility?: boolean | null; /** * Output only. The relative name of the Google Compute Engine network(/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network */ - network?: string; + network?: string | null; /** * Output only. The relative name of the Google Compute Engine [subnetwork](/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ - subnetwork?: string; + subnetwork?: string | null; } /** * Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ @@ -1130,11 +1130,11 @@ export namespace container_v1beta1 { /** * Whether network policy is enabled on the cluster. */ - enabled?: boolean; + enabled?: boolean | null; /** * The selected network policy provider. */ - provider?: string; + provider?: string | null; } /** * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -1143,7 +1143,7 @@ export namespace container_v1beta1 { /** * Whether NetworkPolicy is enabled for this cluster. */ - disabled?: boolean; + disabled?: boolean | null; } /** * Parameters that describe the nodes in a cluster. @@ -1156,43 +1156,43 @@ export namespace container_v1beta1 { /** * Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. */ - diskSizeGb?: number; + diskSizeGb?: number | null; /** * Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard' */ - diskType?: string; + diskType?: string | null; /** * The image type to use for this node. Note that for a given image type, the latest version of it will be used. */ - imageType?: string; + imageType?: string | null; /** * The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information. */ - localSsdCount?: number; + localSsdCount?: number | null; /** * The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`. */ - machineType?: string; + 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. */ - metadata?: {[key: string]: string}; + 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) */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. */ - oauthScopes?: string[]; + oauthScopes?: string[] | null; /** * 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; + preemptible?: boolean | null; /** * Sandbox configuration for this node. */ @@ -1200,7 +1200,7 @@ export namespace container_v1beta1 { /** * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Shielded Instance options. */ @@ -1208,7 +1208,7 @@ export namespace container_v1beta1 { /** * The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. */ - tags?: string[]; + tags?: string[] | null; /** * List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ */ @@ -1225,11 +1225,11 @@ export namespace container_v1beta1 { /** * Whether the nodes will be automatically repaired. */ - autoRepair?: boolean; + autoRepair?: boolean | null; /** * Whether the nodes will be automatically upgraded. */ - autoUpgrade?: boolean; + autoUpgrade?: boolean | null; /** * Specifies the Auto Upgrade knobs for the node pool. */ @@ -1254,15 +1254,15 @@ export namespace container_v1beta1 { /** * The initial node count for the pool. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. */ - initialNodeCount?: number; + initialNodeCount?: number | null; /** * [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. */ - instanceGroupUrls?: string[]; + instanceGroupUrls?: string[] | null; /** * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes should be located. */ - locations?: string[]; + locations?: string[] | null; /** * NodeManagement configuration for this NodePool. */ @@ -1274,27 +1274,27 @@ export namespace container_v1beta1 { /** * The name of the node pool. */ - name?: string; + name?: string | null; /** * [Output only] The pod CIDR block size per node in this node pool. */ - podIpv4CidrSize?: number; + podIpv4CidrSize?: number | null; /** * [Output only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] The status of the nodes in this pool instance. */ - status?: string; + status?: string | null; /** * [Output only] Additional information about the current status of this node pool instance, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * The version of the Kubernetes of this node. */ - version?: string; + version?: string | null; } /** * NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. @@ -1303,19 +1303,19 @@ export namespace container_v1beta1 { /** * Can this node pool be deleted automatically. */ - autoprovisioned?: boolean; + autoprovisioned?: boolean | null; /** * Is autoscaling enabled for this node pool. */ - enabled?: boolean; + enabled?: boolean | null; /** * Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster. */ - maxNodeCount?: number; + maxNodeCount?: number | null; /** * Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. */ - minNodeCount?: number; + minNodeCount?: number | null; } /** * Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ @@ -1324,15 +1324,15 @@ export namespace container_v1beta1 { /** * Effect for taint. */ - effect?: string; + effect?: string | null; /** * Key for taint. */ - key?: string; + key?: string | null; /** * Value for taint. */ - value?: string; + value?: string | null; } /** * This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. @@ -1345,19 +1345,19 @@ export namespace container_v1beta1 { /** * Detailed operation progress, if available. */ - detail?: string; + detail?: string | null; /** * [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - endTime?: string; + endTime?: string | null; /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ - location?: string; + location?: string | null; /** * The server-assigned ID for the operation. */ - name?: string; + name?: string | null; /** * Which conditions caused the current node pool state. */ @@ -1365,7 +1365,7 @@ export namespace container_v1beta1 { /** * The operation type. */ - operationType?: string; + operationType?: string | null; /** * [Output only] Progress information for an operation. */ @@ -1373,27 +1373,27 @@ export namespace container_v1beta1 { /** * Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ - startTime?: string; + startTime?: string | null; /** * The current status of the operation. */ - status?: string; + status?: string | null; /** * If an error has occurred, a textual description of the error. */ - statusMessage?: string; + statusMessage?: string | null; /** * Server-defined URL for the target of the operation. */ - targetLink?: string; + targetLink?: string | null; /** * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ - zone?: string; + zone?: string | null; } /** * Information about operation (or operation stage) progress. @@ -1406,7 +1406,7 @@ export namespace container_v1beta1 { /** * A non-parameterized string describing an operation stage. Unset for single-stage operations. */ - name?: string; + name?: string | null; /** * Substages of an operation or a stage. */ @@ -1414,7 +1414,7 @@ export namespace container_v1beta1 { /** * Status of an operation stage. Unset for single-stage operations. */ - status?: string; + status?: string | null; } /** * Configuration for the PodSecurityPolicy feature. @@ -1423,7 +1423,7 @@ export namespace container_v1beta1 { /** * Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created. */ - enabled?: boolean; + enabled?: boolean | null; } /** * PremiumConfig is the configuration for all premium features and tiers. @@ -1445,27 +1445,27 @@ export namespace container_v1beta1 { /** * Whether to enable route sharing over the network peering. */ - enablePeeringRouteSharing?: boolean; + enablePeeringRouteSharing?: boolean | null; /** * Whether the master's internal IP address is used as the cluster endpoint. */ - enablePrivateEndpoint?: boolean; + enablePrivateEndpoint?: boolean | null; /** * Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. */ - enablePrivateNodes?: boolean; + enablePrivateNodes?: boolean | null; /** * The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network. */ - masterIpv4CidrBlock?: string; + masterIpv4CidrBlock?: string | null; /** * Output only. The internal IP address of this cluster's master endpoint. */ - privateEndpoint?: string; + privateEndpoint?: string | null; /** * Output only. The external IP address of this cluster's master endpoint. */ - publicEndpoint?: string; + publicEndpoint?: string | null; } /** * ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk and frequency of updates. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. Updates to version related fields (e.g. current_master_version) return an error. @@ -1474,7 +1474,7 @@ export namespace container_v1beta1 { /** * channel specifies which release channel the cluster is subscribed to. */ - channel?: string; + channel?: string | null; } /** * ReleaseChannelConfig exposes configuration for a release channel. @@ -1483,11 +1483,11 @@ export namespace container_v1beta1 { /** * The release channel this configuration applies to. */ - channel?: string; + channel?: string | null; /** * The default version for newly created clusters on the channel. */ - defaultVersion?: string; + defaultVersion?: string | null; } /** * Contains information about amount of some resource in the cluster. For memory, value should be in GB. @@ -1496,15 +1496,15 @@ export namespace container_v1beta1 { /** * Maximum amount of the resource in the cluster. */ - maximum?: string; + maximum?: string | null; /** * Minimum amount of the resource in the cluster. */ - minimum?: string; + minimum?: string | null; /** * Resource name "cpu", "memory" or gpu-specific string. */ - resourceType?: string; + resourceType?: string | null; } /** * Configuration for exporting cluster resource usages. @@ -1521,7 +1521,7 @@ export namespace container_v1beta1 { /** * Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. */ - enableNetworkEgressMetering?: boolean; + enableNetworkEgressMetering?: boolean | null; } /** * RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. @@ -1530,23 +1530,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SandboxConfig contains configurations of the sandbox to use for the node. @@ -1555,7 +1555,7 @@ export namespace container_v1beta1 { /** * Type of the sandbox to use for the node (e.g. 'gvisor') */ - sandboxType?: string; + sandboxType?: string | null; } /** * Kubernetes Engine service configuration. @@ -1568,11 +1568,11 @@ export namespace container_v1beta1 { /** * Version of Kubernetes the service deploys by default. */ - defaultClusterVersion?: string; + defaultClusterVersion?: string | null; /** * Default image type. */ - defaultImageType?: string; + defaultImageType?: string | null; /** * Premium configuration for service. */ @@ -1580,15 +1580,15 @@ export namespace container_v1beta1 { /** * List of valid image types. */ - validImageTypes?: string[]; + validImageTypes?: string[] | null; /** * List of valid master versions. */ - validMasterVersions?: string[]; + validMasterVersions?: string[] | null; /** * List of valid node upgrade target versions. */ - validNodeVersions?: string[]; + validNodeVersions?: string[] | null; } /** * SetAddonsRequest sets the addons associated with the cluster. @@ -1601,19 +1601,19 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster @@ -1622,27 +1622,27 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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. */ - labelFingerprint?: string; + labelFingerprint?: string | null; /** * The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * The labels to set for that cluster. */ - resourceLabels?: {[key: string]: string}; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. @@ -1651,23 +1651,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * Whether ABAC authorization will be enabled in the cluster. */ - enabled?: boolean; + enabled?: boolean | null; /** * The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLocationsRequest sets the locations of the cluster. @@ -1676,23 +1676,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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. */ - locations?: string[]; + locations?: string[] | null; /** * The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetLoggingServiceRequest sets the logging service of a cluster. @@ -1701,23 +1701,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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 */ - loggingService?: string; + loggingService?: string | null; /** * The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetMaintenancePolicyRequest sets the maintenance policy for a cluster. @@ -1726,7 +1726,7 @@ export namespace container_v1beta1 { /** * The name of the cluster to update. */ - clusterId?: string; + clusterId?: string | null; /** * The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. */ @@ -1734,15 +1734,15 @@ export namespace container_v1beta1 { /** * The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + name?: string | null; /** * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ - projectId?: string; + projectId?: string | null; /** * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ - zone?: string; + zone?: string | null; } /** * SetMasterAuthRequest updates the admin password of a cluster. @@ -1751,19 +1751,19 @@ export namespace container_v1beta1 { /** * The exact form of action to be taken on the master auth. */ - action?: string; + action?: string | null; /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * A description of the update. */ @@ -1771,7 +1771,7 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the 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; + zone?: string | null; } /** * SetMonitoringServiceRequest sets the monitoring service of a cluster. @@ -1780,23 +1780,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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 */ - monitoringService?: string; + monitoringService?: string | null; /** * The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNetworkPolicyRequest enables/disables network policy for a cluster. @@ -1805,11 +1805,11 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + name?: string | null; /** * Configuration options for the NetworkPolicy feature. */ @@ -1817,11 +1817,11 @@ export namespace container_v1beta1 { /** * 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; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. @@ -1834,23 +1834,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNodePoolManagementRequest sets the node management properties of a node pool. @@ -1859,7 +1859,7 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * NodeManagement configuration for the node pool. */ @@ -1867,19 +1867,19 @@ export namespace container_v1beta1 { /** * The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNodePoolSizeRequest sets the size a node pool. @@ -1888,27 +1888,27 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * The desired node count for the pool. */ - nodeCount?: number; + nodeCount?: number | null; /** * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * A set of Shielded Instance options. @@ -1917,11 +1917,11 @@ export namespace container_v1beta1 { /** * Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. */ - enableIntegrityMonitoring?: boolean; + enableIntegrityMonitoring?: boolean | null; /** * Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. */ - enableSecureBoot?: boolean; + enableSecureBoot?: boolean | null; } /** * Configuration of Shielded Nodes feature. @@ -1930,7 +1930,7 @@ export namespace container_v1beta1 { /** * Whether Shielded Nodes features are enabled on all nodes in this cluster. */ - enabled?: boolean; + enabled?: boolean | null; } /** * StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. @@ -1939,23 +1939,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * Whether to rotate credentials during IP rotation. */ - rotateCredentials?: boolean; + 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. */ - zone?: string; + zone?: string | null; } /** * StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1964,11 +1964,11 @@ export namespace container_v1beta1 { /** * Machine-friendly representation of the condition */ - code?: string; + code?: string | null; /** * Human-friendly representation of the condition */ - message?: string; + message?: string | null; } /** * TierConfig is the configuration for a tier offering. For example the GKE standard or advanced offerings which contain different levels of functionality and possibly cost. @@ -1977,11 +1977,11 @@ export namespace container_v1beta1 { /** * The tier from which the tier being configured inherits. The configured tier will inherit all the features from its parent tier. */ - parent?: string; + parent?: string | null; /** * The tier that is being configured with this value. */ - tier?: string; + tier?: string | null; } /** * Cluster tier settings. @@ -1990,7 +1990,7 @@ export namespace container_v1beta1 { /** * Cluster tier. */ - tier?: string; + tier?: string | null; } /** * UpdateClusterRequest updates the settings of a cluster. @@ -1999,15 +1999,15 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * A description of the update. */ @@ -2015,7 +2015,7 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the 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; + zone?: string | null; } /** * UpdateMasterRequest updates the master of the cluster. @@ -2024,23 +2024,23 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + 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 */ - masterVersion?: string; + masterVersion?: string | null; /** * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ - name?: string; + 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. */ - projectId?: string; + 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. */ - zone?: string; + zone?: string | null; } /** * SetNodePoolVersionRequest updates the version of a node pool. @@ -2049,31 +2049,31 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ - clusterId?: string; + clusterId?: string | null; /** * The desired image type for the node pool. */ - imageType?: string; + imageType?: string | null; /** * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. */ - locations?: string[]; + locations?: string[] | null; /** * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ - name?: string; + name?: string | null; /** * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ - nodePoolId?: string; + 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 */ - nodeVersion?: string; + 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. */ - projectId?: string; + projectId?: string | null; /** * The desired image type for the node pool. */ @@ -2081,7 +2081,7 @@ export namespace container_v1beta1 { /** * Deprecated. The name of the 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; + zone?: string | null; } /** * UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range. @@ -2090,11 +2090,11 @@ export namespace container_v1beta1 { /** * The range of internal addresses that are owned by this subnetwork. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Network Name. Example: projects/my-project/global/networks/my-network */ - network?: string; + network?: string | null; /** * Secondary IP ranges. */ @@ -2102,11 +2102,11 @@ export namespace container_v1beta1 { /** * A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message. */ - statusMessage?: string; + statusMessage?: string | null; /** * Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ - subnetwork?: string; + subnetwork?: string | null; } /** * Secondary IP range of a usable subnetwork. @@ -2115,15 +2115,15 @@ export namespace container_v1beta1 { /** * The range of IP addresses belonging to this subnetwork secondary range. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. */ - rangeName?: string; + rangeName?: string | null; /** * This field is to determine the status of the secondary range programmably. */ - status?: string; + status?: string | null; } /** * VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. @@ -2132,7 +2132,7 @@ export namespace container_v1beta1 { /** * Enables vertical pod autoscaling. */ - enabled?: boolean; + enabled?: boolean | null; } /** * Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. @@ -2141,7 +2141,7 @@ export namespace container_v1beta1 { /** * IAM Identity Namespace to attach all Kubernetes Service Accounts to. */ - identityNamespace?: string; + identityNamespace?: string | null; } /** * WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. @@ -2150,7 +2150,7 @@ export namespace container_v1beta1 { /** * NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. */ - nodeMetadata?: string; + nodeMetadata?: string | null; } export class Resource$Projects { diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index cf2fc422980..40258cb68f2 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -126,19 +126,19 @@ export namespace containeranalysis_v1alpha1 { /** * Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. */ - checksum?: string; + checksum?: string | null; /** * Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 */ - id?: string; + id?: string | null; /** * Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. */ - name?: string; + name?: string | null; /** * Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. */ - names?: string[]; + names?: string[] | null; } /** * Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). @@ -159,7 +159,7 @@ export namespace containeranalysis_v1alpha1 { /** * The human readable name of this Attestation Authority, for example "qa". */ - humanReadableName?: string; + humanReadableName?: string | null; } /** * Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM <Basis.resource_url> Or an equivalent reference, e.g. a tag of the resource_url. @@ -172,7 +172,7 @@ export namespace containeranalysis_v1alpha1 { /** * The resource_url for the resource representing the basis of associated occurrence images. */ - resourceUrl?: string; + resourceUrl?: string | null; } /** * Associates `members` with a `role`. @@ -185,11 +185,11 @@ export namespace containeranalysis_v1alpha1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Message encapsulating build provenance details. @@ -202,7 +202,7 @@ export namespace containeranalysis_v1alpha1 { /** * Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. */ - provenanceBytes?: string; + provenanceBytes?: string | null; } /** * Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. @@ -211,11 +211,11 @@ export namespace containeranalysis_v1alpha1 { /** * Version string of the builder at the time this build was executed. */ - builderVersion?: string; + builderVersion?: string | null; /** * Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. */ - buildOptions?: {[key: string]: string}; + buildOptions?: {[key: string]: string} | null; /** * Output of the build. */ @@ -227,27 +227,27 @@ export namespace containeranalysis_v1alpha1 { /** * Time at which the build was created. */ - createTime?: string; + createTime?: string | null; /** * E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. */ - creator?: string; + creator?: string | null; /** * Time at which execution of the build was finished. */ - finishTime?: string; + finishTime?: string | null; /** * Unique identifier of the build. */ - id?: string; + id?: string | null; /** * Google Cloud Storage bucket where logs were written. */ - logsBucket?: string; + logsBucket?: string | null; /** * ID of the project. */ - projectId?: string; + projectId?: string | null; /** * Details of the Source input to the build. */ @@ -255,11 +255,11 @@ export namespace containeranalysis_v1alpha1 { /** * Time at which execution of the build was started. */ - startTime?: string; + startTime?: string | null; /** * Trigger identifier if the build was triggered automatically; empty if not. */ - triggerId?: string; + triggerId?: string | null; } /** * Message encapsulating the signature of the verified build. @@ -268,19 +268,19 @@ export namespace containeranalysis_v1alpha1 { /** * An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service). */ - keyId?: string; + keyId?: string | null; /** * The type of the key, either stored in `public_key` or referenced in `key_id` */ - keyType?: string; + keyType?: string | null; /** * Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin` */ - publicKey?: string; + publicKey?: string | null; /** * Signature of the related `BuildProvenance`, encoded in a base64 string. */ - signature?: string; + signature?: string | null; } /** * Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. @@ -289,7 +289,7 @@ export namespace containeranalysis_v1alpha1 { /** * Version of the builder which produced this Note. */ - builderVersion?: string; + builderVersion?: string | null; /** * Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. */ @@ -302,27 +302,27 @@ export namespace containeranalysis_v1alpha1 { /** * Command-line arguments used when executing this Command. */ - args?: string[]; + args?: string[] | null; /** * Working directory (relative to project source root) used when running this Command. */ - dir?: string; + dir?: string | null; /** * Environment variables set before running this Command. */ - env?: string[]; + env?: string[] | null; /** * Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. */ - id?: string; + id?: string | null; /** * Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. */ - name?: string; + name?: string | null; /** * The ID(s) of the Command(s) that this Command depends on. */ - waitFor?: string[]; + waitFor?: string[] | null; } /** * Request for creating an operation @@ -335,7 +335,7 @@ export namespace containeranalysis_v1alpha1 { /** * The ID to use for this operation. */ - operationId?: string; + operationId?: string | null; } /** * An artifact that can be deployed in some runtime. @@ -344,7 +344,7 @@ export namespace containeranalysis_v1alpha1 { /** * Resource URI for the artifact being deployed. */ - resourceUri?: string[]; + resourceUri?: string[] | null; } /** * The period during which some deployable was active in a runtime. @@ -353,31 +353,31 @@ export namespace containeranalysis_v1alpha1 { /** * Address of the runtime element hosting this deployment. */ - address?: string; + address?: string | null; /** * Configuration used to create this deployment. */ - config?: string; + config?: string | null; /** * Beginning of the lifetime of this deployment. */ - deployTime?: string; + deployTime?: string | null; /** * Platform hosting this deployment. */ - platform?: string; + platform?: string | null; /** * Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. */ - resourceUri?: string[]; + resourceUri?: string[] | null; /** * End of the lifetime of this deployment. */ - undeployTime?: string; + undeployTime?: string | null; /** * Identity of the user that triggered this deployment. */ - userEmail?: string; + userEmail?: string | null; } /** * Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM <DockerImage.Basis in attached Note>. @@ -386,11 +386,11 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. This contains the base image URL for the derived image occurrence. */ - baseResourceUrl?: string; + baseResourceUrl?: string | null; /** * Output only. The number of layers by which this image differs from the associated image basis. */ - distance?: number; + distance?: number | null; /** * The fingerprint of the derived image. */ @@ -407,11 +407,11 @@ export namespace containeranalysis_v1alpha1 { /** * The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. */ - cpeUri?: string; + cpeUri?: string | null; /** * A vendor-specific description of this note. */ - description?: string; + description?: string | null; /** * The fix for this specific package version. */ @@ -419,7 +419,7 @@ export namespace containeranalysis_v1alpha1 { /** * Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. */ - isObsolete?: boolean; + isObsolete?: boolean | null; /** * The max version of the package in which the vulnerability exists. */ @@ -431,15 +431,15 @@ export namespace containeranalysis_v1alpha1 { /** * The name of the package where the vulnerability was found. This field can be used as a filter in list requests. */ - package?: string; + package?: string | null; /** * The type of package; whether native or non native(ruby gems, node.js packages etc) */ - packageType?: string; + packageType?: string | null; /** * The severity (eg: distro assigned severity) for this vulnerability. */ - severityName?: string; + severityName?: string | null; } /** * Provides information about the scan status of a discovered resource. @@ -448,7 +448,7 @@ export namespace containeranalysis_v1alpha1 { /** * The status of discovery for the resource. */ - analysisStatus?: string; + analysisStatus?: string | null; /** * When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. */ @@ -456,7 +456,7 @@ export namespace containeranalysis_v1alpha1 { /** * Whether the resource is continuously analyzed. */ - continuousAnalysis?: string; + continuousAnalysis?: string | null; /** * Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. */ @@ -469,7 +469,7 @@ export namespace containeranalysis_v1alpha1 { /** * The kind of analysis that is handled by this discovery. */ - analysisKind?: string; + analysisKind?: string | null; } /** * This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror @@ -478,15 +478,15 @@ export namespace containeranalysis_v1alpha1 { /** * The CPU architecture for which packages in this distribution channel were built */ - architecture?: string; + architecture?: string | null; /** * The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ - cpeUri?: string; + cpeUri?: string | null; /** * The distribution channel-specific description of this package. */ - description?: string; + description?: string | null; /** * The latest available version of this package in this distribution channel. */ @@ -494,11 +494,11 @@ export namespace containeranalysis_v1alpha1 { /** * A freeform string denoting the maintainer of this package. */ - maintainer?: string; + maintainer?: string | null; /** * The distribution channel-specific homepage for this package. */ - url?: string; + url?: 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 `{}`. @@ -511,19 +511,19 @@ export namespace containeranalysis_v1alpha1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. @@ -541,15 +541,15 @@ export namespace containeranalysis_v1alpha1 { /** * The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. */ - v1Name?: string; + v1Name?: string | null; /** * The ordered list of v2 blobs that represent a given image. */ - v2Blob?: string[]; + v2Blob?: string[] | null; /** * Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. */ - v2Name?: string; + v2Name?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -567,7 +567,7 @@ export namespace containeranalysis_v1alpha1 { /** * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * A summary of how many vulnz occurrences there are per severity type. counts by groups, or if we should have different summary messages like this. @@ -585,11 +585,11 @@ export namespace containeranalysis_v1alpha1 { /** * The alias kind. */ - kind?: string; + kind?: string | null; /** * The alias name. */ - name?: string; + name?: string | null; } /** * A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. @@ -606,7 +606,7 @@ export namespace containeranalysis_v1alpha1 { /** * A revision ID. */ - revisionId?: string; + revisionId?: string | null; } /** * A SourceContext referring to a Gerrit project. @@ -619,15 +619,15 @@ export namespace containeranalysis_v1alpha1 { /** * The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. */ - gerritProject?: string; + gerritProject?: string | null; /** * The URI of a running Gerrit instance. */ - hostUri?: string; + hostUri?: string | null; /** * A revision (commit) ID. */ - revisionId?: string; + revisionId?: string | null; } /** * A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). @@ -636,11 +636,11 @@ export namespace containeranalysis_v1alpha1 { /** * Required. Git commit hash. */ - revisionId?: string; + revisionId?: string | null; /** * Git repository URL. */ - url?: string; + url?: string | null; } /** * Metadata for all operations used and required for all operations that created by Container Analysis Providers @@ -649,11 +649,11 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. The time this operation was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The time that this operation was marked completed or failed. */ - endTime?: string; + endTime?: string | null; } /** * Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. @@ -662,11 +662,11 @@ export namespace containeranalysis_v1alpha1 { /** * The ID of the project. */ - projectId?: string; + projectId?: string | null; /** * The name of the repo. Leave empty for the default repo. */ - repoName?: string; + repoName?: string | null; } /** * A unique identifier for a Cloud Repo. @@ -679,7 +679,7 @@ export namespace containeranalysis_v1alpha1 { /** * A server-assigned, globally unique identifier. */ - uid?: string; + uid?: string | null; } /** * A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. @@ -700,7 +700,7 @@ export namespace containeranalysis_v1alpha1 { /** * Labels with user defined metadata. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } /** * Container message for hash values. @@ -709,11 +709,11 @@ export namespace containeranalysis_v1alpha1 { /** * The type of hash that was performed. */ - type?: string; + type?: string | null; /** * The hash value. */ - value?: string; + value?: string | null; } /** * This represents how a particular software package may be installed on a system. @@ -726,7 +726,7 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. The name of the installed package. */ - name?: string; + name?: string | null; } /** * Layer holds metadata specific to a layer of a Docker image. @@ -735,11 +735,11 @@ export namespace containeranalysis_v1alpha1 { /** * The recovered arguments to the Dockerfile directive. */ - arguments?: string; + arguments?: string | null; /** * The recovered Dockerfile directive used to construct this layer. */ - directive?: string; + directive?: string | null; } /** * Response including listed occurrences for a note. @@ -748,7 +748,7 @@ export namespace containeranalysis_v1alpha1 { /** * Token to receive the next page of notes. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The occurrences attached to the specified note. */ @@ -761,7 +761,7 @@ export namespace containeranalysis_v1alpha1 { /** * The next pagination token in the list response. It should be used as page_token for the following request. An empty value means no more result. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The occurrences requested */ @@ -774,7 +774,7 @@ export namespace containeranalysis_v1alpha1 { /** * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The occurrences requested. */ @@ -787,7 +787,7 @@ export namespace containeranalysis_v1alpha1 { /** * A page token to pass in order to get more scan configs. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The set of scan configs. */ @@ -800,11 +800,11 @@ export namespace containeranalysis_v1alpha1 { /** * The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ - cpeUri?: string; + cpeUri?: string | null; /** * The path from which we gathered that this package/version is installed. */ - path?: string; + path?: string | null; /** * The version installed at this location. */ @@ -829,7 +829,7 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. The time this note was created. This field can be used as a filter in list requests. */ - createTime?: string; + createTime?: string | null; /** * A note describing something that can be deployed. */ @@ -841,19 +841,19 @@ export namespace containeranalysis_v1alpha1 { /** * Time of expiration for this note, null if note does not expire. */ - expirationTime?: string; + expirationTime?: string | null; /** * Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. */ - kind?: string; + kind?: string | null; /** * A detailed description of this `Note`. */ - longDescription?: string; + longDescription?: string | null; /** * The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" */ - name?: string; + name?: string | null; /** * A note describing a package hosted by various package managers. */ @@ -865,11 +865,11 @@ export namespace containeranalysis_v1alpha1 { /** * A one sentence description of this `Note`. */ - shortDescription?: string; + shortDescription?: string | null; /** * Output only. The time this note was last updated. This field can be used as a filter in list requests. */ - updateTime?: string; + updateTime?: string | null; /** * A note describing an upgrade. */ @@ -894,7 +894,7 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. The time this `Occurrence` was created. */ - createTime?: string; + createTime?: string | null; /** * Describes the deployment of an artifact on a runtime. */ @@ -914,19 +914,19 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. */ - kind?: string; + kind?: string | null; /** * Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" */ - name?: string; + name?: string | null; /** * An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. */ - noteName?: string; + noteName?: string | null; /** * A description of actions that can be taken to remedy the `Note` */ - remediation?: string; + remediation?: string | null; /** * The resource for which the `Occurrence` applies. */ @@ -934,11 +934,11 @@ export namespace containeranalysis_v1alpha1 { /** * The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. */ - resourceUrl?: string; + resourceUrl?: string | null; /** * Output only. The time this `Occurrence` was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * Describes an upgrade. */ @@ -955,7 +955,7 @@ export namespace containeranalysis_v1alpha1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -963,15 +963,15 @@ export namespace containeranalysis_v1alpha1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. @@ -984,7 +984,7 @@ export namespace containeranalysis_v1alpha1 { /** * The name of the package. */ - name?: string; + name?: string | null; } /** * This message wraps a location affected by a vulnerability and its associated fix (if one is available). @@ -998,7 +998,7 @@ export namespace containeranalysis_v1alpha1 { * The location of the available fix for vulnerability. */ fixedLocation?: Schema$VulnerabilityLocation; - severityName?: string; + severityName?: string | null; } /** * An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. @@ -1007,15 +1007,15 @@ export namespace containeranalysis_v1alpha1 { /** * Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). */ - contentType?: string; + contentType?: string | null; /** * The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...<SNIP>... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. */ - pgpKeyId?: string; + pgpKeyId?: string | null; /** * The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. */ - signature?: string; + signature?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -1028,11 +1028,11 @@ export namespace containeranalysis_v1alpha1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Metadata for any related URL information @@ -1041,11 +1041,11 @@ export namespace containeranalysis_v1alpha1 { /** * Label to describe usage of the URL */ - label?: string; + label?: string | null; /** * Specific URL to associate with the note */ - url?: string; + url?: string | null; } /** * RepoSource describes the location of the source in a Google Cloud Source Repository. @@ -1054,23 +1054,23 @@ export namespace containeranalysis_v1alpha1 { /** * Name of the branch to build. */ - branchName?: string; + branchName?: string | null; /** * Explicit commit SHA to build. */ - commitSha?: string; + commitSha?: string | null; /** * ID of the project that owns the repo. */ - projectId?: string; + projectId?: string | null; /** * Name of the repo. */ - repoName?: string; + repoName?: string | null; /** * Name of the tag to build. */ - tagName?: string; + tagName?: string | null; } /** * Resource is an entity that can have metadata. E.g., a Docker image. @@ -1083,11 +1083,11 @@ export namespace containeranalysis_v1alpha1 { /** * The name of the resource. E.g., the name of a Docker image - "Debian". */ - name?: string; + name?: string | null; /** * The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. */ - uri?: string; + uri?: string | null; } /** * Indicates various scans and whether they are turned on or off. @@ -1096,23 +1096,23 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. The time this scan config was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. A human-readable description of what the `ScanConfig` does. */ - description?: string; + description?: string | null; /** * Indicates whether the Scan is enabled. */ - enabled?: boolean; + enabled?: boolean | null; /** * Output only. The name of the ScanConfig in the form “projects/{project_id}/scanConfigs/{scan_config_id}". */ - name?: string; + name?: string | null; /** * Output only. The time this scan config was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -1130,11 +1130,11 @@ export namespace containeranalysis_v1alpha1 { /** * The number of occurrences with the severity. */ - count?: string; + count?: string | null; /** * The severity of the occurrences. */ - severity?: string; + severity?: string | null; } /** * Source describes the location of the source used for the build. @@ -1155,7 +1155,7 @@ export namespace containeranalysis_v1alpha1 { /** * Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. */ - fileHashes?: {[key: string]: Schema$FileHashes}; + fileHashes?: {[key: string]: Schema$FileHashes} | null; /** * If provided, get source from this location in a Cloud Repo. */ @@ -1172,15 +1172,15 @@ export namespace containeranalysis_v1alpha1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * StorageSource describes the location of the source in an archive file in Google Cloud Storage. @@ -1189,15 +1189,15 @@ export namespace containeranalysis_v1alpha1 { /** * Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ - bucket?: string; + bucket?: string | null; /** * Google Cloud Storage generation for the object. */ - generation?: string; + generation?: string | null; /** * Google Cloud Storage object containing source. */ - object?: string; + object?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -1206,7 +1206,7 @@ export namespace containeranalysis_v1alpha1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -1215,7 +1215,7 @@ export namespace containeranalysis_v1alpha1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Request for updating an existing operation @@ -1228,7 +1228,7 @@ export namespace containeranalysis_v1alpha1 { /** * The fields to update. */ - updateMask?: string; + updateMask?: string | null; } /** * The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. @@ -1237,19 +1237,19 @@ export namespace containeranalysis_v1alpha1 { /** * The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. */ - classification?: string; + classification?: string | null; /** * Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. */ - cpeUri?: string; + cpeUri?: string | null; /** * The cve that would be resolved by this upgrade. */ - cve?: string[]; + cve?: string[] | null; /** * The severity as specified by the upstream operating system. */ - severity?: string; + severity?: string | null; } /** * An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. @@ -1262,7 +1262,7 @@ export namespace containeranalysis_v1alpha1 { /** * Required - The package this Upgrade is for. */ - package?: string; + package?: string | null; /** * Required - The version of the package in machine + human readable form. */ @@ -1279,7 +1279,7 @@ export namespace containeranalysis_v1alpha1 { /** * Required - The package this Upgrade is for. */ - package?: string; + package?: string | null; /** * Required - The version of the package in a machine + human readable form. */ @@ -1292,19 +1292,19 @@ export namespace containeranalysis_v1alpha1 { /** * Used to correct mistakes in the version numbering scheme. */ - epoch?: number; + epoch?: number | null; /** * Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. */ - kind?: string; + kind?: string | null; /** * The main part of the version name. */ - name?: string; + name?: string | null; /** * The iteration of the package build from the above version. */ - revision?: string; + revision?: string | null; } /** * Used by Occurrence to point to where the vulnerability exists and how to fix it. @@ -1313,11 +1313,11 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. */ - cvssScore?: number; + cvssScore?: number | null; /** * The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. */ - effectiveSeverity?: string; + effectiveSeverity?: string | null; /** * The set of affected locations and their fixes (if available) within the associated resource. */ @@ -1325,11 +1325,11 @@ export namespace containeranalysis_v1alpha1 { /** * Output only. The note provider assigned Severity of the vulnerability. */ - severity?: string; + severity?: string | null; /** * The type of package; whether native or non native(ruby gems, node.js packages etc) */ - type?: string; + type?: string | null; } /** * The location of the vulnerability @@ -1338,11 +1338,11 @@ export namespace containeranalysis_v1alpha1 { /** * The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. */ - cpeUri?: string; + cpeUri?: string | null; /** * The package being described. */ - package?: string; + package?: string | null; /** * The version of the package being described. This field can be used as a filter in list requests. */ @@ -1355,7 +1355,7 @@ export namespace containeranalysis_v1alpha1 { /** * The CVSS score for this Vulnerability. */ - cvssScore?: number; + cvssScore?: number | null; /** * All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in. */ @@ -1363,7 +1363,7 @@ export namespace containeranalysis_v1alpha1 { /** * Note provider assigned impact of the vulnerability */ - severity?: string; + severity?: string | null; } export class Resource$Projects { diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index c3a822bf68b..1ce5db4d697 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -124,11 +124,11 @@ export namespace containeranalysis_v1beta1 { /** * The alias kind. */ - kind?: string; + kind?: string | null; /** * The alias name. */ - name?: string; + name?: string | null; } /** * Artifact describes a build product. @@ -137,15 +137,15 @@ export namespace containeranalysis_v1beta1 { /** * Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. */ - checksum?: string; + checksum?: string | null; /** * Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`. */ - id?: string; + id?: string | null; /** * Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. */ - names?: string[]; + names?: string[] | null; } /** * Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). @@ -177,7 +177,7 @@ export namespace containeranalysis_v1beta1 { /** * Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. */ - resourceUrl?: string; + resourceUrl?: string | null; } /** * Request to create notes in batch. @@ -186,7 +186,7 @@ export namespace containeranalysis_v1beta1 { /** * The notes to create. Max allowed length is 1000. */ - notes?: {[key: string]: Schema$Note}; + notes?: {[key: string]: Schema$Note} | null; } /** * Response for creating notes in batch. @@ -226,11 +226,11 @@ export namespace containeranalysis_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. @@ -239,7 +239,7 @@ export namespace containeranalysis_v1beta1 { /** * Required. Immutable. Version of the builder which produced this build. */ - builderVersion?: string; + builderVersion?: string | null; /** * Signature of the build in occurrences pointing to this build note containing build details. */ @@ -252,11 +252,11 @@ export namespace containeranalysis_v1beta1 { /** * Version string of the builder at the time this build was executed. */ - builderVersion?: string; + builderVersion?: string | null; /** * Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. */ - buildOptions?: {[key: string]: string}; + buildOptions?: {[key: string]: string} | null; /** * Output of the build. */ @@ -268,27 +268,27 @@ export namespace containeranalysis_v1beta1 { /** * Time at which the build was created. */ - createTime?: string; + createTime?: string | null; /** * E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. */ - creator?: string; + creator?: string | null; /** * Time at which execution of the build was finished. */ - endTime?: string; + endTime?: string | null; /** * Required. Unique identifier of the build. */ - id?: string; + id?: string | null; /** * URI where any logs for this provenance were written. */ - logsUri?: string; + logsUri?: string | null; /** * ID of the project. */ - projectId?: string; + projectId?: string | null; /** * Details of the Source input to the build. */ @@ -296,11 +296,11 @@ export namespace containeranalysis_v1beta1 { /** * Time at which execution of the build was started. */ - startTime?: string; + startTime?: string | null; /** * Trigger identifier if the build was triggered automatically; empty if not. */ - triggerId?: string; + triggerId?: string | null; } /** * Message encapsulating the signature of the verified build. @@ -309,19 +309,19 @@ export namespace containeranalysis_v1beta1 { /** * An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service). */ - keyId?: string; + keyId?: string | null; /** * The type of the key, either stored in `public_key` or referenced in `key_id`. */ - keyType?: string; + keyType?: string | null; /** * Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin` */ - publicKey?: string; + publicKey?: string | null; /** * Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. */ - signature?: string; + signature?: string | null; } /** * A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. @@ -338,7 +338,7 @@ export namespace containeranalysis_v1beta1 { /** * A revision ID. */ - revisionId?: string; + revisionId?: string | null; } /** * Command describes a step performed as part of the build pipeline. @@ -347,49 +347,49 @@ export namespace containeranalysis_v1beta1 { /** * Command-line arguments used when executing this command. */ - args?: string[]; + args?: string[] | null; /** * Working directory (relative to project source root) used when running this command. */ - dir?: string; + dir?: string | null; /** * Environment variables set before running this command. */ - env?: string[]; + env?: string[] | null; /** * Optional unique identifier for this command, used in wait_for to reference this command as a dependency. */ - id?: string; + id?: string | null; /** * Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. */ - name?: string; + name?: string | null; /** * The ID(s) of the command(s) that this command depends on. */ - waitFor?: string[]; + waitFor?: string[] | null; } /** * Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document */ export interface Schema$CVSSv3 { - attackComplexity?: string; + attackComplexity?: string | null; /** * Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. */ - attackVector?: string; - availabilityImpact?: string; + attackVector?: string | null; + availabilityImpact?: string | null; /** * The base score is a function of the base metric scores. */ - baseScore?: number; - confidentialityImpact?: string; - exploitabilityScore?: number; - impactScore?: number; - integrityImpact?: string; - privilegesRequired?: string; - scope?: string; - userInteraction?: string; + baseScore?: number | null; + confidentialityImpact?: string | null; + exploitabilityScore?: number | null; + impactScore?: number | null; + integrityImpact?: string | null; + privilegesRequired?: string | null; + scope?: string | null; + userInteraction?: string | null; } /** * An artifact that can be deployed in some runtime. @@ -398,7 +398,7 @@ export namespace containeranalysis_v1beta1 { /** * Required. Resource URI for the artifact being deployed. */ - resourceUri?: string[]; + resourceUri?: string[] | null; } /** * The period during which some deployable was active in a runtime. @@ -407,31 +407,31 @@ export namespace containeranalysis_v1beta1 { /** * Address of the runtime element hosting this deployment. */ - address?: string; + address?: string | null; /** * Configuration used to create this deployment. */ - config?: string; + config?: string | null; /** * Required. Beginning of the lifetime of this deployment. */ - deployTime?: string; + deployTime?: string | null; /** * Platform hosting this deployment. */ - platform?: string; + platform?: string | null; /** * Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. */ - resourceUri?: string[]; + resourceUri?: string[] | null; /** * End of the lifetime of this deployment. */ - undeployTime?: string; + undeployTime?: string | null; /** * Identity of the user that triggered this deployment. */ - userEmail?: string; + userEmail?: string | null; } /** * Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM <DockerImage.Basis in attached Note>. @@ -440,11 +440,11 @@ export namespace containeranalysis_v1beta1 { /** * Output only. This contains the base image URL for the derived image occurrence. */ - baseResourceUrl?: string; + baseResourceUrl?: string | null; /** * Output only. The number of layers by which this image differs from the associated image basis. */ - distance?: number; + distance?: number | null; /** * Required. The fingerprint of the derived image. */ @@ -461,11 +461,11 @@ export namespace containeranalysis_v1beta1 { /** * Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. */ - cpeUri?: string; + cpeUri?: string | null; /** * A vendor-specific description of this note. */ - description?: string; + description?: string | null; /** * The fix for this specific package version. */ @@ -473,7 +473,7 @@ export namespace containeranalysis_v1beta1 { /** * Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. */ - isObsolete?: boolean; + isObsolete?: boolean | null; /** * Deprecated, do not use. Use fixed_location instead. The max version of the package in which the vulnerability exists. */ @@ -485,19 +485,19 @@ export namespace containeranalysis_v1beta1 { /** * Required. The name of the package where the vulnerability was found. */ - package?: string; + package?: string | null; /** * The type of package; whether native or non native(ruby gems, node.js packages etc). */ - packageType?: string; + packageType?: string | null; /** * The severity (eg: distro assigned severity) for this vulnerability. */ - severityName?: string; + severityName?: string | null; /** * The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. */ - sourceUpdateTime?: string; + sourceUpdateTime?: string | null; } /** * Details of an attestation occurrence. @@ -515,7 +515,7 @@ export namespace containeranalysis_v1beta1 { /** * The status of discovery for the resource. */ - analysisStatus?: string; + analysisStatus?: string | null; /** * When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. */ @@ -523,11 +523,11 @@ export namespace containeranalysis_v1beta1 { /** * Whether the resource is continuously analyzed. */ - continuousAnalysis?: string; + continuousAnalysis?: string | null; /** * The last time continuous analysis was done for this resource. Deprecated, do not use. */ - lastAnalysisTime?: string; + lastAnalysisTime?: string | null; } /** * A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. @@ -536,7 +536,7 @@ export namespace containeranalysis_v1beta1 { /** * Required. Immutable. The kind of analysis that is handled by this discovery. */ - analysisKind?: string; + analysisKind?: string | null; } /** * This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. @@ -545,15 +545,15 @@ export namespace containeranalysis_v1beta1 { /** * The CPU architecture for which packages in this distribution channel were built. */ - architecture?: string; + architecture?: string | null; /** * Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ - cpeUri?: string; + cpeUri?: string | null; /** * The distribution channel-specific description of this package. */ - description?: string; + description?: string | null; /** * The latest available version of this package in this distribution channel. */ @@ -561,11 +561,11 @@ export namespace containeranalysis_v1beta1 { /** * A freeform string denoting the maintainer of this package. */ - maintainer?: string; + maintainer?: string | null; /** * The distribution channel-specific homepage for this package. */ - url?: string; + url?: 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 `{}`. @@ -578,19 +578,19 @@ export namespace containeranalysis_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build. @@ -608,15 +608,15 @@ export namespace containeranalysis_v1beta1 { /** * Required. The layer ID of the final layer in the Docker image's v1 representation. */ - v1Name?: string; + v1Name?: string | null; /** * Required. The ordered list of v2 blobs that represent a given image. */ - v2Blob?: string[]; + v2Blob?: string[] | null; /** * Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. */ - v2Name?: string; + v2Name?: string | null; } /** * Per resource and severity counts of fixable and total vulnerabilities. @@ -625,7 +625,7 @@ export namespace containeranalysis_v1beta1 { /** * The number of fixable vulnerabilities associated with this resource. */ - fixableCount?: string; + fixableCount?: string | null; /** * The affected resource. */ @@ -633,11 +633,11 @@ export namespace containeranalysis_v1beta1 { /** * The severity for this count. SEVERITY_UNSPECIFIED indicates total across all severities. */ - severity?: string; + severity?: string | null; /** * The total number of vulnerabilities associated with this resource. */ - totalCount?: string; + totalCount?: string | null; } /** * An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring. @@ -646,11 +646,11 @@ export namespace containeranalysis_v1beta1 { /** * Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). */ - contentType?: string; + contentType?: string | null; /** * The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`. */ - serializedPayload?: string; + serializedPayload?: string | null; /** * One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification. */ @@ -667,15 +667,15 @@ export namespace containeranalysis_v1beta1 { /** * The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. */ - gerritProject?: string; + gerritProject?: string | null; /** * The URI of a running Gerrit instance. */ - hostUri?: string; + hostUri?: string | null; /** * A revision (commit) ID. */ - revisionId?: string; + revisionId?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -693,7 +693,7 @@ export namespace containeranalysis_v1beta1 { /** * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). @@ -702,11 +702,11 @@ export namespace containeranalysis_v1beta1 { /** * Git commit hash. */ - revisionId?: string; + revisionId?: string | null; /** * Git repository URL. */ - url?: string; + url?: string | null; } /** * Metadata for all operations used and required for all operations that created by Container Analysis Providers @@ -715,11 +715,11 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The time this operation was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The time that this operation was marked completed or failed. */ - endTime?: string; + endTime?: string | null; } /** * Details of a build occurrence. @@ -732,7 +732,7 @@ export namespace containeranalysis_v1beta1 { /** * Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. */ - provenanceBytes?: string; + provenanceBytes?: string | null; } /** * Details of a deployment occurrence. @@ -777,15 +777,15 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. */ - cvssScore?: number; + cvssScore?: number | null; /** * The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. */ - effectiveSeverity?: string; + effectiveSeverity?: string | null; /** * Output only. A detailed description of this vulnerability. */ - longDescription?: string; + longDescription?: string | null; /** * Required. The set of affected locations and their fixes (if available) within the associated resource. */ @@ -797,15 +797,15 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The note provider assigned Severity of the vulnerability. */ - severity?: string; + severity?: string | null; /** * Output only. A one sentence description of this vulnerability. */ - shortDescription?: string; + shortDescription?: string | null; /** * The type of package; whether native or non native(ruby gems, node.js packages etc) */ - type?: string; + type?: string | null; } /** * Container message for hash values. @@ -814,11 +814,11 @@ export namespace containeranalysis_v1beta1 { /** * Required. The type of hash that was performed. */ - type?: string; + type?: string | null; /** * Required. The hash value. */ - value?: string; + value?: string | null; } /** * This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. @@ -827,7 +827,7 @@ export namespace containeranalysis_v1beta1 { /** * Required. The human readable name of this attestation authority, for example "qa". */ - humanReadableName?: string; + humanReadableName?: string | null; } /** * This represents how a particular software package may be installed on a system. @@ -840,17 +840,17 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The name of the installed package. */ - name?: string; + name?: string | null; } export interface Schema$KnowledgeBase { /** * The KB name (generally of the form KB[0-9]+ i.e. KB123456). */ - name?: string; + name?: string | null; /** * A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ */ - url?: string; + url?: string | null; } /** * Layer holds metadata specific to a layer of a Docker image. @@ -859,11 +859,11 @@ export namespace containeranalysis_v1beta1 { /** * The recovered arguments to the Dockerfile directive. */ - arguments?: string; + arguments?: string | null; /** * Required. The recovered Dockerfile directive used to construct this layer. */ - directive?: string; + directive?: string | null; } /** * Response for listing occurrences for a note. @@ -872,7 +872,7 @@ export namespace containeranalysis_v1beta1 { /** * Token to provide to skip to a particular spot in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The occurrences attached to the specified note. */ @@ -885,7 +885,7 @@ export namespace containeranalysis_v1beta1 { /** * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The notes requested. */ @@ -898,7 +898,7 @@ export namespace containeranalysis_v1beta1 { /** * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The occurrences requested. */ @@ -911,7 +911,7 @@ export namespace containeranalysis_v1beta1 { /** * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The scan configurations requested. */ @@ -924,11 +924,11 @@ export namespace containeranalysis_v1beta1 { /** * Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ - cpeUri?: string; + cpeUri?: string | null; /** * The path from which we gathered that this package/version is installed. */ - path?: string; + path?: string | null; /** * The version installed at this location. */ @@ -953,7 +953,7 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The time this note was created. This field can be used as a filter in list requests. */ - createTime?: string; + createTime?: string | null; /** * A note describing something that can be deployed. */ @@ -965,19 +965,19 @@ export namespace containeranalysis_v1beta1 { /** * Time of expiration for this note. Empty if note does not expire. */ - expirationTime?: string; + expirationTime?: string | null; /** * Output only. The type of analysis. This field can be used as a filter in list requests. */ - kind?: string; + kind?: string | null; /** * A detailed description of this note. */ - longDescription?: string; + longDescription?: string | null; /** * Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ - name?: string; + name?: string | null; /** * A note describing a package hosted by various package managers. */ @@ -985,7 +985,7 @@ export namespace containeranalysis_v1beta1 { /** * Other notes related to this note. */ - relatedNoteNames?: string[]; + relatedNoteNames?: string[] | null; /** * URLs associated with this note. */ @@ -993,11 +993,11 @@ export namespace containeranalysis_v1beta1 { /** * A one sentence description of this note. */ - shortDescription?: string; + shortDescription?: string | null; /** * Output only. The time this note was last updated. This field can be used as a filter in list requests. */ - updateTime?: string; + updateTime?: string | null; /** * A note describing a package vulnerability. */ @@ -1018,7 +1018,7 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The time this occurrence was created. */ - createTime?: string; + createTime?: string | null; /** * Describes the deployment of an artifact on a runtime. */ @@ -1038,19 +1038,19 @@ export namespace containeranalysis_v1beta1 { /** * Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. */ - kind?: string; + kind?: string | null; /** * Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ - name?: string; + name?: string | null; /** * Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. */ - noteName?: string; + noteName?: string | null; /** * A description of actions that can be taken to remedy the note. */ - remediation?: string; + remediation?: string | null; /** * Required. Immutable. The resource for which the occurrence applies. */ @@ -1058,7 +1058,7 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The time this occurrence was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * Describes a security vulnerability. */ @@ -1075,7 +1075,7 @@ export namespace containeranalysis_v1beta1 { /** * Required. Immutable. The name of the package. */ - name?: string; + name?: string | null; } /** * This message wraps a location affected by a vulnerability and its associated fix (if one is available). @@ -1092,7 +1092,7 @@ export namespace containeranalysis_v1beta1 { /** * Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability. */ - severityName?: string; + severityName?: string | null; } /** * An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. @@ -1101,15 +1101,15 @@ export namespace containeranalysis_v1beta1 { /** * Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). */ - contentType?: string; + contentType?: string | null; /** * The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...<SNIP>... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. */ - pgpKeyId?: string; + pgpKeyId?: string | null; /** * Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. */ - signature?: string; + signature?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -1122,11 +1122,11 @@ export namespace containeranalysis_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. @@ -1135,11 +1135,11 @@ export namespace containeranalysis_v1beta1 { /** * The ID of the project. */ - projectId?: string; + projectId?: string | null; /** * The name of the repo. Leave empty for the default repo. */ - repoName?: string; + repoName?: string | null; } /** * Metadata for any related URL information. @@ -1148,11 +1148,11 @@ export namespace containeranalysis_v1beta1 { /** * Label to describe usage of the URL. */ - label?: string; + label?: string | null; /** * Specific URL associated with the resource. */ - url?: string; + url?: string | null; } /** * A unique identifier for a Cloud Repo. @@ -1165,7 +1165,7 @@ export namespace containeranalysis_v1beta1 { /** * A server-assigned, globally unique identifier. */ - uid?: string; + uid?: string | null; } /** * An entity that can have metadata. For example, a Docker image. @@ -1178,11 +1178,11 @@ export namespace containeranalysis_v1beta1 { /** * Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian". */ - name?: string; + name?: string | null; /** * Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image. */ - uri?: string; + uri?: string | null; } /** * A scan configuration specifies whether Cloud components in a project have a particular type of analysis being run. For example, it can configure whether vulnerability scanning is being done on Docker images or not. @@ -1191,23 +1191,23 @@ export namespace containeranalysis_v1beta1 { /** * Output only. The time this scan config was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. A human-readable description of what the scan configuration does. */ - description?: string; + description?: string | null; /** * Whether the scan is enabled. */ - enabled?: boolean; + enabled?: boolean | null; /** * Output only. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. */ - name?: string; + name?: string | null; /** * Output only. The time this scan config was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -1225,11 +1225,11 @@ export namespace containeranalysis_v1beta1 { /** * The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` MUST be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" */ - publicKeyId?: string; + publicKeyId?: string | null; /** * The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload. */ - signature?: string; + signature?: string | null; } /** * Source describes the location of the source used for the build. @@ -1242,7 +1242,7 @@ export namespace containeranalysis_v1beta1 { /** * If provided, the input binary artifacts for the build came from this location. */ - artifactStorageSourceUri?: string; + artifactStorageSourceUri?: string | null; /** * If provided, the source code used for the build came from this location. */ @@ -1250,7 +1250,7 @@ export namespace containeranalysis_v1beta1 { /** * Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. */ - fileHashes?: {[key: string]: Schema$FileHashes}; + fileHashes?: {[key: string]: Schema$FileHashes} | null; } /** * A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. @@ -1271,7 +1271,7 @@ export namespace containeranalysis_v1beta1 { /** * Labels with user defined metadata. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: 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). @@ -1280,15 +1280,15 @@ export namespace containeranalysis_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -1297,7 +1297,7 @@ export namespace containeranalysis_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -1306,7 +1306,7 @@ export namespace containeranalysis_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Version contains structured information about the version of a package. @@ -1315,19 +1315,19 @@ export namespace containeranalysis_v1beta1 { /** * Used to correct mistakes in the version numbering scheme. */ - epoch?: number; + epoch?: number | null; /** * Required. Distinguishes between sentinel MIN/MAX versions and normal versions. */ - kind?: string; + kind?: string | null; /** * Required only when version kind is NORMAL. The main part of the version name. */ - name?: string; + name?: string | null; /** * The iteration of the package build from the above version. */ - revision?: string; + revision?: string | null; } /** * Vulnerability provides metadata about a security vulnerability in a Note. @@ -1336,7 +1336,7 @@ export namespace containeranalysis_v1beta1 { /** * The CVSS score for this vulnerability. */ - cvssScore?: number; + cvssScore?: number | null; /** * The full description of the CVSSv3. */ @@ -1348,11 +1348,11 @@ export namespace containeranalysis_v1beta1 { /** * Note provider assigned impact of the vulnerability. */ - severity?: string; + severity?: string | null; /** * The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. */ - sourceUpdateTime?: string; + sourceUpdateTime?: string | null; /** * Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. */ @@ -1365,11 +1365,11 @@ export namespace containeranalysis_v1beta1 { /** * Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. */ - cpeUri?: string; + cpeUri?: string | null; /** * Required. The package being described. */ - package?: string; + package?: string | null; /** * Required. The version of the package being described. */ @@ -1388,11 +1388,11 @@ export namespace containeranalysis_v1beta1 { /** * Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. */ - cpeUri?: string; + cpeUri?: string | null; /** * The description of the vulnerability. */ - description?: string; + description?: string | null; /** * Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. */ @@ -1400,7 +1400,7 @@ export namespace containeranalysis_v1beta1 { /** * Required. The name of the vulnerability. */ - name?: string; + name?: string | null; } export class Resource$Projects { diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index b748da1cb90..793e5a8a4de 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -144,7 +144,7 @@ export namespace content_v2_1 { /** * Indicates whether the merchant sells adult content. */ - adultContent?: boolean; + adultContent?: boolean | null; /** * The business information of the account. */ @@ -156,19 +156,19 @@ export namespace content_v2_1 { /** * Merchant Center account ID. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#account". */ - kind?: string; + kind?: string | null; /** * Display name for the account. */ - name?: string; + name?: string | null; /** * Client-specific, locally-unique, internal ID for the child account. */ - sellerId?: string; + sellerId?: string | null; /** * Users with access to the account. Every account (except for subaccounts) must have at least one admin user. */ @@ -176,7 +176,7 @@ export namespace content_v2_1 { /** * The merchant's website. */ - websiteUrl?: string; + websiteUrl?: string | null; /** * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. */ @@ -186,33 +186,33 @@ export namespace content_v2_1 { /** * CLDR country code (e.g. "US"). */ - country?: string; + country?: string | null; /** * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ - locality?: string; + locality?: string | null; /** * Postal code or ZIP (e.g. "94043"). */ - postalCode?: string; + postalCode?: string | null; /** * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ - region?: string; + region?: string | null; /** * Street-level part of the address. */ - streetAddress?: string; + streetAddress?: string | null; } export interface Schema$AccountAdsLink { /** * Customer ID of the Ads account. */ - adsId?: string; + adsId?: string | null; /** * Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google Ads or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ - status?: string; + status?: string | null; } export interface Schema$AccountBusinessInformation { /** @@ -226,41 +226,41 @@ export namespace content_v2_1 { /** * The phone number of the business. */ - phoneNumber?: string; + phoneNumber?: string | null; } export interface Schema$AccountCustomerService { /** * Customer service email. */ - email?: string; + email?: string | null; /** * Customer service phone number. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * Customer service URL. */ - url?: string; + url?: string | null; } export interface Schema$AccountGoogleMyBusinessLink { /** * The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. */ - gmbEmail?: string; + gmbEmail?: string | null; /** * Status of the link between this Merchant Center account and the GMB account. */ - status?: string; + status?: string | null; } export interface Schema$AccountIdentifier { /** * The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount). */ - aggregatorId?: string; + aggregatorId?: string | null; /** * The merchant account ID, set for individual accounts and subaccounts. */ - merchantId?: string; + merchantId?: string | null; } export interface Schema$AccountsAuthInfoResponse { /** @@ -270,13 +270,13 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AccountsClaimWebsiteResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AccountsCustomBatchRequest { /** @@ -295,15 +295,15 @@ export namespace content_v2_1 { /** * The ID of the targeted account. Only defined if the method is not insert. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * Whether the account should be deleted if the account has offers. Only applicable if the method is delete. */ - force?: boolean; + force?: boolean | null; /** * Details about the link request. */ @@ -311,29 +311,29 @@ export namespace content_v2_1 { /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * The method of the batch entry. */ - method?: string; + method?: string | null; /** * Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict. */ - overwrite?: boolean; + overwrite?: boolean | null; } export interface Schema$AccountsCustomBatchRequestEntryLinkRequest { /** * Action to perform for this link. The "request" action is only available to select merchants. */ - action?: string; + action?: string | null; /** * The ID of the linked account. */ - linkedAccountId?: string; + linkedAccountId?: string | null; /** * Type of the link between the two accounts. */ - linkType?: string; + linkType?: string | null; } export interface Schema$AccountsCustomBatchResponse { /** @@ -343,7 +343,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch accounts response. @@ -356,7 +356,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -364,37 +364,37 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; } export interface Schema$AccountsLinkRequest { /** * Action to perform for this link. The "request" action is only available to select merchants. */ - action?: string; + action?: string | null; /** * The ID of the linked account. */ - linkedAccountId?: string; + linkedAccountId?: string | null; /** * Type of the link between the two accounts. */ - linkType?: string; + linkType?: string | null; } export interface Schema$AccountsLinkResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AccountsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of accounts. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Account[]; } /** @@ -404,7 +404,7 @@ export namespace content_v2_1 { /** * The ID of the account for which the status is reported. */ - accountId?: string; + accountId?: string | null; /** * A list of account level issues. */ @@ -412,7 +412,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". */ - kind?: string; + kind?: string | null; /** * List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. */ @@ -420,37 +420,37 @@ export namespace content_v2_1 { /** * Whether the account's website is claimed or not. */ - websiteClaimed?: boolean; + websiteClaimed?: boolean | null; } export interface Schema$AccountStatusAccountLevelIssue { /** * Country for which this issue is reported. */ - country?: string; + country?: string | null; /** * The destination the issue applies to. */ - destination?: string; + destination?: string | null; /** * Additional details about the issue. */ - detail?: string; + detail?: string | null; /** * The URL of a web page to help resolving this issue. */ - documentation?: string; + documentation?: string | null; /** * Issue identifier. */ - id?: string; + id?: string | null; /** * Severity of the issue. */ - severity?: string; + severity?: string | null; /** * Short description of the issue. */ - title?: string; + title?: string | null; } export interface Schema$AccountstatusesCustomBatchRequest { /** @@ -465,23 +465,23 @@ export namespace content_v2_1 { /** * The ID of the (sub-)account whose status to get. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ - destinations?: string[]; + destinations?: string[] | null; /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * The method (get). */ - method?: string; + method?: string | null; } export interface Schema$AccountstatusesCustomBatchResponse { /** @@ -491,7 +491,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch accountstatuses response. @@ -504,7 +504,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -514,60 +514,60 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of account statuses. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$AccountStatus[]; } export interface Schema$AccountStatusItemLevelIssue { /** * The attribute's name, if the issue is caused by a single attribute. */ - attributeName?: string; + attributeName?: string | null; /** * The error code of the issue. */ - code?: string; + code?: string | null; /** * A short issue description in English. */ - description?: string; + description?: string | null; /** * A detailed issue description in English. */ - detail?: string; + detail?: string | null; /** * The URL of a web page to help with resolving this issue. */ - documentation?: string; + documentation?: string | null; /** * Number of items with this issue. */ - numItems?: string; + numItems?: string | null; /** * Whether the issue can be resolved by the merchant. */ - resolution?: string; + resolution?: string | null; /** * How this issue affects serving of the offer. */ - servability?: string; + servability?: string | null; } export interface Schema$AccountStatusProducts { /** * The channel the data applies to. */ - channel?: string; + channel?: string | null; /** * The country the data applies to. */ - country?: string; + country?: string | null; /** * The destination the data applies to. */ - destination?: string; + destination?: string | null; /** * List of item-level issues. */ @@ -581,19 +581,19 @@ export namespace content_v2_1 { /** * Number of active offers. */ - active?: string; + active?: string | null; /** * Number of disapproved offers. */ - disapproved?: string; + disapproved?: string | null; /** * Number of expiring offers. */ - expiring?: string; + expiring?: string | null; /** * Number of pending offers. */ - pending?: string; + pending?: string | null; } /** * The tax settings of a merchant account. All methods require the admin role. @@ -602,11 +602,11 @@ export namespace content_v2_1 { /** * The ID of the account to which these account tax settings belong. */ - accountId?: string; + accountId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#accountTax". */ - kind?: string; + kind?: string | null; /** * Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all. */ @@ -625,7 +625,7 @@ export namespace content_v2_1 { /** * The ID of the account for which to get/update account tax settings. */ - accountId?: string; + accountId?: string | null; /** * The account tax settings to update. Only defined if the method is update. */ @@ -633,12 +633,12 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; } export interface Schema$AccounttaxCustomBatchResponse { /** @@ -648,7 +648,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch accounttax response. @@ -661,7 +661,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -669,17 +669,17 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; } export interface Schema$AccounttaxListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of account tax settings. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$AccountTax[]; } /** @@ -689,55 +689,55 @@ export namespace content_v2_1 { /** * Country code in which tax is applicable. */ - country?: string; + country?: string | null; /** * State (or province) is which the tax is applicable, described by its location ID (also called criteria ID). */ - locationId?: string; + locationId?: string | null; /** * Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative. */ - ratePercent?: string; + ratePercent?: string | null; /** * If true, shipping charges are also taxed. */ - shippingTaxed?: boolean; + shippingTaxed?: boolean | null; /** * Whether the tax rate is taken from a global tax table or specified explicitly. */ - useGlobalRate?: boolean; + useGlobalRate?: boolean | null; } export interface Schema$AccountUser { /** * Whether user is an admin. */ - admin?: boolean; + admin?: boolean | null; /** * User's email address. */ - emailAddress?: string; + emailAddress?: string | null; /** * Whether user is an order manager. */ - orderManager?: boolean; + orderManager?: boolean | null; /** * Whether user can access payment statements. */ - paymentsAnalyst?: boolean; + paymentsAnalyst?: boolean | null; /** * Whether user can manage payment settings. */ - paymentsManager?: boolean; + paymentsManager?: boolean | null; } export interface Schema$AccountYouTubeChannelLink { /** * Channel ID. */ - channelId?: string; + channelId?: string | null; /** * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ - status?: string; + status?: string | null; } export interface Schema$Amount { /** @@ -753,17 +753,17 @@ export namespace content_v2_1 { /** * Regular business days. May not be empty. */ - businessDays?: string[]; + businessDays?: string[] | null; } export interface Schema$CarrierRate { /** * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. */ - carrierName?: string; + carrierName?: string | null; /** * Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. */ - carrierService?: string; + carrierService?: string | null; /** * Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional. */ @@ -771,29 +771,29 @@ export namespace content_v2_1 { /** * Name of the carrier rate. Must be unique per rate group. Required. */ - name?: string; + name?: string | null; /** * Shipping origin for this carrier rate. Required. */ - originPostalCode?: string; + originPostalCode?: string | null; /** * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional. */ - percentageAdjustment?: string; + percentageAdjustment?: string | null; } export interface Schema$CarriersCarrier { /** * The CLDR country code of the carrier (e.g., "US"). Always present. */ - country?: string; + country?: string | null; /** * The name of the carrier (e.g., "UPS"). Always present. */ - name?: string; + name?: string | null; /** * A list of supported services (e.g., "ground") for that carrier. Contains at least one service. */ - services?: string[]; + services?: string[] | null; } export interface Schema$CustomAttribute { /** @@ -803,29 +803,29 @@ export namespace content_v2_1 { /** * The name of the attribute. Underscores will be replaced by spaces upon insertion. */ - name?: string; + name?: string | null; /** * The value of the attribute. */ - value?: string; + value?: string | null; } export interface Schema$CustomerReturnReason { - description?: string; - reasonCode?: string; + description?: string | null; + reasonCode?: string | null; } export interface Schema$CutoffTime { /** * Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ - hour?: number; + hour?: number | null; /** * Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ - minute?: number; + minute?: number | null; /** * Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ - timezone?: string; + timezone?: string | null; } /** * Datafeed configuration data. @@ -834,11 +834,11 @@ export namespace content_v2_1 { /** * The two-letter ISO 639-1 language in which the attributes are defined in the data feed. */ - attributeLanguage?: string; + attributeLanguage?: string | null; /** * The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. */ - contentType?: string; + contentType?: string | null; /** * Fetch schedule for the feed file. */ @@ -846,7 +846,7 @@ export namespace content_v2_1 { /** * The filename of the feed. All feeds must have a unique file name. */ - fileName?: string; + fileName?: string | null; /** * Format of the feed file. */ @@ -854,15 +854,15 @@ export namespace content_v2_1 { /** * The ID of the data feed. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeed". */ - kind?: string; + kind?: string | null; /** * A descriptive name of the data feed. */ - name?: string; + name?: string | null; /** * The targets this feed should apply to (country, language, destinations). */ @@ -875,53 +875,53 @@ export namespace content_v2_1 { /** * The day of the month the feed file should be fetched (1-31). */ - dayOfMonth?: number; + dayOfMonth?: number | null; /** * The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. */ - fetchUrl?: string; + fetchUrl?: string | null; /** * The hour of the day the feed file should be fetched (0-23). */ - hour?: number; + hour?: number | null; /** * The minute of the hour the feed file should be fetched (0-59). Read-only. */ - minuteOfHour?: number; + minuteOfHour?: number | null; /** * An optional password for fetch_url. */ - password?: string; + password?: string | null; /** * Whether the scheduled fetch is paused or not. */ - paused?: boolean; + paused?: boolean | null; /** * Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". */ - timeZone?: string; + timeZone?: string | null; /** * An optional user name for fetch_url. */ - username?: string; + username?: string | null; /** * The day of the week the feed file should be fetched. */ - weekday?: string; + weekday?: string | null; } export interface Schema$DatafeedFormat { /** * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. */ - columnDelimiter?: string; + columnDelimiter?: string | null; /** * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. */ - fileEncoding?: string; + fileEncoding?: string | null; /** * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. */ - quotingMode?: string; + quotingMode?: string | null; } export interface Schema$DatafeedsCustomBatchRequest { /** @@ -936,7 +936,7 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The data feed to insert. */ @@ -944,12 +944,12 @@ export namespace content_v2_1 { /** * The ID of the data feed to get, delete or fetch. */ - datafeedId?: string; + datafeedId?: string | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; } export interface Schema$DatafeedsCustomBatchResponse { /** @@ -959,7 +959,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch datafeeds response. @@ -968,7 +968,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * The requested data feed. Defined if and only if the request was successful. */ @@ -982,17 +982,17 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$DatafeedsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of datafeeds. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Datafeed[]; } /** @@ -1002,11 +1002,11 @@ export namespace content_v2_1 { /** * The country for which the status is reported, represented as a CLDR territory code. */ - country?: string; + country?: string | null; /** * The ID of the feed for which the status is reported. */ - datafeedId?: string; + datafeedId?: string | null; /** * The list of errors occurring in the feed. */ @@ -1014,27 +1014,27 @@ export namespace content_v2_1 { /** * The number of items in the feed that were processed. */ - itemsTotal?: string; + itemsTotal?: string | null; /** * The number of items in the feed that were valid. */ - itemsValid?: string; + itemsValid?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". */ - kind?: string; + kind?: string | null; /** * The two-letter ISO 639-1 language for which the status is reported. */ - language?: string; + language?: string | null; /** * The last date at which the feed was uploaded. */ - lastUploadDate?: string; + lastUploadDate?: string | null; /** * The processing status of the feed. */ - processingStatus?: string; + processingStatus?: string | null; /** * The list of errors occurring in the feed. */ @@ -1047,11 +1047,11 @@ export namespace content_v2_1 { /** * The code of the error, e.g., "validation/invalid_value". */ - code?: string; + code?: string | null; /** * The number of occurrences of the error in the feed. */ - count?: string; + count?: string | null; /** * A list of example occurrences of the error, grouped by product. */ @@ -1059,7 +1059,7 @@ export namespace content_v2_1 { /** * The error message, e.g., "Invalid price". */ - message?: string; + message?: string | null; } export interface Schema$DatafeedstatusesCustomBatchRequest { /** @@ -1074,24 +1074,24 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required. */ - country?: string; + country?: string | null; /** * The ID of the data feed to get. */ - datafeedId?: string; + datafeedId?: string | null; /** * The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required. */ - language?: string; + language?: string | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; } export interface Schema$DatafeedstatusesCustomBatchResponse { /** @@ -1101,7 +1101,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch datafeedstatuses response. @@ -1110,7 +1110,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * The requested data feed status. Defined if and only if the request was successful. */ @@ -1124,11 +1124,11 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of datafeed statuses. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$DatafeedStatus[]; } /** @@ -1138,33 +1138,33 @@ export namespace content_v2_1 { /** * The ID of the example item. */ - itemId?: string; + itemId?: string | null; /** * Line number in the data feed where the example is found. */ - lineNumber?: string; + lineNumber?: string | null; /** * The problematic value. */ - value?: string; + value?: string | null; } export interface Schema$DatafeedTarget { /** * The country where the items in the feed will be included in the search index, represented as a CLDR territory code. */ - country?: string; + country?: string | null; /** * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). */ - excludedDestinations?: string[]; + excludedDestinations?: string[] | null; /** * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. */ - includedDestinations?: string[]; + includedDestinations?: string[] | null; /** * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. */ - language?: string; + language?: string | null; } export interface Schema$DeliveryTime { /** @@ -1182,19 +1182,19 @@ export namespace content_v2_1 { /** * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays. */ - maxHandlingTimeInDays?: number; + maxHandlingTimeInDays?: number | null; /** * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. */ - maxTransitTimeInDays?: number; + maxTransitTimeInDays?: number | null; /** * Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. */ - minHandlingTimeInDays?: number; + minHandlingTimeInDays?: number | null; /** * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both. */ - minTransitTimeInDays?: number; + minTransitTimeInDays?: number | null; /** * The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed. */ @@ -1211,15 +1211,15 @@ export namespace content_v2_1 { /** * The domain of the error. */ - domain?: string; + domain?: string | null; /** * A description of the error. */ - message?: string; + message?: string | null; /** * The error code. */ - reason?: string; + reason?: string | null; } /** * A list of errors returned by a failed batch entry. @@ -1228,7 +1228,7 @@ export namespace content_v2_1 { /** * The HTTP status of the first error in errors. */ - code?: number; + code?: number | null; /** * A list of errors. */ @@ -1236,13 +1236,13 @@ export namespace content_v2_1 { /** * The message of the first error in errors. */ - message?: string; + message?: string | null; } export interface Schema$GmbAccounts { /** * The ID of the account. */ - accountId?: string; + accountId?: string | null; /** * A list of GMB accounts which are available to the merchant. */ @@ -1252,19 +1252,19 @@ export namespace content_v2_1 { /** * The email which identifies the GMB account. */ - email?: string; + email?: string | null; /** * Number of listings under this account. */ - listingCount?: string; + listingCount?: string | null; /** * The name of the GMB account. */ - name?: string; + name?: string | null; /** * The type of the GMB account (User or Business). */ - type?: string; + type?: string | null; } /** * A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. @@ -1277,11 +1277,11 @@ export namespace content_v2_1 { /** * A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. */ - numberOfItems?: string[]; + numberOfItems?: string[] | null; /** * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. */ - postalCodeGroupNames?: string[]; + postalCodeGroupNames?: string[] | null; /** * A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. */ @@ -1295,49 +1295,49 @@ export namespace content_v2_1 { /** * Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required. */ - deadlineDate?: string; + deadlineDate?: string | null; /** * Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required. */ - deadlineHour?: number; + deadlineHour?: number | null; /** * Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ - deadlineTimezone?: string; + deadlineTimezone?: string | null; /** * Unique identifier for the holiday. Required. */ - holidayId?: string; + holidayId?: string | null; /** * Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required. */ - visibleFromDate?: string; + visibleFromDate?: string | null; } export interface Schema$HolidaysHoliday { /** * The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present. */ - countryCode?: string; + countryCode?: string | null; /** * Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present. */ - date?: string; + date?: string | null; /** * Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present. */ - deliveryGuaranteeDate?: string; + deliveryGuaranteeDate?: string | null; /** * Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present. */ - deliveryGuaranteeHour?: string; + deliveryGuaranteeHour?: string | null; /** * Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present. */ - id?: string; + id?: string | null; /** * The holiday type. Always present. */ - type?: string; + type?: string | null; } export interface Schema$Installment { /** @@ -1347,7 +1347,7 @@ export namespace content_v2_1 { /** * The number of installments the buyer has to pay. */ - months?: string; + months?: string | null; } export interface Schema$InvoiceSummary { /** @@ -1367,17 +1367,17 @@ export namespace content_v2_1 { /** * [required] Type of the additional charge. */ - type?: string; + type?: string | null; } export interface Schema$LiaAboutPageSettings { /** * The status of the verification process for the About page. */ - status?: string; + status?: string | null; /** * The URL for the About page. */ - url?: string; + url?: string | null; } export interface Schema$LiaCountrySettings { /** @@ -1387,11 +1387,11 @@ export namespace content_v2_1 { /** * CLDR country code (e.g. "US"). */ - country?: string; + country?: string | null; /** * The status of the "Merchant hosted local storefront" feature. */ - hostedLocalStorefrontActive?: boolean; + hostedLocalStorefrontActive?: boolean | null; /** * LIA inventory verification settings. */ @@ -1407,45 +1407,45 @@ export namespace content_v2_1 { /** * The status of the "Store pickup" feature. */ - storePickupActive?: boolean; + storePickupActive?: boolean | null; } export interface Schema$LiaInventorySettings { /** * The email of the contact for the inventory verification process. */ - inventoryVerificationContactEmail?: string; + inventoryVerificationContactEmail?: string | null; /** * The name of the contact for the inventory verification process. */ - inventoryVerificationContactName?: string; + inventoryVerificationContactName?: string | null; /** * The status of the verification contact. */ - inventoryVerificationContactStatus?: string; + inventoryVerificationContactStatus?: string | null; /** * The status of the inventory verification process. */ - status?: string; + status?: string | null; } export interface Schema$LiaOnDisplayToOrderSettings { /** * Shipping cost and policy URL. */ - shippingCostPolicyUrl?: string; + shippingCostPolicyUrl?: string | null; /** * The status of the ?On display to order? feature. */ - status?: string; + status?: string | null; } export interface Schema$LiaPosDataProvider { /** * The ID of the POS data provider. */ - posDataProviderId?: string; + posDataProviderId?: string | null; /** * The account ID by which this merchant is known to the POS data provider. */ - posExternalAccountId?: string; + posExternalAccountId?: string | null; } /** * Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. @@ -1454,7 +1454,7 @@ export namespace content_v2_1 { /** * The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. */ - accountId?: string; + accountId?: string | null; /** * The LIA settings for each country. */ @@ -1462,7 +1462,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsCustomBatchRequest { /** @@ -1474,27 +1474,27 @@ export namespace content_v2_1 { /** * The ID of the account for which to get/update account shipping settings. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * Inventory validation contact email. Required only for SetInventoryValidationContact. */ - contactEmail?: string; + contactEmail?: string | null; /** * Inventory validation contact name. Required only for SetInventoryValidationContact. */ - contactName?: string; + contactName?: string | null; /** * The country code. Required only for RequestInventoryVerification. */ - country?: string; + country?: string | null; /** * The GMB account. Required only for RequestGmbAccess. */ - gmbEmail?: string; + gmbEmail?: string | null; /** * The account Lia settings to update. Only defined if the method is update. */ @@ -1502,16 +1502,16 @@ export namespace content_v2_1 { /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The ID of POS data provider. Required only for SetPosProvider. */ - posDataProviderId?: string; + posDataProviderId?: string | null; /** * The account ID by which this merchant is known to the POS provider. */ - posExternalAccountId?: string; + posExternalAccountId?: string | null; } export interface Schema$LiasettingsCustomBatchResponse { /** @@ -1521,13 +1521,13 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsCustomBatchResponseEntry { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -1539,7 +1539,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The retrieved or updated Lia settings. */ @@ -1553,7 +1553,7 @@ export namespace content_v2_1 { /** * The ID of the account. */ - accountId?: string; + accountId?: string | null; /** * A list of GMB accounts which are available to the merchant. */ @@ -1561,13 +1561,13 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsListPosDataProvidersResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse". */ - kind?: string; + kind?: string | null; /** * The list of POS data providers for each eligible country */ @@ -1577,72 +1577,72 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of LIA settings. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$LiaSettings[]; } export interface Schema$LiasettingsRequestGmbAccessResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsRequestInventoryVerificationResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsSetInventoryVerificationContactResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsSetPosDataProviderResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LocationIdSet { /** * A non-empty list of location IDs. They must all be of the same location type (e.g., state). */ - locationIds?: string[]; + locationIds?: string[] | null; } export interface Schema$LoyaltyPoints { /** * Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. */ - name?: string; + name?: string | null; /** * The retailer's loyalty points in absolute value. */ - pointsValue?: string; + pointsValue?: string | null; /** * The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. */ - ratio?: number; + ratio?: number | null; } export interface Schema$MerchantOrderReturn { - creationDate?: string; - merchantOrderId?: string; - orderId?: string; - orderReturnId?: string; + creationDate?: string | null; + merchantOrderId?: string | null; + orderId?: string | null; + orderReturnId?: string | null; returnItems?: Schema$MerchantOrderReturnItem[]; returnShipments?: Schema$ReturnShipment[]; } export interface Schema$MerchantOrderReturnItem { customerReturnReason?: Schema$CustomerReturnReason; - itemId?: string; + itemId?: string | null; merchantReturnReason?: Schema$RefundReason; product?: Schema$OrderLineItemProduct; - returnShipmentIds?: string[]; - state?: string; + returnShipmentIds?: string[] | null; + state?: string | null; } /** * Order. All methods require the order manager role. @@ -1651,7 +1651,7 @@ export namespace content_v2_1 { /** * Whether the order was acknowledged. */ - acknowledged?: boolean; + acknowledged?: boolean | null; /** * The billing address. */ @@ -1667,20 +1667,20 @@ export namespace content_v2_1 { /** * The REST ID of the order. Globally unique. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#order". */ - kind?: string; + kind?: string | null; /** * Line items that are ordered. */ lineItems?: Schema$OrderLineItem[]; - merchantId?: string; + merchantId?: string | null; /** * Merchant-provided ID of the order. */ - merchantOrderId?: string; + merchantOrderId?: string | null; /** * The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80. */ @@ -1692,11 +1692,15 @@ export namespace content_v2_1 { /** * The status of the payment. */ - paymentStatus?: string; + paymentStatus?: string | null; + /** + * Pickup details for shipments of type pickup. + */ + pickupDetails?: Schema$OrderPickupDetails; /** * The date when the order was placed, in ISO 8601 format. */ - placedDate?: string; + placedDate?: string | null; /** * Promotions associated with the order. */ @@ -1720,77 +1724,77 @@ export namespace content_v2_1 { /** * The status of the order. */ - status?: string; + status?: string | null; /** * The party responsible for collecting and remitting taxes. */ - taxCollector?: string; + taxCollector?: string | null; } export interface Schema$OrderAddress { /** * CLDR country code (e.g. "US"). */ - country?: string; + country?: string | null; /** * Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States */ - fullAddress?: string[]; + fullAddress?: string[] | null; /** * Whether the address is a post office box. */ - isPostOfficeBox?: boolean; + isPostOfficeBox?: boolean | null; /** * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ - locality?: string; + locality?: string | null; /** * Postal Code or ZIP (e.g. "94043"). */ - postalCode?: string; + postalCode?: string | null; /** * Name of the recipient. */ - recipientName?: string; + recipientName?: string | null; /** * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ - region?: string; + region?: string | null; /** * Street-level part of the address. */ - streetAddress?: string[]; + streetAddress?: string[] | null; } export interface Schema$OrderCancellation { /** * The actor that created the cancellation. */ - actor?: string; + actor?: string | null; /** * Date on which the cancellation has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * The quantity that was canceled. */ - quantity?: number; + quantity?: number | null; /** * The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrderCustomer { /** * Full name of the customer. */ - fullName?: string; + fullName?: string | null; /** * Email address for receiving merchant issued value-added tax or invoice documentation of this order. */ - invoiceReceivingEmail?: string; + invoiceReceivingEmail?: string | null; /** * Loyalty program information. */ @@ -1804,25 +1808,25 @@ export namespace content_v2_1 { /** * The loyalty card/membership number. */ - loyaltyNumber?: string; + loyaltyNumber?: string | null; /** * Name of card/membership holder, this field will be populated when */ - name?: string; + name?: string | null; } export interface Schema$OrderCustomerMarketingRightsInfo { /** * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in. */ - explicitMarketingPreference?: string; + explicitMarketingPreference?: string | null; /** * Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. */ - lastUpdatedTimestamp?: string; + lastUpdatedTimestamp?: string | null; /** * Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account. */ - marketingEmailAddress?: string; + marketingEmailAddress?: string | null; } export interface Schema$OrderDeliveryDetails { /** @@ -1832,13 +1836,13 @@ export namespace content_v2_1 { /** * The phone number of the person receiving the delivery. */ - phoneNumber?: string; + phoneNumber?: string | null; } export interface Schema$OrderinvoicesCreateChargeInvoiceRequest { /** * [required] The ID of the invoice. */ - invoiceId?: string; + invoiceId?: string | null; /** * [required] Invoice summary. */ @@ -1850,31 +1854,31 @@ export namespace content_v2_1 { /** * [required] The ID of the operation, unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; } export interface Schema$OrderinvoicesCreateChargeInvoiceResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrderinvoicesCreateRefundInvoiceRequest { /** * [required] The ID of the invoice. */ - invoiceId?: string; + invoiceId?: string | null; /** * [required] The ID of the operation, unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided. */ @@ -1892,31 +1896,31 @@ export namespace content_v2_1 { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption { /** * Optional description of the refund reason. */ - description?: string; + description?: string | null; /** * [required] Reason for the refund. */ - reason?: string; + reason?: string | null; } export interface Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption { /** * Optional description of the return reason. */ - description?: string; + description?: string | null; /** * [required] Reason for the return. */ - reason?: string; + reason?: string | null; } export interface Schema$OrderLineItem { /** @@ -1934,7 +1938,7 @@ export namespace content_v2_1 { /** * The ID of the line item. */ - id?: string; + id?: string | null; /** * Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20. */ @@ -1946,31 +1950,35 @@ export namespace content_v2_1 { /** * Number of items canceled. */ - quantityCanceled?: number; + quantityCanceled?: number | null; /** * Number of items delivered. */ - quantityDelivered?: number; + quantityDelivered?: number | null; /** * Number of items ordered. */ - quantityOrdered?: number; + quantityOrdered?: number | null; /** * Number of items pending. */ - quantityPending?: number; + quantityPending?: number | null; + /** + * Number of items ready for pickup. + */ + quantityReadyForPickup?: number | null; /** * Number of items returned. */ - quantityReturned?: number; + quantityReturned?: number | null; /** * Number of items shipped. */ - quantityShipped?: number; + quantityShipped?: number | null; /** * Number of items undeliverable. */ - quantityUndeliverable?: number; + quantityUndeliverable?: number | null; /** * Details of the return policy for the line item. */ @@ -2000,21 +2008,21 @@ export namespace content_v2_1 { /** * Type of this adjustment. */ - type?: string; + type?: string | null; } export interface Schema$OrderLineItemProduct { /** * Brand of the item. */ - brand?: string; + brand?: string | null; /** * Condition or state of the item. */ - condition?: string; + condition?: string | null; /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Associated fees at order creation time. */ @@ -2022,27 +2030,27 @@ export namespace content_v2_1 { /** * Global Trade Item Number (GTIN) of the item. */ - gtin?: string; + gtin?: string | null; /** * The REST ID of the product. */ - id?: string; + id?: string | null; /** * URL of an image of the item. */ - imageLink?: string; + imageLink?: string | null; /** * Shared identifier for all variants of the same product. */ - itemGroupId?: string; + itemGroupId?: string | null; /** * Manufacturer Part Number (MPN) of the item. */ - mpn?: string; + mpn?: string | null; /** * An identifier of the item. */ - offerId?: string; + offerId?: string | null; /** * Price of the item. */ @@ -2050,15 +2058,15 @@ export namespace content_v2_1 { /** * URL to the cached image shown to the user when order was placed. */ - shownImage?: string; + shownImage?: string | null; /** * The CLDR territory code of the target country of the product. */ - targetCountry?: string; + targetCountry?: string | null; /** * The title of the product. */ - title?: string; + title?: string | null; /** * Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here. */ @@ -2072,37 +2080,37 @@ export namespace content_v2_1 { /** * Name of the fee. */ - name?: string; + name?: string | null; } export interface Schema$OrderLineItemProductVariantAttribute { /** * The dimension of the variant. */ - dimension?: string; + dimension?: string | null; /** * The value for the dimension. */ - value?: string; + value?: string | null; } export interface Schema$OrderLineItemReturnInfo { /** * How many days later the item can be returned. */ - daysToReturn?: number; + daysToReturn?: number | null; /** * Whether the item is returnable. */ - isReturnable?: boolean; + isReturnable?: boolean | null; /** * URL of the item return policy. */ - policyUrl?: string; + policyUrl?: string | null; } export interface Schema$OrderLineItemShippingDetails { /** * The delivery by date, in ISO 8601 format. */ - deliverByDate?: string; + deliverByDate?: string | null; /** * Details of the shipping method. */ @@ -2110,35 +2118,63 @@ export namespace content_v2_1 { /** * The ship by date, in ISO 8601 format. */ - shipByDate?: string; + shipByDate?: string | null; + /** + * Type of shipment. Indicates whether deliveryDetails or pickupDetails is applicable for this shipment. + */ + type?: string | null; } export interface Schema$OrderLineItemShippingDetailsMethod { /** * The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * Maximum transit time. */ - maxDaysInTransit?: number; + maxDaysInTransit?: number | null; /** * The name of the shipping method. */ - methodName?: string; + methodName?: string | null; /** * Minimum transit time. */ - minDaysInTransit?: number; + minDaysInTransit?: number | null; } export interface Schema$OrderMerchantProvidedAnnotation { /** * Key for additional merchant provided (as key-value pairs) annotation about the line item. */ - key?: string; + key?: string | null; /** * Value for additional merchant provided (as key-value pairs) annotation about the line item. */ - value?: string; + value?: string | null; + } + export interface Schema$OrderPickupDetails { + /** + * Address of the pickup location where the shipment should be sent. Note that recipientName in the address is the name of the business at the pickup location. + */ + address?: Schema$OrderAddress; + /** + * Collectors authorized to pick up shipment from the pickup location. + */ + collectors?: Schema$OrderPickupDetailsCollector[]; + /** + * ID of the pickup location. + */ + locationId?: string | null; + } + export interface Schema$OrderPickupDetailsCollector { + /** + * Name of the person picking up the shipment. + */ + name?: string | null; + /** + * Phone number of the person picking up the shipment. + */ + phoneNumber?: string | null; } export interface Schema$OrderPromotion { /** @@ -2152,11 +2188,11 @@ export namespace content_v2_1 { /** * The party funding the promotion. */ - funder?: string; + funder?: string | null; /** * This field is used to identify promotions within merchants' own systems. */ - merchantPromotionId?: string; + merchantPromotionId?: string | null; /** * Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order. */ @@ -2164,11 +2200,11 @@ export namespace content_v2_1 { /** * A short title of the promotion to be shown on the checkout page. */ - shortTitle?: string; + shortTitle?: string | null; /** * The category of the promotion. */ - subtype?: string; + subtype?: string | null; /** * Estimated discount applied to tax (if allowed by law). */ @@ -2176,25 +2212,25 @@ export namespace content_v2_1 { /** * The title of the promotion. */ - title?: string; + title?: string | null; /** * The scope of the promotion. */ - type?: string; + type?: string | null; } export interface Schema$OrderPromotionItem { - lineItemId?: string; - productId?: string; + lineItemId?: string | null; + productId?: string | null; /** * The quantity of the associated product. */ - quantity?: number; + quantity?: number | null; } export interface Schema$OrderRefund { /** * The actor that created the refund. */ - actor?: string; + actor?: string | null; /** * The amount that is refunded. */ @@ -2202,15 +2238,15 @@ export namespace content_v2_1 { /** * Date on which the item has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * The reason for the refund. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } /** * Order disbursement. All methods require the payment analyst role. @@ -2223,19 +2259,19 @@ export namespace content_v2_1 { /** * The disbursement date, in ISO 8601 format. */ - disbursementCreationDate?: string; + disbursementCreationDate?: string | null; /** * The date the disbursement was initiated, in ISO 8601 format. */ - disbursementDate?: string; + disbursementDate?: string | null; /** * The ID of the disbursement. */ - disbursementId?: string; + disbursementId?: string | null; /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; } export interface Schema$OrderreportsListDisbursementsResponse { /** @@ -2245,21 +2281,21 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of disbursements. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$OrderreportsListTransactionsResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of transactions. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of transactions. */ @@ -2273,27 +2309,27 @@ export namespace content_v2_1 { /** * The date the disbursement was created, in ISO 8601 format. */ - disbursementCreationDate?: string; + disbursementCreationDate?: string | null; /** * The date the disbursement was initiated, in ISO 8601 format. */ - disbursementDate?: string; + disbursementDate?: string | null; /** * The ID of the disbursement. */ - disbursementId?: string; + disbursementId?: string | null; /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * Merchant-provided ID of the order. */ - merchantOrderId?: string; + merchantOrderId?: string | null; /** * The ID of the order. */ - orderId?: string; + orderId?: string | null; /** * Total amount for the items. */ @@ -2301,144 +2337,144 @@ export namespace content_v2_1 { /** * The date of the transaction, in ISO 8601 format. */ - transactionDate?: string; + transactionDate?: string | null; } export interface Schema$OrderReturn { /** * The actor that created the refund. */ - actor?: string; + actor?: string | null; /** * Date on which the item has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * Quantity that is returned. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrderreturnsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of returns. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$MerchantOrderReturn[]; } export interface Schema$OrdersAcknowledgeRequest { /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; } export interface Schema$OrdersAcknowledgeResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersAdvanceTestOrderResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCancelLineItemRequest { /** * The ID of the line item to cancel. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to cancel. */ - quantity?: number; + quantity?: number | null; /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCancelLineItemResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCancelRequest { /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCancelResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCancelTestOrderByCustomerRequest { /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; } export interface Schema$OrdersCancelTestOrderByCustomerResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCreateTestOrderRequest { /** * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order. Acceptable values are: - "US" - "FR" Defaults to US. */ - country?: string; + country?: string | null; /** * The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. */ - templateName?: string; + templateName?: string | null; /** * The test order to create. */ @@ -2448,11 +2484,11 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse". */ - kind?: string; + kind?: string | null; /** * The ID of the newly created test order. */ - orderId?: string; + orderId?: string | null; } export interface Schema$OrdersCreateTestReturnRequest { /** @@ -2464,41 +2500,41 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse". */ - kind?: string; + kind?: string | null; /** * The ID of the newly created test order return. */ - returnId?: string; + returnId?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryCreateTestReturnReturnItem { /** * The ID of the line item to return. */ - lineItemId?: string; + lineItemId?: string | null; /** * Quantity that is returned. */ - quantity?: number; + quantity?: number | null; } export interface Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { /** * The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * The ID of the shipment. This is assigned by the merchant and is unique to each shipment. */ - shipmentId?: string; + shipmentId?: string | null; /** * The tracking ID for the shipment. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrdersGetByMerchantOrderIdResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse". */ - kind?: string; + kind?: string | null; /** * The requested order. */ @@ -2508,7 +2544,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse". */ - kind?: string; + kind?: string | null; /** * The requested test order template. */ @@ -2518,19 +2554,19 @@ export namespace content_v2_1 { /** * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" */ - carrier?: string; + carrier?: string | null; /** * Date on which the shipment has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered */ - deliveryDate?: string; + deliveryDate?: string | null; /** * The ID of the shipment. */ - id?: string; + id?: string | null; /** * The line items that are shipped. */ @@ -2538,39 +2574,39 @@ export namespace content_v2_1 { /** * The shipment group ID of the shipment. This is set in shiplineitems request. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; /** * The status of the shipment. */ - status?: string; + status?: string | null; /** * The tracking ID for the shipment. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrderShipmentLineItemShipment { /** * The ID of the line item that is shipped. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity that is shipped. */ - quantity?: number; + quantity?: number | null; } export interface Schema$OrdersInStoreRefundLineItemRequest { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required. */ @@ -2578,19 +2614,19 @@ export namespace content_v2_1 { /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; /** * The amount of tax to be refunded. Required. */ @@ -2600,68 +2636,68 @@ export namespace content_v2_1 { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of orders. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Order[]; } export interface Schema$OrdersRejectReturnLineItemRequest { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersRejectReturnLineItemResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersReturnRefundLineItemRequest { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed. */ @@ -2669,19 +2705,19 @@ export namespace content_v2_1 { /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; /** * The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided. */ @@ -2691,36 +2727,36 @@ export namespace content_v2_1 { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersSetLineItemMetadataRequest { annotations?: Schema$OrderMerchantProvidedAnnotation[]; /** * The ID of the line item to set metadata. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; } export interface Schema$OrdersSetLineItemMetadataResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersShipLineItemsRequest { /** @@ -2730,11 +2766,11 @@ export namespace content_v2_1 { /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * ID of the shipment group. Required for orders that use the orderinvoices service. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; /** * Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs). */ @@ -2744,99 +2780,99 @@ export namespace content_v2_1 { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersUpdateLineItemShippingDetailsRequest { /** * Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ - deliverByDate?: string; + deliverByDate?: string | null; /** * The ID of the line item to set metadata. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ - shipByDate?: string; + shipByDate?: string | null; } export interface Schema$OrdersUpdateLineItemShippingDetailsResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersUpdateMerchantOrderIdRequest { /** * The merchant order id to be assigned to the order. Must be unique per merchant. */ - merchantOrderId?: string; + merchantOrderId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; } export interface Schema$OrdersUpdateMerchantOrderIdResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersUpdateShipmentRequest { /** * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. */ - deliveryDate?: string; + deliveryDate?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the shipment. */ - shipmentId?: string; + shipmentId?: string | null; /** * New status for the shipment. Not updated if missing. */ - status?: string; + status?: string | null; /** * The tracking ID for the shipment. Not updated if missing. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrdersUpdateShipmentResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$PosCustomBatchRequest { /** @@ -2848,7 +2884,7 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The inventory to submit. Set this only if the method is inventory. */ @@ -2856,8 +2892,8 @@ export namespace content_v2_1 { /** * The ID of the POS data provider. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The sale information to submit. Set this only if the method is sale. */ @@ -2869,11 +2905,11 @@ export namespace content_v2_1 { /** * The store code. Set this only if the method is delete or get. */ - storeCode?: string; + storeCode?: string | null; /** * The ID of the account for which to get/submit data. */ - targetMerchantId?: string; + targetMerchantId?: string | null; } export interface Schema$PosCustomBatchResponse { /** @@ -2883,13 +2919,13 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$PosCustomBatchResponseEntry { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -2901,7 +2937,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The updated sale information. */ @@ -2915,7 +2951,7 @@ export namespace content_v2_1 { /** * Country code. */ - country?: string; + country?: string | null; /** * A list of POS data providers. */ @@ -2925,15 +2961,15 @@ export namespace content_v2_1 { /** * The display name of Pos data Provider. */ - displayName?: string; + displayName?: string | null; /** * The full name of this POS data Provider. */ - fullName?: string; + fullName?: string | null; /** * The ID of the account. */ - providerId?: string; + providerId?: string | null; } /** * The absolute quantity of an item available at the given store. @@ -2942,19 +2978,19 @@ export namespace content_v2_1 { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posInventory". */ - kind?: string; + kind?: string | null; /** * The current price of the item. */ @@ -2962,33 +2998,33 @@ export namespace content_v2_1 { /** * The available quantity of the item. */ - quantity?: string; + quantity?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosInventoryRequest { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * The current price of the item. */ @@ -2996,37 +3032,37 @@ export namespace content_v2_1 { /** * The available quantity of the item. */ - quantity?: string; + quantity?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosInventoryResponse { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse". */ - kind?: string; + kind?: string | null; /** * The current price of the item. */ @@ -3034,25 +3070,25 @@ export namespace content_v2_1 { /** * The available quantity of the item. */ - quantity?: string; + quantity?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#posListResponse". */ - kind?: string; + kind?: string | null; resources?: Schema$PosStore[]; } /** @@ -3062,19 +3098,19 @@ export namespace content_v2_1 { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posSale". */ - kind?: string; + kind?: string | null; /** * The price of the item. */ @@ -3082,37 +3118,37 @@ export namespace content_v2_1 { /** * The relative change of the available quantity. Negative for items returned. */ - quantity?: string; + quantity?: string | null; /** * A unique ID to group items from the same sale event. */ - saleId?: string; + saleId?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosSaleRequest { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * The price of the item. */ @@ -3120,41 +3156,41 @@ export namespace content_v2_1 { /** * The relative change of the available quantity. Negative for items returned. */ - quantity?: string; + quantity?: string | null; /** * A unique ID to group items from the same sale event. */ - saleId?: string; + saleId?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosSaleResponse { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse". */ - kind?: string; + kind?: string | null; /** * The price of the item. */ @@ -3162,23 +3198,23 @@ export namespace content_v2_1 { /** * The relative change of the available quantity. Negative for items returned. */ - quantity?: string; + quantity?: string | null; /** * A unique ID to group items from the same sale event. */ - saleId?: string; + saleId?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } /** * Store resource. @@ -3187,25 +3223,25 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#posStore". */ - kind?: string; + kind?: string | null; /** * The street address of the store. */ - storeAddress?: string; + storeAddress?: string | null; /** * A store identifier that is unique for the given merchant. */ - storeCode?: string; + storeCode?: string | null; } export interface Schema$PostalCodeGroup { /** * The CLDR territory code of the country the postal code group applies to. Required. */ - country?: string; + country?: string | null; /** * The name of the postal code group, referred to in headers. Required. */ - name?: string; + name?: string | null; /** * A range of postal codes. Required. */ @@ -3215,21 +3251,21 @@ export namespace content_v2_1 { /** * A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required. */ - postalCodeRangeBegin?: string; + postalCodeRangeBegin?: string | null; /** * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. */ - postalCodeRangeEnd?: string; + postalCodeRangeEnd?: string | null; } export interface Schema$Price { /** * The currency of the price. */ - currency?: string; + currency?: string | null; /** * The price represented as a number. */ - value?: string; + value?: string | null; } /** * Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. @@ -3238,55 +3274,55 @@ export namespace content_v2_1 { /** * Additional URLs of images of the item. */ - additionalImageLinks?: string[]; + additionalImageLinks?: string[] | null; /** * Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. */ - adsGrouping?: string; + adsGrouping?: string | null; /** * Similar to ads_grouping, but only works on CPC. */ - adsLabels?: string[]; + adsLabels?: string[] | null; /** * Allows advertisers to override the item URL when the product is shown within the context of Product Ads. */ - adsRedirect?: string; + adsRedirect?: string | null; /** * Set to true if the item is targeted towards adults. */ - adult?: boolean; + adult?: boolean | null; /** * Target age group of the item. */ - ageGroup?: string; + ageGroup?: string | null; /** * Availability status of the item. */ - availability?: string; + availability?: string | null; /** * The day a pre-ordered product becomes available for delivery, in ISO 8601 format. */ - availabilityDate?: string; + availabilityDate?: string | null; /** * Brand of the item. */ - brand?: string; + brand?: string | null; /** * The item's channel (online or local). */ - channel?: string; + channel?: string | null; /** * Color of the item. */ - color?: string; + color?: string | null; /** * Condition or state of the item. */ - condition?: string; + condition?: string | null; /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Cost of goods sold. Used for gross profit reporting. */ @@ -3298,87 +3334,87 @@ export namespace content_v2_1 { /** * Custom label 0 for custom grouping of items in a Shopping campaign. */ - customLabel0?: string; + customLabel0?: string | null; /** * Custom label 1 for custom grouping of items in a Shopping campaign. */ - customLabel1?: string; + customLabel1?: string | null; /** * Custom label 2 for custom grouping of items in a Shopping campaign. */ - customLabel2?: string; + customLabel2?: string | null; /** * Custom label 3 for custom grouping of items in a Shopping campaign. */ - customLabel3?: string; + customLabel3?: string | null; /** * Custom label 4 for custom grouping of items in a Shopping campaign. */ - customLabel4?: string; + customLabel4?: string | null; /** * Description of the item. */ - description?: string; + description?: string | null; /** * An identifier for an item for dynamic remarketing campaigns. */ - displayAdsId?: string; + displayAdsId?: string | null; /** * URL directly to your item's landing page for dynamic remarketing campaigns. */ - displayAdsLink?: string; + displayAdsLink?: string | null; /** * Advertiser-specified recommendations. */ - displayAdsSimilarIds?: string[]; + displayAdsSimilarIds?: string[] | null; /** * Title of an item for dynamic remarketing campaigns. */ - displayAdsTitle?: string; + displayAdsTitle?: string | null; /** * Offer margin for dynamic remarketing campaigns. */ - displayAdsValue?: number; + displayAdsValue?: number | null; /** * The energy efficiency class as defined in EU directive 2010/30/EU. */ - energyEfficiencyClass?: string; + energyEfficiencyClass?: string | null; /** * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). */ - excludedDestinations?: string[]; + excludedDestinations?: string[] | null; /** * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. */ - expirationDate?: string; + expirationDate?: string | null; /** * Target gender of the item. */ - gender?: string; + gender?: string | null; /** * Google's category of the item (see Google product taxonomy). */ - googleProductCategory?: string; + googleProductCategory?: string | null; /** * Global Trade Item Number (GTIN) of the item. */ - gtin?: string; + gtin?: string | null; /** * The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. */ - id?: string; + id?: string | null; /** * False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada. */ - identifierExists?: boolean; + identifierExists?: boolean | null; /** * URL of an image of the item. */ - imageLink?: string; + imageLink?: string | null; /** * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. */ - includedDestinations?: string[]; + includedDestinations?: string[] | null; /** * Number and amount of installments to pay for an item. Brazil only. */ @@ -3386,19 +3422,19 @@ export namespace content_v2_1 { /** * Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. */ - isBundle?: boolean; + isBundle?: boolean | null; /** * Shared identifier for all variants of the same product. */ - itemGroupId?: string; + itemGroupId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#product". */ - kind?: string; + kind?: string | null; /** * URL directly linking to your item's page on your website. */ - link?: string; + link?: string | null; /** * Loyalty points that users receive after purchasing the item. Japan only. */ @@ -3406,43 +3442,43 @@ export namespace content_v2_1 { /** * The material of which the item is made. */ - material?: string; + material?: string | null; /** * The energy efficiency class as defined in EU directive 2010/30/EU. */ - maxEnergyEfficiencyClass?: string; + maxEnergyEfficiencyClass?: string | null; /** * Maximal product handling time (in business days). */ - maxHandlingTime?: string; + maxHandlingTime?: string | null; /** * The energy efficiency class as defined in EU directive 2010/30/EU. */ - minEnergyEfficiencyClass?: string; + minEnergyEfficiencyClass?: string | null; /** * Minimal product handling time (in business days). */ - minHandlingTime?: string; + minHandlingTime?: string | null; /** * Link to a mobile-optimized version of the landing page. */ - mobileLink?: string; + mobileLink?: string | null; /** * Manufacturer Part Number (MPN) of the item. */ - mpn?: string; + mpn?: string | null; /** * The number of identical products in a merchant-defined multipack. */ - multipack?: string; + multipack?: string | null; /** * A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. Note: Content API methods that operate on products take the REST ID of the product, not this identifier. */ - offerId?: string; + offerId?: string | null; /** * The item's pattern (e.g. polka dots). */ - pattern?: string; + pattern?: string | null; /** * Price of the item. */ @@ -3450,11 +3486,11 @@ export namespace content_v2_1 { /** * Categories of the item (formatted as in products data specification). */ - productTypes?: string[]; + productTypes?: string[] | null; /** * The unique ID of a promotion. */ - promotionIds?: string[]; + promotionIds?: string[] | null; /** * Advertised sale price of the item. */ @@ -3462,11 +3498,11 @@ export namespace content_v2_1 { /** * Date range during which the item is on sale (see products data specification). */ - salePriceEffectiveDate?: string; + salePriceEffectiveDate?: string | null; /** * The quantity of the product that is available for selling on Google. Supported only for online products. */ - sellOnGoogleQuantity?: string; + sellOnGoogleQuantity?: string | null; /** * Shipping rules. */ @@ -3478,7 +3514,7 @@ export namespace content_v2_1 { /** * The shipping label of the product, used to group product in account-level shipping rules. */ - shippingLabel?: string; + shippingLabel?: string | null; /** * Length of the item for shipping. */ @@ -3494,27 +3530,27 @@ export namespace content_v2_1 { /** * Size of the item. */ - sizes?: string[]; + sizes?: string[] | null; /** * System in which the size is specified. Recommended for apparel items. */ - sizeSystem?: string; + sizeSystem?: string | null; /** * The cut of the item. Recommended for apparel items. */ - sizeType?: string; + sizeType?: string | null; /** * The source of the offer, i.e., how the offer was created. */ - source?: string; + source?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The tax category of the product, used to configure detailed tax nexus in account-level tax settings. */ - taxCategory?: string; + taxCategory?: string | null; /** * Tax information. */ @@ -3522,11 +3558,11 @@ export namespace content_v2_1 { /** * Title of the item. */ - title?: string; + title?: string | null; /** * The transit time label of the product, used to group product in account-level transit time tables. */ - transitTimeLabel?: string; + transitTimeLabel?: string | null; /** * The preference of the denominator of the unit price. */ @@ -3563,16 +3599,16 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The Content API feed id. */ - feedId?: string; + feedId?: string | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The product to insert. Only required if the method is insert. */ @@ -3580,7 +3616,7 @@ export namespace content_v2_1 { /** * The ID of the product to get or delete. Only defined if the method is get or delete. */ - productId?: string; + productId?: string | null; } export interface Schema$ProductsCustomBatchResponse { /** @@ -3590,7 +3626,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch products response. @@ -3599,7 +3635,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -3607,7 +3643,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The inserted product. Only defined if the method is insert and if the request was successful. */ @@ -3617,19 +3653,19 @@ export namespace content_v2_1 { /** * The CLDR territory code of the country to which an item will ship. */ - country?: string; + country?: string | null; /** * The location where the shipping is applicable, represented by a location group name. */ - locationGroupName?: string; + locationGroupName?: string | null; /** * The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. */ - locationId?: string; + locationId?: string | null; /** * The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length. */ - postalCode?: string; + postalCode?: string | null; /** * Fixed shipping price, represented as a number. */ @@ -3637,41 +3673,41 @@ export namespace content_v2_1 { /** * The geographic region to which a shipping rate applies. */ - region?: string; + region?: string | null; /** * A free-form description of the service class or delivery speed. */ - service?: string; + service?: string | null; } export interface Schema$ProductShippingDimension { /** * The unit of value. */ - unit?: string; + unit?: string | null; /** * The dimension of the product used to calculate the shipping cost of the item. */ - value?: number; + value?: number | null; } export interface Schema$ProductShippingWeight { /** * The unit of value. */ - unit?: string; + unit?: string | null; /** * The weight of the product used to calculate the shipping cost of the item. */ - value?: number; + value?: number | null; } export interface Schema$ProductsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of products. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Product[]; } /** @@ -3681,7 +3717,7 @@ export namespace content_v2_1 { /** * Date on which the item has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * The intended destinations for the product. */ @@ -3689,7 +3725,7 @@ export namespace content_v2_1 { /** * Date on which the item expires in Google Shopping, in ISO 8601 format. */ - googleExpirationDate?: string; + googleExpirationDate?: string | null; /** * A list of all issues associated with the product. */ @@ -3697,30 +3733,30 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productStatus". */ - kind?: string; + kind?: string | null; /** * Date on which the item has been last updated, in ISO 8601 format. */ - lastUpdateDate?: string; + lastUpdateDate?: string | null; /** * The link to the product. */ - link?: string; + link?: string | null; /** * The ID of the product for which status is reported. */ - productId?: string; + productId?: string | null; /** * The title of the product. */ - title?: string; + title?: string | null; } export interface Schema$ProductStatusDestinationStatus { /** * The name of the destination */ - destination?: string; - status?: string; + destination?: string | null; + status?: string | null; } export interface Schema$ProductstatusesCustomBatchRequest { /** @@ -3735,21 +3771,21 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ - destinations?: string[]; - includeAttributes?: boolean; + destinations?: string[] | null; + includeAttributes?: boolean | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The ID of the product whose status to get. */ - productId?: string; + productId?: string | null; } export interface Schema$ProductstatusesCustomBatchResponse { /** @@ -3759,7 +3795,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch productstatuses response. @@ -3768,7 +3804,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors, if the request failed. */ @@ -3776,7 +3812,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The requested product status. Only defined if the request was successful. */ @@ -3786,98 +3822,98 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of products statuses. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$ProductStatus[]; } export interface Schema$ProductStatusItemLevelIssue { /** * The attribute's name, if the issue is caused by a single attribute. */ - attributeName?: string; + attributeName?: string | null; /** * The error code of the issue. */ - code?: string; + code?: string | null; /** * A short issue description in English. */ - description?: string; + description?: string | null; /** * The destination the issue applies to. */ - destination?: string; + destination?: string | null; /** * A detailed issue description in English. */ - detail?: string; + detail?: string | null; /** * The URL of a web page to help with resolving this issue. */ - documentation?: string; + documentation?: string | null; /** * Whether the issue can be resolved by the merchant. */ - resolution?: string; + resolution?: string | null; /** * How this issue affects serving of the offer. */ - servability?: string; + servability?: string | null; } export interface Schema$ProductTax { /** * The country within which the item is taxed, specified as a CLDR territory code. */ - country?: string; + country?: string | null; /** * The numeric ID of a location that the tax rate applies to as defined in the AdWords API. */ - locationId?: string; + locationId?: string | null; /** * The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*. */ - postalCode?: string; + postalCode?: string | null; /** * The percentage of tax rate that applies to the item price. */ - rate?: number; + rate?: number | null; /** * The geographic region to which the tax rate applies. */ - region?: string; + region?: string | null; /** * Set to true if tax is charged on shipping. */ - taxShip?: boolean; + taxShip?: boolean | null; } export interface Schema$ProductUnitPricingBaseMeasure { /** * The unit of the denominator. */ - unit?: string; + unit?: string | null; /** * The denominator of the unit price. */ - value?: string; + value?: string | null; } export interface Schema$ProductUnitPricingMeasure { /** * The unit of the measure. */ - unit?: string; + unit?: string | null; /** * The measure of an item. */ - value?: number; + value?: number | null; } export interface Schema$RateGroup { /** * A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required. */ - applicableShippingLabels?: string[]; + applicableShippingLabels?: string[] | null; /** * A list of carrier rates that can be referred to by mainTable or singleValue. */ @@ -3889,7 +3925,7 @@ export namespace content_v2_1 { /** * Name of the rate group. Optional. If set has to be unique within shipping service. */ - name?: string; + name?: string | null; /** * The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set. */ @@ -3900,8 +3936,8 @@ export namespace content_v2_1 { subtables?: Schema$Table[]; } export interface Schema$RefundReason { - description?: string; - reasonCode?: string; + description?: string | null; + reasonCode?: string | null; } /** * Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. @@ -3910,7 +3946,7 @@ export namespace content_v2_1 { /** * The availability of the product. */ - availability?: string; + availability?: string | null; /** * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form. */ @@ -3918,7 +3954,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory". */ - kind?: string; + kind?: string | null; /** * The price of the product. */ @@ -3926,7 +3962,7 @@ export namespace content_v2_1 { /** * The ID (name) of the region. */ - regionId?: string; + regionId?: string | null; /** * The sale price of the product. Mandatory if sale_price_effective_date is defined. */ @@ -3934,7 +3970,7 @@ export namespace content_v2_1 { /** * A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. */ - salePriceEffectiveDate?: string; + salePriceEffectiveDate?: string | null; } export interface Schema$RegionalinventoryCustomBatchRequest { /** @@ -3949,16 +3985,16 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The ID of the product for which to update price and availability. */ - productId?: string; + productId?: string | null; /** * Price and availability of the product. */ @@ -3972,7 +4008,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch regional inventory response. @@ -3981,7 +4017,7 @@ export namespace content_v2_1 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -3989,7 +4025,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * Price and availability of the product. */ @@ -4006,49 +4042,49 @@ export namespace content_v2_1 { /** * The country of sale where the return address is applicable. */ - country?: string; + country?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#returnAddress". */ - kind?: string; + kind?: string | null; /** * The user-defined label of the return address. For the default address, use the label "default". */ - label?: string; + label?: string | null; /** * The merchant's contact phone number regarding the return. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * Return address ID generated by Google. */ - returnAddressId?: string; + returnAddressId?: string | null; } export interface Schema$ReturnAddressAddress { /** * CLDR country code (e.g. "US"). */ - country?: string; + country?: string | null; /** * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ - locality?: string; + locality?: string | null; /** * Postal code or ZIP (e.g. "94043"). */ - postalCode?: string; + postalCode?: string | null; /** * Name of the recipient to address returns to. */ - recipientName?: string; + recipientName?: string | null; /** * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ - region?: string; + region?: string | null; /** * Street-level part of the address. May be up to two lines, each line specified as an array element. */ - streetAddress?: string[]; + streetAddress?: string[] | null; } export interface Schema$ReturnaddressCustomBatchRequest { /** @@ -4060,12 +4096,12 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The Merchant Center account ID. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The return address to submit. Set this only if the method is insert. */ @@ -4073,7 +4109,7 @@ export namespace content_v2_1 { /** * The return address ID. Set this only if the method is delete or get. */ - returnAddressId?: string; + returnAddressId?: string | null; } export interface Schema$ReturnaddressCustomBatchResponse { /** @@ -4083,13 +4119,13 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$ReturnaddressCustomBatchResponseEntry { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -4097,7 +4133,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The retrieved return address. */ @@ -4107,11 +4143,11 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#returnaddressListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of addresses. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$ReturnAddress[]; } /** @@ -4121,23 +4157,23 @@ export namespace content_v2_1 { /** * The country of sale where the return policy is applicable. */ - country?: string; + country?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#returnPolicy". */ - kind?: string; + kind?: string | null; /** * The user-defined label of the return policy. For the default policy, use the label "default". */ - label?: string; + label?: string | null; /** * The name of the policy as shown in Merchant Center. */ - name?: string; + name?: string | null; /** * Return reasons that will incur return fees. */ - nonFreeReturnReasons?: string[]; + nonFreeReturnReasons?: string[] | null; /** * The policy. */ @@ -4145,7 +4181,7 @@ export namespace content_v2_1 { /** * Return policy ID generated by Google. */ - returnPolicyId?: string; + returnPolicyId?: string | null; /** * An optional list of seasonal overrides. */ @@ -4161,12 +4197,12 @@ export namespace content_v2_1 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The Merchant Center account ID. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The return policy to submit. Set this only if the method is insert. */ @@ -4174,7 +4210,7 @@ export namespace content_v2_1 { /** * The return policy ID. Set this only if the method is delete or get. */ - returnPolicyId?: string; + returnPolicyId?: string | null; } export interface Schema$ReturnpolicyCustomBatchResponse { /** @@ -4184,13 +4220,13 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#returnpolicyCustomBatchResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$ReturnpolicyCustomBatchResponseEntry { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -4198,7 +4234,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#returnpolicyCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The retrieved return policy. */ @@ -4208,32 +4244,32 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#returnpolicyListResponse". */ - kind?: string; + kind?: string | null; resources?: Schema$ReturnPolicy[]; } export interface Schema$ReturnPolicyPolicy { /** * Last day for returning the items. In ISO 8601 format. When specifying the return window like this, set the policy type to "lastReturnDate". Use this for seasonal overrides only. */ - lastReturnDate?: string; + lastReturnDate?: string | null; /** * The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. When specifying the return window like this, set the policy type to "numberOfDaysAfterDelivery". Acceptable values are 30, 45, 60, 90, 100, 180, 270 and 365 for the default policy. Additional policies further allow 14, 15, 21 and 28 days, but note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics. A policy of less than 30 days can only be applied to those items. */ - numberOfDays?: string; + numberOfDays?: string | null; /** * Policy type. Use "lastReturnDate" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items. */ - type?: string; + type?: string | null; } export interface Schema$ReturnPolicySeasonalOverride { /** * Last day on which the override applies. In ISO 8601 format. */ - endDate?: string; + endDate?: string | null; /** * The name of the seasonal override as shown in Merchant Center. */ - name?: string; + name?: string | null; /** * The policy which is in effect during that time. */ @@ -4241,16 +4277,16 @@ export namespace content_v2_1 { /** * First day on which the override applies. In ISO 8601 format. */ - startDate?: string; + startDate?: string | null; } export interface Schema$ReturnShipment { - creationDate?: string; - deliveryDate?: string; - returnMethodType?: string; - shipmentId?: string; + creationDate?: string | null; + deliveryDate?: string | null; + returnMethodType?: string | null; + shipmentId?: string | null; shipmentTrackingInfos?: Schema$ShipmentTrackingInfo[]; - shippingDate?: string; - state?: string; + shippingDate?: string | null; + state?: string | null; } export interface Schema$Row { /** @@ -4262,15 +4298,15 @@ export namespace content_v2_1 { /** * A boolean exposing the active status of the shipping service. Required. */ - active?: boolean; + active?: boolean | null; /** * The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. */ - currency?: string; + currency?: string | null; /** * The CLDR territory code of the country to which the service applies. Required. */ - deliveryCountry?: string; + deliveryCountry?: string | null; /** * Time spent in various aspects from order to the delivery of the product. Required. */ @@ -4278,7 +4314,7 @@ export namespace content_v2_1 { /** * Eligibility for this service. */ - eligibility?: string; + eligibility?: string | null; /** * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. */ @@ -4286,7 +4322,7 @@ export namespace content_v2_1 { /** * Free-form name of the service. Must be unique within target account. Required. */ - name?: string; + name?: string | null; /** * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. */ @@ -4304,29 +4340,29 @@ export namespace content_v2_1 { /** * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; } export interface Schema$ShipmentInvoiceLineItemInvoice { /** * ID of the line item. Either lineItemId or productId must be set. */ - lineItemId?: string; + lineItemId?: string | null; /** * ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set. */ - productId?: string; + productId?: string | null; /** * [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units). */ - shipmentUnitIds?: string[]; + shipmentUnitIds?: string[] | null; /** * [required] Invoice details for a single unit. */ unitInvoice?: Schema$UnitInvoice; } export interface Schema$ShipmentTrackingInfo { - carrier?: string; - trackingNumber?: string; + carrier?: string | null; + trackingNumber?: string | null; } /** * The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. @@ -4335,7 +4371,7 @@ export namespace content_v2_1 { /** * The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses. */ - accountId?: string; + accountId?: string | null; /** * A list of postal code groups that can be referred to in services. Optional. */ @@ -4358,16 +4394,16 @@ export namespace content_v2_1 { /** * The ID of the account for which to get/update account shipping settings. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The account shipping settings to update. Only defined if the method is update. */ @@ -4381,7 +4417,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch shipping settings response. @@ -4390,7 +4426,7 @@ export namespace content_v2_1 { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -4398,7 +4434,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The retrieved or updated account shipping settings. */ @@ -4412,7 +4448,7 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$ShippingsettingsGetSupportedHolidaysResponse { /** @@ -4422,17 +4458,17 @@ export namespace content_v2_1 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$ShippingsettingsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of shipping settings. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$ShippingSettings[]; } export interface Schema$Table { @@ -4443,7 +4479,7 @@ export namespace content_v2_1 { /** * Name of the table. Required for subtables, ignored for the main table. */ - name?: string; + name?: string | null; /** * Headers of the table's rows. Required. */ @@ -4457,11 +4493,11 @@ export namespace content_v2_1 { /** * Whether the orderinvoices service should support this order. */ - enableOrderinvoices?: boolean; + enableOrderinvoices?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#testOrder". */ - kind?: string; + kind?: string | null; /** * Line items that are ordered. At least one line item must be provided. */ @@ -4469,19 +4505,23 @@ export namespace content_v2_1 { /** * Determines if test order must be pulled by merchant or pushed to merchant via push integration. */ - notificationMode?: string; + notificationMode?: string | null; /** * The billing address. */ - predefinedBillingAddress?: string; + predefinedBillingAddress?: string | null; /** * Identifier of one of the predefined delivery addresses for the delivery. */ - predefinedDeliveryAddress?: string; + predefinedDeliveryAddress?: string | null; /** * Email address of the customer. */ - predefinedEmail?: string; + predefinedEmail?: string | null; + /** + * Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup. + */ + predefinedPickupDetails?: string | null; /** * Promotions associated with the order. */ @@ -4493,7 +4533,7 @@ export namespace content_v2_1 { /** * The requested shipping option. */ - shippingOption?: string; + shippingOption?: string | null; } export interface Schema$TestOrderLineItem { /** @@ -4503,7 +4543,7 @@ export namespace content_v2_1 { /** * Number of items ordered. */ - quantityOrdered?: number; + quantityOrdered?: number | null; /** * Details of the return policy for the line item. */ @@ -4517,15 +4557,15 @@ export namespace content_v2_1 { /** * Brand of the item. */ - brand?: string; + brand?: string | null; /** * Condition or state of the item. */ - condition?: string; + condition?: string | null; /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Fees for the item. Optional. */ @@ -4533,23 +4573,23 @@ export namespace content_v2_1 { /** * Global Trade Item Number (GTIN) of the item. Optional. */ - gtin?: string; + gtin?: string | null; /** * URL of an image of the item. */ - imageLink?: string; + imageLink?: string | null; /** * Shared identifier for all variants of the same product. Optional. */ - itemGroupId?: string; + itemGroupId?: string | null; /** * Manufacturer Part Number (MPN) of the item. Optional. */ - mpn?: string; + mpn?: string | null; /** * An identifier of the item. */ - offerId?: string; + offerId?: string | null; /** * The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. */ @@ -4557,11 +4597,11 @@ export namespace content_v2_1 { /** * The CLDR territory code of the target country of the product. */ - targetCountry?: string; + targetCountry?: string | null; /** * The title of the product. */ - title?: string; + title?: string | null; /** * Variant attributes for the item. Optional. */ @@ -4571,12 +4611,12 @@ export namespace content_v2_1 { /** * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. */ - postalCodeGroupNames?: string[]; + postalCodeGroupNames?: string[] | null; rows?: Schema$TransitTableTransitTimeRow[]; /** * A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"]. */ - transitTimeLabels?: string[]; + transitTimeLabels?: string[] | null; } export interface Schema$TransitTableTransitTimeRow { values?: Schema$TransitTableTransitTimeRowTransitTimeValue[]; @@ -4585,11 +4625,11 @@ export namespace content_v2_1 { /** * Must be greater than or equal to minTransitTimeInDays. */ - maxTransitTimeInDays?: number; + maxTransitTimeInDays?: number | null; /** * Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery. */ - minTransitTimeInDays?: number; + minTransitTimeInDays?: number | null; } export interface Schema$UnitInvoice { /** @@ -4613,7 +4653,7 @@ export namespace content_v2_1 { /** * [required] Type of the additional charge. */ - type?: string; + type?: string | null; } export interface Schema$UnitInvoiceTaxLine { /** @@ -4623,11 +4663,11 @@ export namespace content_v2_1 { /** * Optional name of the tax type. This should only be provided if taxType is otherFeeTax. */ - taxName?: string; + taxName?: string | null; /** * [required] Type of the tax. */ - taxType?: string; + taxType?: string | null; } /** * The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. @@ -4636,7 +4676,7 @@ export namespace content_v2_1 { /** * The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. */ - carrierRateName?: string; + carrierRateName?: string | null; /** * A flat rate. Can only be set if all other fields are not set. */ @@ -4644,25 +4684,25 @@ export namespace content_v2_1 { /** * If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set. */ - noShipping?: boolean; + noShipping?: boolean | null; /** * A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set. */ - pricePercentage?: string; + pricePercentage?: string | null; /** * The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set. */ - subtableName?: string; + subtableName?: string | null; } export interface Schema$Weight { /** * The weight unit. */ - unit?: string; + unit?: string | null; /** * The weight represented as a number. */ - value?: string; + value?: string | null; } export class Resource$Accounts { diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index e9fbc9740a9..2634620ddd3 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -138,7 +138,7 @@ export namespace content_v2 { /** * Indicates whether the merchant sells adult content. */ - adultContent?: boolean; + adultContent?: boolean | null; /** * List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. */ @@ -154,23 +154,23 @@ export namespace content_v2 { /** * Merchant Center account ID. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#account". */ - kind?: string; + kind?: string | null; /** * Display name for the account. */ - name?: string; + name?: string | null; /** * [DEPRECATED] This field is never returned and will be ignored if provided. */ - reviewsUrl?: string; + reviewsUrl?: string | null; /** * Client-specific, locally-unique, internal ID for the child account. */ - sellerId?: string; + sellerId?: string | null; /** * Users with access to the account. Every account (except for subaccounts) must have at least one admin user. */ @@ -178,7 +178,7 @@ export namespace content_v2 { /** * The merchant's website. */ - websiteUrl?: string; + websiteUrl?: string | null; /** * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. */ @@ -188,33 +188,33 @@ export namespace content_v2 { /** * CLDR country code (e.g. "US"). */ - country?: string; + country?: string | null; /** * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ - locality?: string; + locality?: string | null; /** * Postal code or ZIP (e.g. "94043"). */ - postalCode?: string; + postalCode?: string | null; /** * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ - region?: string; + region?: string | null; /** * Street-level part of the address. */ - streetAddress?: string; + streetAddress?: string | null; } export interface Schema$AccountAdwordsLink { /** * Customer ID of the AdWords account. */ - adwordsId?: string; + adwordsId?: string | null; /** * Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ - status?: string; + status?: string | null; } export interface Schema$AccountBusinessInformation { /** @@ -228,41 +228,41 @@ export namespace content_v2 { /** * The phone number of the business. */ - phoneNumber?: string; + phoneNumber?: string | null; } export interface Schema$AccountCustomerService { /** * Customer service email. */ - email?: string; + email?: string | null; /** * Customer service phone number. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * Customer service URL. */ - url?: string; + url?: string | null; } export interface Schema$AccountGoogleMyBusinessLink { /** * The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. */ - gmbEmail?: string; + gmbEmail?: string | null; /** * Status of the link between this Merchant Center account and the GMB account. */ - status?: string; + status?: string | null; } export interface Schema$AccountIdentifier { /** * The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount). */ - aggregatorId?: string; + aggregatorId?: string | null; /** * The merchant account ID, set for individual accounts and subaccounts. */ - merchantId?: string; + merchantId?: string | null; } export interface Schema$AccountsAuthInfoResponse { /** @@ -272,13 +272,13 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AccountsClaimWebsiteResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AccountsCustomBatchRequest { /** @@ -297,15 +297,15 @@ export namespace content_v2 { /** * The ID of the targeted account. Only defined if the method is not insert. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * Whether the account should be deleted if the account has offers. Only applicable if the method is delete. */ - force?: boolean; + force?: boolean | null; /** * Details about the link request. */ @@ -313,29 +313,29 @@ export namespace content_v2 { /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * The method of the batch entry. */ - method?: string; + method?: string | null; /** * Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict. */ - overwrite?: boolean; + overwrite?: boolean | null; } export interface Schema$AccountsCustomBatchRequestEntryLinkRequest { /** * Action to perform for this link. The "request" action is only available to select merchants. */ - action?: string; + action?: string | null; /** * The ID of the linked account. */ - linkedAccountId?: string; + linkedAccountId?: string | null; /** * Type of the link between the two accounts. */ - linkType?: string; + linkType?: string | null; } export interface Schema$AccountsCustomBatchResponse { /** @@ -345,7 +345,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch accounts response. @@ -358,7 +358,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -366,41 +366,41 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * Deprecated. This field is never set. */ - linkStatus?: string; + linkStatus?: string | null; } export interface Schema$AccountsLinkRequest { /** * Action to perform for this link. The "request" action is only available to select merchants. */ - action?: string; + action?: string | null; /** * The ID of the linked account. */ - linkedAccountId?: string; + linkedAccountId?: string | null; /** * Type of the link between the two accounts. */ - linkType?: string; + linkType?: string | null; } export interface Schema$AccountsLinkResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$AccountsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of accounts. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Account[]; } /** @@ -410,7 +410,7 @@ export namespace content_v2 { /** * The ID of the account for which the status is reported. */ - accountId?: string; + accountId?: string | null; /** * A list of account level issues. */ @@ -422,7 +422,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". */ - kind?: string; + kind?: string | null; /** * List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. */ @@ -430,50 +430,50 @@ export namespace content_v2 { /** * Whether the account's website is claimed or not. */ - websiteClaimed?: boolean; + websiteClaimed?: boolean | null; } export interface Schema$AccountStatusAccountLevelIssue { /** * Country for which this issue is reported. */ - country?: string; + country?: string | null; /** * The destination the issue applies to. */ - destination?: string; + destination?: string | null; /** * Additional details about the issue. */ - detail?: string; + detail?: string | null; /** * The URL of a web page to help resolving this issue. */ - documentation?: string; + documentation?: string | null; /** * Issue identifier. */ - id?: string; + id?: string | null; /** * Severity of the issue. */ - severity?: string; + severity?: string | null; /** * Short description of the issue. */ - title?: string; + title?: string | null; } export interface Schema$AccountStatusDataQualityIssue { - country?: string; - destination?: string; - detail?: string; - displayedValue?: string; + country?: string | null; + destination?: string | null; + detail?: string | null; + displayedValue?: string | null; exampleItems?: Schema$AccountStatusExampleItem[]; - id?: string; - lastChecked?: string; - location?: string; - numItems?: number; - severity?: string; - submittedValue?: string; + id?: string | null; + lastChecked?: string | null; + location?: string | null; + numItems?: number | null; + severity?: string | null; + submittedValue?: string | null; } export interface Schema$AccountstatusesCustomBatchRequest { /** @@ -488,23 +488,23 @@ export namespace content_v2 { /** * The ID of the (sub-)account whose status to get. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ - destinations?: string[]; + destinations?: string[] | null; /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * The method (get). */ - method?: string; + method?: string | null; } export interface Schema$AccountstatusesCustomBatchResponse { /** @@ -514,7 +514,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch accountstatuses response. @@ -527,7 +527,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -537,67 +537,67 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of account statuses. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$AccountStatus[]; } export interface Schema$AccountStatusExampleItem { - itemId?: string; - link?: string; - submittedValue?: string; - title?: string; - valueOnLandingPage?: string; + itemId?: string | null; + link?: string | null; + submittedValue?: string | null; + title?: string | null; + valueOnLandingPage?: string | null; } export interface Schema$AccountStatusItemLevelIssue { /** * The attribute's name, if the issue is caused by a single attribute. */ - attributeName?: string; + attributeName?: string | null; /** * The error code of the issue. */ - code?: string; + code?: string | null; /** * A short issue description in English. */ - description?: string; + description?: string | null; /** * A detailed issue description in English. */ - detail?: string; + detail?: string | null; /** * The URL of a web page to help with resolving this issue. */ - documentation?: string; + documentation?: string | null; /** * Number of items with this issue. */ - numItems?: string; + numItems?: string | null; /** * Whether the issue can be resolved by the merchant. */ - resolution?: string; + resolution?: string | null; /** * How this issue affects serving of the offer. */ - servability?: string; + servability?: string | null; } export interface Schema$AccountStatusProducts { /** * The channel the data applies to. */ - channel?: string; + channel?: string | null; /** * The country the data applies to. */ - country?: string; + country?: string | null; /** * The destination the data applies to. */ - destination?: string; + destination?: string | null; /** * List of item-level issues. */ @@ -611,19 +611,19 @@ export namespace content_v2 { /** * Number of active offers. */ - active?: string; + active?: string | null; /** * Number of disapproved offers. */ - disapproved?: string; + disapproved?: string | null; /** * Number of expiring offers. */ - expiring?: string; + expiring?: string | null; /** * Number of pending offers. */ - pending?: string; + pending?: string | null; } /** * The tax settings of a merchant account. All methods require the admin role. @@ -632,11 +632,11 @@ export namespace content_v2 { /** * The ID of the account to which these account tax settings belong. */ - accountId?: string; + accountId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#accountTax". */ - kind?: string; + kind?: string | null; /** * Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all. */ @@ -655,7 +655,7 @@ export namespace content_v2 { /** * The ID of the account for which to get/update account tax settings. */ - accountId?: string; + accountId?: string | null; /** * The account tax settings to update. Only defined if the method is update. */ @@ -663,12 +663,12 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; } export interface Schema$AccounttaxCustomBatchResponse { /** @@ -678,7 +678,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch accounttax response. @@ -691,7 +691,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -699,17 +699,17 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; } export interface Schema$AccounttaxListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of account tax settings. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$AccountTax[]; } /** @@ -719,55 +719,55 @@ export namespace content_v2 { /** * Country code in which tax is applicable. */ - country?: string; + country?: string | null; /** * State (or province) is which the tax is applicable, described by its location ID (also called criteria ID). */ - locationId?: string; + locationId?: string | null; /** * Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative. */ - ratePercent?: string; + ratePercent?: string | null; /** * If true, shipping charges are also taxed. */ - shippingTaxed?: boolean; + shippingTaxed?: boolean | null; /** * Whether the tax rate is taken from a global tax table or specified explicitly. */ - useGlobalRate?: boolean; + useGlobalRate?: boolean | null; } export interface Schema$AccountUser { /** * Whether user is an admin. */ - admin?: boolean; + admin?: boolean | null; /** * User's email address. */ - emailAddress?: string; + emailAddress?: string | null; /** * Whether user is an order manager. */ - orderManager?: boolean; + orderManager?: boolean | null; /** * Whether user can access payment statements. */ - paymentsAnalyst?: boolean; + paymentsAnalyst?: boolean | null; /** * Whether user can manage payment settings. */ - paymentsManager?: boolean; + paymentsManager?: boolean | null; } export interface Schema$AccountYouTubeChannelLink { /** * Channel ID. */ - channelId?: string; + channelId?: string | null; /** * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ - status?: string; + status?: string | null; } export interface Schema$Amount { /** @@ -783,17 +783,17 @@ export namespace content_v2 { /** * Regular business days. May not be empty. */ - businessDays?: string[]; + businessDays?: string[] | null; } export interface Schema$CarrierRate { /** * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. */ - carrierName?: string; + carrierName?: string | null; /** * Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. */ - carrierService?: string; + carrierService?: string | null; /** * Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional. */ @@ -801,51 +801,51 @@ export namespace content_v2 { /** * Name of the carrier rate. Must be unique per rate group. Required. */ - name?: string; + name?: string | null; /** * Shipping origin for this carrier rate. Required. */ - originPostalCode?: string; + originPostalCode?: string | null; /** * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional. */ - percentageAdjustment?: string; + percentageAdjustment?: string | null; } export interface Schema$CarriersCarrier { /** * The CLDR country code of the carrier (e.g., "US"). Always present. */ - country?: string; + country?: string | null; /** * The name of the carrier (e.g., "UPS"). Always present. */ - name?: string; + name?: string | null; /** * A list of supported services (e.g., "ground") for that carrier. Contains at least one service. */ - services?: string[]; + services?: string[] | null; } export interface Schema$CustomAttribute { /** * The name of the attribute. Underscores will be replaced by spaces upon insertion. */ - name?: string; + name?: string | null; /** * The type of the attribute. */ - type?: string; + type?: string | null; /** * Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. */ - unit?: string; + unit?: string | null; /** * The value of the attribute. */ - value?: string; + value?: string | null; } export interface Schema$CustomerReturnReason { - description?: string; - reasonCode?: string; + description?: string | null; + reasonCode?: string | null; } export interface Schema$CustomGroup { /** @@ -855,21 +855,21 @@ export namespace content_v2 { /** * The name of the group. Underscores will be replaced by spaces upon insertion. */ - name?: string; + name?: string | null; } export interface Schema$CutoffTime { /** * Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ - hour?: number; + hour?: number | null; /** * Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ - minute?: number; + minute?: number | null; /** * Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ - timezone?: string; + timezone?: string | null; } /** * Datafeed configuration data. @@ -878,15 +878,15 @@ export namespace content_v2 { /** * The two-letter ISO 639-1 language in which the attributes are defined in the data feed. */ - attributeLanguage?: string; + attributeLanguage?: string | null; /** * [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. */ - contentType?: string; + contentType?: string | null; /** * Fetch schedule for the feed file. */ @@ -894,7 +894,7 @@ export namespace content_v2 { /** * The filename of the feed. All feeds must have a unique file name. */ - fileName?: string; + fileName?: string | null; /** * Format of the feed file. */ @@ -902,23 +902,23 @@ export namespace content_v2 { /** * The ID of the data feed. */ - id?: string; + id?: string | null; /** * [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center). */ - intendedDestinations?: string[]; + intendedDestinations?: string[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeed". */ - kind?: string; + kind?: string | null; /** * A descriptive name of the data feed. */ - name?: string; + name?: string | null; /** * [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. */ - targetCountry?: string; + targetCountry?: string | null; /** * The targets this feed should apply to (country, language, destinations). */ @@ -931,53 +931,53 @@ export namespace content_v2 { /** * The day of the month the feed file should be fetched (1-31). */ - dayOfMonth?: number; + dayOfMonth?: number | null; /** * The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. */ - fetchUrl?: string; + fetchUrl?: string | null; /** * The hour of the day the feed file should be fetched (0-23). */ - hour?: number; + hour?: number | null; /** * The minute of the hour the feed file should be fetched (0-59). Read-only. */ - minuteOfHour?: number; + minuteOfHour?: number | null; /** * An optional password for fetch_url. */ - password?: string; + password?: string | null; /** * Whether the scheduled fetch is paused or not. */ - paused?: boolean; + paused?: boolean | null; /** * Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". */ - timeZone?: string; + timeZone?: string | null; /** * An optional user name for fetch_url. */ - username?: string; + username?: string | null; /** * The day of the week the feed file should be fetched. */ - weekday?: string; + weekday?: string | null; } export interface Schema$DatafeedFormat { /** * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. */ - columnDelimiter?: string; + columnDelimiter?: string | null; /** * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. */ - fileEncoding?: string; + fileEncoding?: string | null; /** * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. */ - quotingMode?: string; + quotingMode?: string | null; } export interface Schema$DatafeedsCustomBatchRequest { /** @@ -992,7 +992,7 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The data feed to insert. */ @@ -1000,12 +1000,12 @@ export namespace content_v2 { /** * The ID of the data feed to get, delete or fetch. */ - datafeedId?: string; + datafeedId?: string | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; } export interface Schema$DatafeedsCustomBatchResponse { /** @@ -1015,7 +1015,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch datafeeds response. @@ -1024,7 +1024,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * The requested data feed. Defined if and only if the request was successful. */ @@ -1038,17 +1038,17 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$DatafeedsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of datafeeds. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Datafeed[]; } /** @@ -1058,11 +1058,11 @@ export namespace content_v2 { /** * The country for which the status is reported, represented as a CLDR territory code. */ - country?: string; + country?: string | null; /** * The ID of the feed for which the status is reported. */ - datafeedId?: string; + datafeedId?: string | null; /** * The list of errors occurring in the feed. */ @@ -1070,27 +1070,27 @@ export namespace content_v2 { /** * The number of items in the feed that were processed. */ - itemsTotal?: string; + itemsTotal?: string | null; /** * The number of items in the feed that were valid. */ - itemsValid?: string; + itemsValid?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". */ - kind?: string; + kind?: string | null; /** * The two-letter ISO 639-1 language for which the status is reported. */ - language?: string; + language?: string | null; /** * The last date at which the feed was uploaded. */ - lastUploadDate?: string; + lastUploadDate?: string | null; /** * The processing status of the feed. */ - processingStatus?: string; + processingStatus?: string | null; /** * The list of errors occurring in the feed. */ @@ -1103,11 +1103,11 @@ export namespace content_v2 { /** * The code of the error, e.g., "validation/invalid_value". */ - code?: string; + code?: string | null; /** * The number of occurrences of the error in the feed. */ - count?: string; + count?: string | null; /** * A list of example occurrences of the error, grouped by product. */ @@ -1115,7 +1115,7 @@ export namespace content_v2 { /** * The error message, e.g., "Invalid price". */ - message?: string; + message?: string | null; } export interface Schema$DatafeedstatusesCustomBatchRequest { /** @@ -1130,24 +1130,24 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required. */ - country?: string; + country?: string | null; /** * The ID of the data feed to get. */ - datafeedId?: string; + datafeedId?: string | null; /** * The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required. */ - language?: string; + language?: string | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; } export interface Schema$DatafeedstatusesCustomBatchResponse { /** @@ -1157,7 +1157,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch datafeedstatuses response. @@ -1166,7 +1166,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * The requested data feed status. Defined if and only if the request was successful. */ @@ -1180,11 +1180,11 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of datafeed statuses. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$DatafeedStatus[]; } /** @@ -1194,33 +1194,33 @@ export namespace content_v2 { /** * The ID of the example item. */ - itemId?: string; + itemId?: string | null; /** * Line number in the data feed where the example is found. */ - lineNumber?: string; + lineNumber?: string | null; /** * The problematic value. */ - value?: string; + value?: string | null; } export interface Schema$DatafeedTarget { /** * The country where the items in the feed will be included in the search index, represented as a CLDR territory code. */ - country?: string; + country?: string | null; /** * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). */ - excludedDestinations?: string[]; + excludedDestinations?: string[] | null; /** * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. */ - includedDestinations?: string[]; + includedDestinations?: string[] | null; /** * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. */ - language?: string; + language?: string | null; } export interface Schema$DeliveryTime { /** @@ -1238,19 +1238,19 @@ export namespace content_v2 { /** * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays. */ - maxHandlingTimeInDays?: number; + maxHandlingTimeInDays?: number | null; /** * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. */ - maxTransitTimeInDays?: number; + maxTransitTimeInDays?: number | null; /** * Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. */ - minHandlingTimeInDays?: number; + minHandlingTimeInDays?: number | null; /** * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both. */ - minTransitTimeInDays?: number; + minTransitTimeInDays?: number | null; /** * The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed. */ @@ -1267,15 +1267,15 @@ export namespace content_v2 { /** * The domain of the error. */ - domain?: string; + domain?: string | null; /** * A description of the error. */ - message?: string; + message?: string | null; /** * The error code. */ - reason?: string; + reason?: string | null; } /** * A list of errors returned by a failed batch entry. @@ -1284,7 +1284,7 @@ export namespace content_v2 { /** * The HTTP status of the first error in errors. */ - code?: number; + code?: number | null; /** * A list of errors. */ @@ -1292,13 +1292,13 @@ export namespace content_v2 { /** * The message of the first error in errors. */ - message?: string; + message?: string | null; } export interface Schema$GmbAccounts { /** * The ID of the account. */ - accountId?: string; + accountId?: string | null; /** * A list of GMB accounts which are available to the merchant. */ @@ -1308,19 +1308,19 @@ export namespace content_v2 { /** * The email which identifies the GMB account. */ - email?: string; + email?: string | null; /** * Number of listings under this account. */ - listingCount?: string; + listingCount?: string | null; /** * The name of the GMB account. */ - name?: string; + name?: string | null; /** * The type of the GMB account (User or Business). */ - type?: string; + type?: string | null; } /** * A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. @@ -1333,11 +1333,11 @@ export namespace content_v2 { /** * A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. */ - numberOfItems?: string[]; + numberOfItems?: string[] | null; /** * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. */ - postalCodeGroupNames?: string[]; + postalCodeGroupNames?: string[] | null; /** * A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. */ @@ -1351,49 +1351,49 @@ export namespace content_v2 { /** * Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required. */ - deadlineDate?: string; + deadlineDate?: string | null; /** * Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required. */ - deadlineHour?: number; + deadlineHour?: number | null; /** * Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ - deadlineTimezone?: string; + deadlineTimezone?: string | null; /** * Unique identifier for the holiday. Required. */ - holidayId?: string; + holidayId?: string | null; /** * Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required. */ - visibleFromDate?: string; + visibleFromDate?: string | null; } export interface Schema$HolidaysHoliday { /** * The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present. */ - countryCode?: string; + countryCode?: string | null; /** * Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present. */ - date?: string; + date?: string | null; /** * Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present. */ - deliveryGuaranteeDate?: string; + deliveryGuaranteeDate?: string | null; /** * Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present. */ - deliveryGuaranteeHour?: string; + deliveryGuaranteeHour?: string | null; /** * Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present. */ - id?: string; + id?: string | null; /** * The holiday type. Always present. */ - type?: string; + type?: string | null; } export interface Schema$Installment { /** @@ -1403,33 +1403,33 @@ export namespace content_v2 { /** * The number of installments the buyer has to pay. */ - months?: string; + months?: string | null; } export interface Schema$Inventory { /** * The availability of the product. */ - availability?: string; + availability?: string | null; /** * Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel0?: string; + customLabel0?: string | null; /** * Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel1?: string; + customLabel1?: string | null; /** * Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel2?: string; + customLabel2?: string | null; /** * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel3?: string; + customLabel3?: string | null; /** * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel4?: string; + customLabel4?: string | null; /** * Number and amount of installments to pay for an item. Brazil only. */ @@ -1437,11 +1437,11 @@ export namespace content_v2 { /** * The instore product location. Supported only for local products. */ - instoreProductLocation?: string; + instoreProductLocation?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#inventory". */ - kind?: string; + kind?: string | null; /** * Loyalty points that users receive after purchasing the item. Japan only. */ @@ -1457,7 +1457,7 @@ export namespace content_v2 { /** * The quantity of the product. Must be equal to or greater than zero. Supported only for local products. */ - quantity?: number; + quantity?: number | null; /** * The sale price of the product. Mandatory if sale_price_effective_date is defined. */ @@ -1465,11 +1465,11 @@ export namespace content_v2 { /** * A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. */ - salePriceEffectiveDate?: string; + salePriceEffectiveDate?: string | null; /** * The quantity of the product that is available for selling on Google. Supported only for online products. */ - sellOnGoogleQuantity?: number; + sellOnGoogleQuantity?: number | null; } export interface Schema$InventoryCustomBatchRequest { /** @@ -1484,7 +1484,7 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * Price and availability of the product. */ @@ -1492,15 +1492,15 @@ export namespace content_v2 { /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * The ID of the product for which to update price and availability. */ - productId?: string; + productId?: string | null; /** * The code of the store for which to update price and availability. Use online to update price and availability of an online product. */ - storeCode?: string; + storeCode?: string | null; } export interface Schema$InventoryCustomBatchResponse { /** @@ -1510,7 +1510,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch inventory response. @@ -1519,7 +1519,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -1527,43 +1527,43 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; } export interface Schema$InventoryPickup { /** * Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with pickupSla. */ - pickupMethod?: string; + pickupMethod?: string | null; /** * The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with pickupMethod. */ - pickupSla?: string; + pickupSla?: string | null; } export interface Schema$InventorySetRequest { /** * The availability of the product. */ - availability?: string; + availability?: string | null; /** * Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel0?: string; + customLabel0?: string | null; /** * Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel1?: string; + customLabel1?: string | null; /** * Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel2?: string; + customLabel2?: string | null; /** * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel3?: string; + customLabel3?: string | null; /** * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ - customLabel4?: string; + customLabel4?: string | null; /** * Number and amount of installments to pay for an item. Brazil only. */ @@ -1571,7 +1571,7 @@ export namespace content_v2 { /** * The instore product location. Supported only for local products. */ - instoreProductLocation?: string; + instoreProductLocation?: string | null; /** * Loyalty points that users receive after purchasing the item. Japan only. */ @@ -1587,7 +1587,7 @@ export namespace content_v2 { /** * The quantity of the product. Must be equal to or greater than zero. Supported only for local products. */ - quantity?: number; + quantity?: number | null; /** * The sale price of the product. Mandatory if sale_price_effective_date is defined. */ @@ -1595,17 +1595,17 @@ export namespace content_v2 { /** * A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. */ - salePriceEffectiveDate?: string; + salePriceEffectiveDate?: string | null; /** * The quantity of the product that is available for selling on Google. Supported only for online products. */ - sellOnGoogleQuantity?: number; + sellOnGoogleQuantity?: number | null; } export interface Schema$InventorySetResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$InvoiceSummary { /** @@ -1641,17 +1641,17 @@ export namespace content_v2 { /** * [required] Type of the additional charge. */ - type?: string; + type?: string | null; } export interface Schema$LiaAboutPageSettings { /** * The status of the verification process for the About page. */ - status?: string; + status?: string | null; /** * The URL for the About page. */ - url?: string; + url?: string | null; } export interface Schema$LiaCountrySettings { /** @@ -1661,11 +1661,11 @@ export namespace content_v2 { /** * CLDR country code (e.g. "US"). */ - country?: string; + country?: string | null; /** * The status of the "Merchant hosted local storefront" feature. */ - hostedLocalStorefrontActive?: boolean; + hostedLocalStorefrontActive?: boolean | null; /** * LIA inventory verification settings. */ @@ -1681,45 +1681,45 @@ export namespace content_v2 { /** * The status of the "Store pickup" feature. */ - storePickupActive?: boolean; + storePickupActive?: boolean | null; } export interface Schema$LiaInventorySettings { /** * The email of the contact for the inventory verification process. */ - inventoryVerificationContactEmail?: string; + inventoryVerificationContactEmail?: string | null; /** * The name of the contact for the inventory verification process. */ - inventoryVerificationContactName?: string; + inventoryVerificationContactName?: string | null; /** * The status of the verification contact. */ - inventoryVerificationContactStatus?: string; + inventoryVerificationContactStatus?: string | null; /** * The status of the inventory verification process. */ - status?: string; + status?: string | null; } export interface Schema$LiaOnDisplayToOrderSettings { /** * Shipping cost and policy URL. */ - shippingCostPolicyUrl?: string; + shippingCostPolicyUrl?: string | null; /** * The status of the ?On display to order? feature. */ - status?: string; + status?: string | null; } export interface Schema$LiaPosDataProvider { /** * The ID of the POS data provider. */ - posDataProviderId?: string; + posDataProviderId?: string | null; /** * The account ID by which this merchant is known to the POS data provider. */ - posExternalAccountId?: string; + posExternalAccountId?: string | null; } /** * Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. @@ -1728,7 +1728,7 @@ export namespace content_v2 { /** * The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. */ - accountId?: string; + accountId?: string | null; /** * The LIA settings for each country. */ @@ -1736,7 +1736,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsCustomBatchRequest { /** @@ -1748,27 +1748,27 @@ export namespace content_v2 { /** * The ID of the account for which to get/update account shipping settings. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * Inventory validation contact email. Required only for SetInventoryValidationContact. */ - contactEmail?: string; + contactEmail?: string | null; /** * Inventory validation contact name. Required only for SetInventoryValidationContact. */ - contactName?: string; + contactName?: string | null; /** * The country code. Required only for RequestInventoryVerification. */ - country?: string; + country?: string | null; /** * The GMB account. Required only for RequestGmbAccess. */ - gmbEmail?: string; + gmbEmail?: string | null; /** * The account Lia settings to update. Only defined if the method is update. */ @@ -1776,16 +1776,16 @@ export namespace content_v2 { /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The ID of POS data provider. Required only for SetPosProvider. */ - posDataProviderId?: string; + posDataProviderId?: string | null; /** * The account ID by which this merchant is known to the POS provider. */ - posExternalAccountId?: string; + posExternalAccountId?: string | null; } export interface Schema$LiasettingsCustomBatchResponse { /** @@ -1795,13 +1795,13 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsCustomBatchResponseEntry { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -1813,7 +1813,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The retrieved or updated Lia settings. */ @@ -1827,7 +1827,7 @@ export namespace content_v2 { /** * The ID of the account. */ - accountId?: string; + accountId?: string | null; /** * A list of GMB accounts which are available to the merchant. */ @@ -1835,13 +1835,13 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsListPosDataProvidersResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse". */ - kind?: string; + kind?: string | null; /** * The list of POS data providers for each eligible country */ @@ -1851,72 +1851,72 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of LIA settings. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$LiaSettings[]; } export interface Schema$LiasettingsRequestGmbAccessResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsRequestInventoryVerificationResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsSetInventoryVerificationContactResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LiasettingsSetPosDataProviderResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$LocationIdSet { /** * A non-empty list of location IDs. They must all be of the same location type (e.g., state). */ - locationIds?: string[]; + locationIds?: string[] | null; } export interface Schema$LoyaltyPoints { /** * Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. */ - name?: string; + name?: string | null; /** * The retailer's loyalty points in absolute value. */ - pointsValue?: string; + pointsValue?: string | null; /** * The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. */ - ratio?: number; + ratio?: number | null; } export interface Schema$MerchantOrderReturn { - creationDate?: string; - merchantOrderId?: string; - orderId?: string; - orderReturnId?: string; + creationDate?: string | null; + merchantOrderId?: string | null; + orderId?: string | null; + orderReturnId?: string | null; returnItems?: Schema$MerchantOrderReturnItem[]; returnShipments?: Schema$ReturnShipment[]; } export interface Schema$MerchantOrderReturnItem { customerReturnReason?: Schema$CustomerReturnReason; - itemId?: string; + itemId?: string | null; merchantReturnReason?: Schema$RefundReason; product?: Schema$OrderLineItemProduct; - returnShipmentIds?: string[]; - state?: string; + returnShipmentIds?: string[] | null; + state?: string | null; } /** * Order. All methods require the order manager role. @@ -1925,11 +1925,11 @@ export namespace content_v2 { /** * Whether the order was acknowledged. */ - acknowledged?: boolean; + acknowledged?: boolean | null; /** * Deprecated. */ - channelType?: string; + channelType?: string | null; /** * The details of the customer who placed the order. */ @@ -1941,20 +1941,20 @@ export namespace content_v2 { /** * The REST ID of the order. Globally unique. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#order". */ - kind?: string; + kind?: string | null; /** * Line items that are ordered. */ lineItems?: Schema$OrderLineItem[]; - merchantId?: string; + merchantId?: string | null; /** * Merchant-provided ID of the order. */ - merchantOrderId?: string; + merchantOrderId?: string | null; /** * The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80. */ @@ -1966,11 +1966,15 @@ export namespace content_v2 { /** * The status of the payment. */ - paymentStatus?: string; + paymentStatus?: string | null; + /** + * Pickup details for shipments of type pickup. + */ + pickupDetails?: Schema$OrderPickupDetails; /** * The date when the order was placed, in ISO 8601 format. */ - placedDate?: string; + placedDate?: string | null; /** * The details of the merchant provided promotions applied to the order. More details about the program are here. */ @@ -1994,89 +1998,89 @@ export namespace content_v2 { /** * Deprecated. Shipping details are provided with line items instead. */ - shippingOption?: string; + shippingOption?: string | null; /** * The status of the order. */ - status?: string; + status?: string | null; /** * The party responsible for collecting and remitting taxes. */ - taxCollector?: string; + taxCollector?: string | null; } export interface Schema$OrderAddress { /** * CLDR country code (e.g. "US"). */ - country?: string; + country?: string | null; /** * Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States */ - fullAddress?: string[]; + fullAddress?: string[] | null; /** * Whether the address is a post office box. */ - isPostOfficeBox?: boolean; + isPostOfficeBox?: boolean | null; /** * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ - locality?: string; + locality?: string | null; /** * Postal Code or ZIP (e.g. "94043"). */ - postalCode?: string; + postalCode?: string | null; /** * Name of the recipient. */ - recipientName?: string; + recipientName?: string | null; /** * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ - region?: string; + region?: string | null; /** * Street-level part of the address. */ - streetAddress?: string[]; + streetAddress?: string[] | null; } export interface Schema$OrderCancellation { /** * The actor that created the cancellation. */ - actor?: string; + actor?: string | null; /** * Date on which the cancellation has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * The quantity that was canceled. */ - quantity?: number; + quantity?: number | null; /** * The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrderCustomer { /** * Deprecated. */ - email?: string; + email?: string | null; /** * Deprecated. Please use marketingRightsInfo instead. */ - explicitMarketingPreference?: boolean; + explicitMarketingPreference?: boolean | null; /** * Full name of the customer. */ - fullName?: string; + fullName?: string | null; /** * Email address for receiving merchant issued value-added tax or invoice documentation of this order. */ - invoiceReceivingEmail?: string; + invoiceReceivingEmail?: string | null; /** * Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order. */ @@ -2086,15 +2090,15 @@ export namespace content_v2 { /** * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in. */ - explicitMarketingPreference?: string; + explicitMarketingPreference?: string | null; /** * Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. */ - lastUpdatedTimestamp?: string; + lastUpdatedTimestamp?: string | null; /** * Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account. */ - marketingEmailAddress?: string; + marketingEmailAddress?: string | null; } export interface Schema$OrderDeliveryDetails { /** @@ -2104,13 +2108,13 @@ export namespace content_v2 { /** * The phone number of the person receiving the delivery. */ - phoneNumber?: string; + phoneNumber?: string | null; } export interface Schema$OrderinvoicesCreateChargeInvoiceRequest { /** * [required] The ID of the invoice. */ - invoiceId?: string; + invoiceId?: string | null; /** * [required] Invoice summary. */ @@ -2122,31 +2126,31 @@ export namespace content_v2 { /** * [required] The ID of the operation, unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; } export interface Schema$OrderinvoicesCreateChargeInvoiceResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrderinvoicesCreateRefundInvoiceRequest { /** * [required] The ID of the invoice. */ - invoiceId?: string; + invoiceId?: string | null; /** * [required] The ID of the operation, unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided. */ @@ -2164,58 +2168,58 @@ export namespace content_v2 { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption { /** * Optional description of the refund reason. */ - description?: string; + description?: string | null; /** * [required] Reason for the refund. */ - reason?: string; + reason?: string | null; } export interface Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption { /** * Optional description of the return reason. */ - description?: string; + description?: string | null; /** * [required] Reason for the return. */ - reason?: string; + reason?: string | null; } export interface Schema$OrderLegacyPromotion { benefits?: Schema$OrderLegacyPromotionBenefit[]; /** * The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. */ - effectiveDates?: string; + effectiveDates?: string | null; /** * Optional. The text code that corresponds to the promotion when applied on the retailer?s website. */ - genericRedemptionCode?: string; + genericRedemptionCode?: string | null; /** * The unique ID of the promotion. */ - id?: string; + id?: string | null; /** * The full title of the promotion. */ - longTitle?: string; + longTitle?: string | null; /** * Whether the promotion is applicable to all products or only specific products. */ - productApplicability?: string; + productApplicability?: string | null; /** * Indicates that the promotion is valid online. */ - redemptionChannel?: string; + redemptionChannel?: string | null; } export interface Schema$OrderLegacyPromotionBenefit { /** @@ -2225,11 +2229,11 @@ export namespace content_v2 { /** * The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. */ - offerIds?: string[]; + offerIds?: string[] | null; /** * Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. */ - subType?: string; + subType?: string | null; /** * The impact on tax when the promotion is applied. */ @@ -2237,7 +2241,7 @@ export namespace content_v2 { /** * Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). */ - type?: string; + type?: string | null; } export interface Schema$OrderLineItem { /** @@ -2251,7 +2255,7 @@ export namespace content_v2 { /** * The ID of the line item. */ - id?: string; + id?: string | null; /** * Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20. */ @@ -2263,27 +2267,31 @@ export namespace content_v2 { /** * Number of items canceled. */ - quantityCanceled?: number; + quantityCanceled?: number | null; /** * Number of items delivered. */ - quantityDelivered?: number; + quantityDelivered?: number | null; /** * Number of items ordered. */ - quantityOrdered?: number; + quantityOrdered?: number | null; /** * Number of items pending. */ - quantityPending?: number; + quantityPending?: number | null; + /** + * Number of items ready for pickup. + */ + quantityReadyForPickup?: number | null; /** * Number of items returned. */ - quantityReturned?: number; + quantityReturned?: number | null; /** * Number of items shipped. */ - quantityShipped?: number; + quantityShipped?: number | null; /** * Details of the return policy for the line item. */ @@ -2305,19 +2313,19 @@ export namespace content_v2 { /** * Brand of the item. */ - brand?: string; + brand?: string | null; /** * The item's channel (online or local). */ - channel?: string; + channel?: string | null; /** * Condition or state of the item. */ - condition?: string; + condition?: string | null; /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Associated fees at order creation time. */ @@ -2325,27 +2333,27 @@ export namespace content_v2 { /** * Global Trade Item Number (GTIN) of the item. */ - gtin?: string; + gtin?: string | null; /** * The REST ID of the product. */ - id?: string; + id?: string | null; /** * URL of an image of the item. */ - imageLink?: string; + imageLink?: string | null; /** * Shared identifier for all variants of the same product. */ - itemGroupId?: string; + itemGroupId?: string | null; /** * Manufacturer Part Number (MPN) of the item. */ - mpn?: string; + mpn?: string | null; /** * An identifier of the item. */ - offerId?: string; + offerId?: string | null; /** * Price of the item. */ @@ -2353,15 +2361,15 @@ export namespace content_v2 { /** * URL to the cached image shown to the user when order was placed. */ - shownImage?: string; + shownImage?: string | null; /** * The CLDR territory code of the target country of the product. */ - targetCountry?: string; + targetCountry?: string | null; /** * The title of the product. */ - title?: string; + title?: string | null; /** * Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here. */ @@ -2375,37 +2383,37 @@ export namespace content_v2 { /** * Name of the fee. */ - name?: string; + name?: string | null; } export interface Schema$OrderLineItemProductVariantAttribute { /** * The dimension of the variant. */ - dimension?: string; + dimension?: string | null; /** * The value for the dimension. */ - value?: string; + value?: string | null; } export interface Schema$OrderLineItemReturnInfo { /** * How many days later the item can be returned. */ - daysToReturn?: number; + daysToReturn?: number | null; /** * Whether the item is returnable. */ - isReturnable?: boolean; + isReturnable?: boolean | null; /** * URL of the item return policy. */ - policyUrl?: string; + policyUrl?: string | null; } export interface Schema$OrderLineItemShippingDetails { /** * The delivery by date, in ISO 8601 format. */ - deliverByDate?: string; + deliverByDate?: string | null; /** * Details of the shipping method. */ @@ -2413,35 +2421,39 @@ export namespace content_v2 { /** * The ship by date, in ISO 8601 format. */ - shipByDate?: string; + shipByDate?: string | null; + /** + * Type of shipment. Indicates whether deliveryDetails or pickupDetails is applicable for this shipment. + */ + type?: string | null; } export interface Schema$OrderLineItemShippingDetailsMethod { /** * The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * Maximum transit time. */ - maxDaysInTransit?: number; + maxDaysInTransit?: number | null; /** * The name of the shipping method. */ - methodName?: string; + methodName?: string | null; /** * Minimum transit time. */ - minDaysInTransit?: number; + minDaysInTransit?: number | null; } export interface Schema$OrderMerchantProvidedAnnotation { /** * Key for additional merchant provided (as key-value pairs) annotation about the line item. */ - key?: string; + key?: string | null; /** * Value for additional merchant provided (as key-value pairs) annotation about the line item. */ - value?: string; + value?: string | null; } export interface Schema$OrderPaymentMethod { /** @@ -2451,23 +2463,23 @@ export namespace content_v2 { /** * The card expiration month (January = 1, February = 2 etc.). */ - expirationMonth?: number; + expirationMonth?: number | null; /** * The card expiration year (4-digit, e.g. 2015). */ - expirationYear?: number; + expirationYear?: number | null; /** * The last four digits of the card number. */ - lastFourDigits?: string; + lastFourDigits?: string | null; /** * The billing phone number. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * The type of instrument. Acceptable values are: - "AMEX" - "DISCOVER" - "JCB" - "MASTERCARD" - "UNIONPAY" - "VISA" - "" */ - type?: string; + type?: string | null; } export interface Schema$OrderpaymentsNotifyAuthApprovedRequest { /** @@ -2483,81 +2495,105 @@ export namespace content_v2 { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthApprovedResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrderpaymentsNotifyAuthDeclinedRequest { /** * Reason why payment authorization was declined. */ - declineReason?: string; + declineReason?: string | null; } export interface Schema$OrderpaymentsNotifyAuthDeclinedResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthDeclinedResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrderpaymentsNotifyChargeRequest { /** * Whether charge was successful. */ - chargeState?: string; + chargeState?: string | null; /** * Deprecated. Please use invoiceIds instead. */ - invoiceId?: string; + invoiceId?: string | null; /** * Invoice IDs from the orderinvoices service that correspond to the charge. */ - invoiceIds?: string[]; + invoiceIds?: string[] | null; } export interface Schema$OrderpaymentsNotifyChargeResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyChargeResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrderpaymentsNotifyRefundRequest { /** * Deprecated. Please use invoiceIds instead. */ - invoiceId?: string; + invoiceId?: string | null; /** * Invoice IDs from the orderinvoices service that correspond to the refund. */ - invoiceIds?: string[]; + invoiceIds?: string[] | null; /** * Whether refund was successful. */ - refundState?: string; + refundState?: string | null; } export interface Schema$OrderpaymentsNotifyRefundResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyRefundResponse". */ - kind?: string; + kind?: string | null; + } + export interface Schema$OrderPickupDetails { + /** + * Address of the pickup location where the shipment should be sent. Note that recipientName in the address is the name of the business at the pickup location. + */ + address?: Schema$OrderAddress; + /** + * Collectors authorized to pick up shipment from the pickup location. + */ + collectors?: Schema$OrderPickupDetailsCollector[]; + /** + * ID of the pickup location. + */ + locationId?: string | null; + } + export interface Schema$OrderPickupDetailsCollector { + /** + * Name of the person picking up the shipment. + */ + name?: string | null; + /** + * Phone number of the person picking up the shipment. + */ + phoneNumber?: string | null; } export interface Schema$OrderRefund { /** * The actor that created the refund. */ - actor?: string; + actor?: string | null; /** * The amount that is refunded. */ @@ -2565,15 +2601,15 @@ export namespace content_v2 { /** * Date on which the item has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * The reason for the refund. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } /** * Order disbursement. All methods require the payment analyst role. @@ -2586,19 +2622,19 @@ export namespace content_v2 { /** * The disbursement date, in ISO 8601 format. */ - disbursementCreationDate?: string; + disbursementCreationDate?: string | null; /** * The date the disbursement was initiated, in ISO 8601 format. */ - disbursementDate?: string; + disbursementDate?: string | null; /** * The ID of the disbursement. */ - disbursementId?: string; + disbursementId?: string | null; /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; } export interface Schema$OrderreportsListDisbursementsResponse { /** @@ -2608,21 +2644,21 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of disbursements. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$OrderreportsListTransactionsResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of transactions. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of transactions. */ @@ -2636,27 +2672,27 @@ export namespace content_v2 { /** * The date the disbursement was created, in ISO 8601 format. */ - disbursementCreationDate?: string; + disbursementCreationDate?: string | null; /** * The date the disbursement was initiated, in ISO 8601 format. */ - disbursementDate?: string; + disbursementDate?: string | null; /** * The ID of the disbursement. */ - disbursementId?: string; + disbursementId?: string | null; /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * Merchant-provided ID of the order. */ - merchantOrderId?: string; + merchantOrderId?: string | null; /** * The ID of the order. */ - orderId?: string; + orderId?: string | null; /** * Total amount for the items. */ @@ -2668,62 +2704,62 @@ export namespace content_v2 { /** * The date of the transaction, in ISO 8601 format. */ - transactionDate?: string; + transactionDate?: string | null; } export interface Schema$OrderReturn { /** * The actor that created the refund. */ - actor?: string; + actor?: string | null; /** * Date on which the item has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * Quantity that is returned. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrderreturnsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of returns. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$MerchantOrderReturn[]; } export interface Schema$OrdersAcknowledgeRequest { /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; } export interface Schema$OrdersAcknowledgeResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersAdvanceTestOrderResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCancelLineItemRequest { /** @@ -2741,83 +2777,83 @@ export namespace content_v2 { /** * The ID of the line item to cancel. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to cancel. */ - quantity?: number; + quantity?: number | null; /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCancelLineItemResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCancelRequest { /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCancelResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCancelTestOrderByCustomerRequest { /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; } export interface Schema$OrdersCancelTestOrderByCustomerResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCreateTestOrderRequest { /** * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order. Acceptable values are: - "US" - "FR" Defaults to US. */ - country?: string; + country?: string | null; /** * The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. */ - templateName?: string; + templateName?: string | null; /** * The test order to create. */ @@ -2827,11 +2863,11 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse". */ - kind?: string; + kind?: string | null; /** * The ID of the newly created test order. */ - orderId?: string; + orderId?: string | null; } export interface Schema$OrdersCreateTestReturnRequest { /** @@ -2843,11 +2879,11 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse". */ - kind?: string; + kind?: string | null; /** * The ID of the newly created test order return. */ - returnId?: string; + returnId?: string | null; } export interface Schema$OrdersCustomBatchRequest { /** @@ -2859,7 +2895,7 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * Required for cancel method. */ @@ -2875,23 +2911,23 @@ export namespace content_v2 { /** * The ID of the managing account. */ - merchantId?: string; + merchantId?: string | null; /** * The merchant order ID. Required for updateMerchantOrderId and getByMerchantOrderId methods. */ - merchantOrderId?: string; + merchantOrderId?: string | null; /** * The method to apply. */ - method?: string; + method?: string | null; /** * The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId. */ - operationId?: string; + operationId?: string | null; /** * The ID of the order. Required for all methods beside getByMerchantOrderId. */ - orderId?: string; + orderId?: string | null; /** * Required for refund method. */ @@ -2929,11 +2965,11 @@ export namespace content_v2 { /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryCancelLineItem { /** @@ -2951,33 +2987,33 @@ export namespace content_v2 { /** * The ID of the line item to cancel. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to cancel. */ - quantity?: number; + quantity?: number | null; /** * The reason for the cancellation. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryCreateTestReturnReturnItem { /** * The ID of the line item to return. */ - lineItemId?: string; + lineItemId?: string | null; /** * Quantity that is returned. */ - quantity?: number; + quantity?: number | null; } export interface Schema$OrdersCustomBatchRequestEntryInStoreRefundLineItem { /** @@ -2991,23 +3027,23 @@ export namespace content_v2 { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryRefund { /** @@ -3025,55 +3061,55 @@ export namespace content_v2 { /** * The reason for the refund. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryRejectReturnLineItem { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryReturnLineItem { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryReturnRefundLineItem { /** @@ -3087,40 +3123,40 @@ export namespace content_v2 { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersCustomBatchRequestEntrySetLineItemMetadata { annotations?: Schema$OrderMerchantProvidedAnnotation[]; /** * The ID of the line item to set metadata. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryShipLineItems { /** * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * Line items to ship. */ @@ -3128,11 +3164,11 @@ export namespace content_v2 { /** * ID of the shipment group. Required for orders that use the orderinvoices service. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; /** * Deprecated. Please use shipmentInfo instead. The ID of the shipment. */ - shipmentId?: string; + shipmentId?: string | null; /** * Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs). */ @@ -3140,61 +3176,61 @@ export namespace content_v2 { /** * Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { /** * The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * The ID of the shipment. This is assigned by the merchant and is unique to each shipment. */ - shipmentId?: string; + shipmentId?: string | null; /** * The tracking ID for the shipment. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails { /** * Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ - deliverByDate?: string; + deliverByDate?: string | null; /** * The ID of the line item to set metadata. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ - shipByDate?: string; + shipByDate?: string | null; } export interface Schema$OrdersCustomBatchRequestEntryUpdateShipment { /** * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. */ - deliveryDate?: string; + deliveryDate?: string | null; /** * The ID of the shipment. */ - shipmentId?: string; + shipmentId?: string | null; /** * New status for the shipment. Not updated if missing. */ - status?: string; + status?: string | null; /** * The tracking ID for the shipment. Not updated if missing. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrdersCustomBatchResponse { /** @@ -3204,13 +3240,13 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersCustomBatchResponseEntry { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -3218,11 +3254,11 @@ export namespace content_v2 { /** * The status of the execution. Only defined if - the request was successful; and - the method is not get, getByMerchantOrderId, or one of the test methods. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The retrieved order. Only defined if the method is get and if the request was successful. */ @@ -3232,7 +3268,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse". */ - kind?: string; + kind?: string | null; /** * The requested order. */ @@ -3242,7 +3278,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse". */ - kind?: string; + kind?: string | null; /** * The requested test order template. */ @@ -3252,19 +3288,19 @@ export namespace content_v2 { /** * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" */ - carrier?: string; + carrier?: string | null; /** * Date on which the shipment has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered */ - deliveryDate?: string; + deliveryDate?: string | null; /** * The ID of the shipment. */ - id?: string; + id?: string | null; /** * The line items that are shipped. */ @@ -3272,25 +3308,25 @@ export namespace content_v2 { /** * The status of the shipment. */ - status?: string; + status?: string | null; /** * The tracking ID for the shipment. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrderShipmentLineItemShipment { /** * The ID of the line item that is shipped. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity that is shipped. */ - quantity?: number; + quantity?: number | null; } export interface Schema$OrdersInStoreRefundLineItemRequest { /** @@ -3304,47 +3340,47 @@ export namespace content_v2 { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersInStoreRefundLineItemResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of orders. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Order[]; } export interface Schema$OrdersRefundRequest { @@ -3363,97 +3399,97 @@ export namespace content_v2 { /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The reason for the refund. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersRefundResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersRejectReturnLineItemRequest { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersRejectReturnLineItemResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersReturnLineItemRequest { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersReturnLineItemResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersReturnRefundLineItemRequest { /** @@ -3467,68 +3503,68 @@ export namespace content_v2 { /** * The ID of the line item to return. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * The quantity to return and refund. */ - quantity?: number; + quantity?: number | null; /** * The reason for the return. */ - reason?: string; + reason?: string | null; /** * The explanation of the reason. */ - reasonText?: string; + reasonText?: string | null; } export interface Schema$OrdersReturnRefundLineItemResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersSetLineItemMetadataRequest { annotations?: Schema$OrderMerchantProvidedAnnotation[]; /** * The ID of the line item to set metadata. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; } export interface Schema$OrdersSetLineItemMetadataResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersShipLineItemsRequest { /** * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * Line items to ship. */ @@ -3536,15 +3572,15 @@ export namespace content_v2 { /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * ID of the shipment group. Required for orders that use the orderinvoices service. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; /** * Deprecated. Please use shipmentInfo instead. The ID of the shipment. */ - shipmentId?: string; + shipmentId?: string | null; /** * Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs). */ @@ -3552,105 +3588,105 @@ export namespace content_v2 { /** * Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrdersShipLineItemsResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersUpdateLineItemShippingDetailsRequest { /** * Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ - deliverByDate?: string; + deliverByDate?: string | null; /** * The ID of the line item to set metadata. Either lineItemId or productId is required. */ - lineItemId?: string; + lineItemId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ - productId?: string; + productId?: string | null; /** * Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ - shipByDate?: string; + shipByDate?: string | null; } export interface Schema$OrdersUpdateLineItemShippingDetailsResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersUpdateMerchantOrderIdRequest { /** * The merchant order id to be assigned to the order. Must be unique per merchant. */ - merchantOrderId?: string; + merchantOrderId?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; } export interface Schema$OrdersUpdateMerchantOrderIdResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$OrdersUpdateShipmentRequest { /** * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ - carrier?: string; + carrier?: string | null; /** * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. */ - deliveryDate?: string; + deliveryDate?: string | null; /** * The ID of the operation. Unique across all operations for a given order. */ - operationId?: string; + operationId?: string | null; /** * The ID of the shipment. */ - shipmentId?: string; + shipmentId?: string | null; /** * New status for the shipment. Not updated if missing. */ - status?: string; + status?: string | null; /** * The tracking ID for the shipment. Not updated if missing. */ - trackingId?: string; + trackingId?: string | null; } export interface Schema$OrdersUpdateShipmentResponse { /** * The status of the execution. */ - executionStatus?: string; + executionStatus?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$PosCustomBatchRequest { /** @@ -3662,7 +3698,7 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The inventory to submit. Set this only if the method is inventory. */ @@ -3670,8 +3706,8 @@ export namespace content_v2 { /** * The ID of the POS data provider. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The sale information to submit. Set this only if the method is sale. */ @@ -3683,11 +3719,11 @@ export namespace content_v2 { /** * The store code. Set this only if the method is delete or get. */ - storeCode?: string; + storeCode?: string | null; /** * The ID of the account for which to get/submit data. */ - targetMerchantId?: string; + targetMerchantId?: string | null; } export interface Schema$PosCustomBatchResponse { /** @@ -3697,13 +3733,13 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$PosCustomBatchResponseEntry { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -3715,7 +3751,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The updated sale information. */ @@ -3729,7 +3765,7 @@ export namespace content_v2 { /** * Country code. */ - country?: string; + country?: string | null; /** * A list of POS data providers. */ @@ -3739,15 +3775,15 @@ export namespace content_v2 { /** * The display name of Pos data Provider. */ - displayName?: string; + displayName?: string | null; /** * The full name of this POS data Provider. */ - fullName?: string; + fullName?: string | null; /** * The ID of the account. */ - providerId?: string; + providerId?: string | null; } /** * The absolute quantity of an item available at the given store. @@ -3756,19 +3792,19 @@ export namespace content_v2 { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posInventory". */ - kind?: string; + kind?: string | null; /** * The current price of the item. */ @@ -3776,33 +3812,33 @@ export namespace content_v2 { /** * The available quantity of the item. */ - quantity?: string; + quantity?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosInventoryRequest { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * The current price of the item. */ @@ -3810,37 +3846,37 @@ export namespace content_v2 { /** * The available quantity of the item. */ - quantity?: string; + quantity?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosInventoryResponse { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse". */ - kind?: string; + kind?: string | null; /** * The current price of the item. */ @@ -3848,25 +3884,25 @@ export namespace content_v2 { /** * The available quantity of the item. */ - quantity?: string; + quantity?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#posListResponse". */ - kind?: string; + kind?: string | null; resources?: Schema$PosStore[]; } /** @@ -3876,19 +3912,19 @@ export namespace content_v2 { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posSale". */ - kind?: string; + kind?: string | null; /** * The price of the item. */ @@ -3896,37 +3932,37 @@ export namespace content_v2 { /** * The relative change of the available quantity. Negative for items returned. */ - quantity?: string; + quantity?: string | null; /** * A unique ID to group items from the same sale event. */ - saleId?: string; + saleId?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosSaleRequest { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * The price of the item. */ @@ -3934,41 +3970,41 @@ export namespace content_v2 { /** * The relative change of the available quantity. Negative for items returned. */ - quantity?: string; + quantity?: string | null; /** * A unique ID to group items from the same sale event. */ - saleId?: string; + saleId?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } export interface Schema$PosSaleResponse { /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Global Trade Item Number. */ - gtin?: string; + gtin?: string | null; /** * A unique identifier for the item. */ - itemId?: string; + itemId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse". */ - kind?: string; + kind?: string | null; /** * The price of the item. */ @@ -3976,23 +4012,23 @@ export namespace content_v2 { /** * The relative change of the available quantity. Negative for items returned. */ - quantity?: string; + quantity?: string | null; /** * A unique ID to group items from the same sale event. */ - saleId?: string; + saleId?: string | null; /** * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ - storeCode?: string; + storeCode?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * The inventory timestamp, in ISO 8601 format. */ - timestamp?: string; + timestamp?: string | null; } /** * Store resource. @@ -4001,25 +4037,25 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#posStore". */ - kind?: string; + kind?: string | null; /** * The street address of the store. */ - storeAddress?: string; + storeAddress?: string | null; /** * A store identifier that is unique for the given merchant. */ - storeCode?: string; + storeCode?: string | null; } export interface Schema$PostalCodeGroup { /** * The CLDR territory code of the country the postal code group applies to. Required. */ - country?: string; + country?: string | null; /** * The name of the postal code group, referred to in headers. Required. */ - name?: string; + name?: string | null; /** * A range of postal codes. Required. */ @@ -4029,21 +4065,21 @@ export namespace content_v2 { /** * A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required. */ - postalCodeRangeBegin?: string; + postalCodeRangeBegin?: string | null; /** * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. */ - postalCodeRangeEnd?: string; + postalCodeRangeEnd?: string | null; } export interface Schema$Price { /** * The currency of the price. */ - currency?: string; + currency?: string | null; /** * The price represented as a number. */ - value?: string; + value?: string | null; } /** * Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. @@ -4052,31 +4088,31 @@ export namespace content_v2 { /** * Additional URLs of images of the item. */ - additionalImageLinks?: string[]; + additionalImageLinks?: string[] | null; /** * Additional categories of the item (formatted as in products data specification). */ - additionalProductTypes?: string[]; + additionalProductTypes?: string[] | null; /** * Set to true if the item is targeted towards adults. */ - adult?: boolean; + adult?: boolean | null; /** * Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. */ - adwordsGrouping?: string; + adwordsGrouping?: string | null; /** * Similar to adwords_grouping, but only works on CPC. */ - adwordsLabels?: string[]; + adwordsLabels?: string[] | null; /** * Allows advertisers to override the item URL when the product is shown within the context of Product Ads. */ - adwordsRedirect?: string; + adwordsRedirect?: string | null; /** * Target age group of the item. */ - ageGroup?: string; + ageGroup?: string | null; /** * Deprecated. Do not use. */ @@ -4084,31 +4120,31 @@ export namespace content_v2 { /** * Availability status of the item. */ - availability?: string; + availability?: string | null; /** * The day a pre-ordered product becomes available for delivery, in ISO 8601 format. */ - availabilityDate?: string; + availabilityDate?: string | null; /** * Brand of the item. */ - brand?: string; + brand?: string | null; /** * The item's channel (online or local). */ - channel?: string; + channel?: string | null; /** * Color of the item. */ - color?: string; + color?: string | null; /** * Condition or state of the item. */ - condition?: string; + condition?: string | null; /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Cost of goods sold. Used for gross profit reporting. */ @@ -4124,27 +4160,27 @@ export namespace content_v2 { /** * Custom label 0 for custom grouping of items in a Shopping campaign. */ - customLabel0?: string; + customLabel0?: string | null; /** * Custom label 1 for custom grouping of items in a Shopping campaign. */ - customLabel1?: string; + customLabel1?: string | null; /** * Custom label 2 for custom grouping of items in a Shopping campaign. */ - customLabel2?: string; + customLabel2?: string | null; /** * Custom label 3 for custom grouping of items in a Shopping campaign. */ - customLabel3?: string; + customLabel3?: string | null; /** * Custom label 4 for custom grouping of items in a Shopping campaign. */ - customLabel4?: string; + customLabel4?: string | null; /** * Description of the item. */ - description?: string; + description?: string | null; /** * Specifies the intended destinations for the product. */ @@ -4152,55 +4188,55 @@ export namespace content_v2 { /** * An identifier for an item for dynamic remarketing campaigns. */ - displayAdsId?: string; + displayAdsId?: string | null; /** * URL directly to your item's landing page for dynamic remarketing campaigns. */ - displayAdsLink?: string; + displayAdsLink?: string | null; /** * Advertiser-specified recommendations. */ - displayAdsSimilarIds?: string[]; + displayAdsSimilarIds?: string[] | null; /** * Title of an item for dynamic remarketing campaigns. */ - displayAdsTitle?: string; + displayAdsTitle?: string | null; /** * Offer margin for dynamic remarketing campaigns. */ - displayAdsValue?: number; + displayAdsValue?: number | null; /** * The energy efficiency class as defined in EU directive 2010/30/EU. */ - energyEfficiencyClass?: string; + energyEfficiencyClass?: string | null; /** * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. */ - expirationDate?: string; + expirationDate?: string | null; /** * Target gender of the item. */ - gender?: string; + gender?: string | null; /** * Google's category of the item (see Google product taxonomy). */ - googleProductCategory?: string; + googleProductCategory?: string | null; /** * Global Trade Item Number (GTIN) of the item. */ - gtin?: string; + gtin?: string | null; /** * The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. */ - id?: string; + id?: string | null; /** * False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada. */ - identifierExists?: boolean; + identifierExists?: boolean | null; /** * URL of an image of the item. */ - imageLink?: string; + imageLink?: string | null; /** * Number and amount of installments to pay for an item. Brazil only. */ @@ -4208,19 +4244,19 @@ export namespace content_v2 { /** * Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. */ - isBundle?: boolean; + isBundle?: boolean | null; /** * Shared identifier for all variants of the same product. */ - itemGroupId?: string; + itemGroupId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#product". */ - kind?: string; + kind?: string | null; /** * URL directly linking to your item's page on your website. */ - link?: string; + link?: string | null; /** * Loyalty points that users receive after purchasing the item. Japan only. */ @@ -4228,47 +4264,47 @@ export namespace content_v2 { /** * The material of which the item is made. */ - material?: string; + material?: string | null; /** * The energy efficiency class as defined in EU directive 2010/30/EU. */ - maxEnergyEfficiencyClass?: string; + maxEnergyEfficiencyClass?: string | null; /** * Maximal product handling time (in business days). */ - maxHandlingTime?: string; + maxHandlingTime?: string | null; /** * The energy efficiency class as defined in EU directive 2010/30/EU. */ - minEnergyEfficiencyClass?: string; + minEnergyEfficiencyClass?: string | null; /** * Minimal product handling time (in business days). */ - minHandlingTime?: string; + minHandlingTime?: string | null; /** * Link to a mobile-optimized version of the landing page. */ - mobileLink?: string; + mobileLink?: string | null; /** * Manufacturer Part Number (MPN) of the item. */ - mpn?: string; + mpn?: string | null; /** * The number of identical products in a merchant-defined multipack. */ - multipack?: string; + multipack?: string | null; /** * A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. Note: Content API methods that operate on products take the REST ID of the product, not this identifier. */ - offerId?: string; + offerId?: string | null; /** * Deprecated. Whether an item is available for purchase only online. */ - onlineOnly?: boolean; + onlineOnly?: boolean | null; /** * The item's pattern (e.g. polka dots). */ - pattern?: string; + pattern?: string | null; /** * Price of the item. */ @@ -4276,11 +4312,11 @@ export namespace content_v2 { /** * Your category of the item (formatted as in products data specification). */ - productType?: string; + productType?: string | null; /** * The unique ID of a promotion. */ - promotionIds?: string[]; + promotionIds?: string[] | null; /** * Advertised sale price of the item. */ @@ -4288,11 +4324,11 @@ export namespace content_v2 { /** * Date range during which the item is on sale (see products data specification). */ - salePriceEffectiveDate?: string; + salePriceEffectiveDate?: string | null; /** * The quantity of the product that is available for selling on Google. Supported only for online products. */ - sellOnGoogleQuantity?: string; + sellOnGoogleQuantity?: string | null; /** * Shipping rules. */ @@ -4304,7 +4340,7 @@ export namespace content_v2 { /** * The shipping label of the product, used to group product in account-level shipping rules. */ - shippingLabel?: string; + shippingLabel?: string | null; /** * Length of the item for shipping. */ @@ -4320,23 +4356,23 @@ export namespace content_v2 { /** * Size of the item. */ - sizes?: string[]; + sizes?: string[] | null; /** * System in which the size is specified. Recommended for apparel items. */ - sizeSystem?: string; + sizeSystem?: string | null; /** * The cut of the item. Recommended for apparel items. */ - sizeType?: string; + sizeType?: string | null; /** * The source of the offer, i.e., how the offer was created. */ - source?: string; + source?: string | null; /** * The CLDR territory code for the item. */ - targetCountry?: string; + targetCountry?: string | null; /** * Tax information. */ @@ -4344,7 +4380,7 @@ export namespace content_v2 { /** * Title of the item. */ - title?: string; + title?: string | null; /** * The preference of the denominator of the unit price. */ @@ -4356,7 +4392,7 @@ export namespace content_v2 { /** * Deprecated. The read-only list of intended destinations which passed validation. */ - validatedDestinations?: string[]; + validatedDestinations?: string[] | null; /** * Read-only warnings. */ @@ -4380,25 +4416,25 @@ export namespace content_v2 { /** * The name of the aspect. */ - aspectName?: string; + aspectName?: string | null; /** * The name of the destination. Leave out to apply to all destinations. */ - destinationName?: string; + destinationName?: string | null; /** * Whether the aspect is required, excluded or should be validated. */ - intention?: string; + intention?: string | null; } export interface Schema$ProductDestination { /** * The name of the destination. */ - destinationName?: string; + destinationName?: string | null; /** * Whether the destination is required, excluded or should be validated. */ - intention?: string; + intention?: string | null; } export interface Schema$ProductsCustomBatchRequest { /** @@ -4413,12 +4449,12 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The product to insert. Only required if the method is insert. */ @@ -4426,7 +4462,7 @@ export namespace content_v2 { /** * The ID of the product to get or delete. Only defined if the method is get or delete. */ - productId?: string; + productId?: string | null; } export interface Schema$ProductsCustomBatchResponse { /** @@ -4436,7 +4472,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch products response. @@ -4445,7 +4481,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if and only if the request failed. */ @@ -4453,7 +4489,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The inserted product. Only defined if the method is insert and if the request was successful. */ @@ -4463,19 +4499,19 @@ export namespace content_v2 { /** * The CLDR territory code of the country to which an item will ship. */ - country?: string; + country?: string | null; /** * The location where the shipping is applicable, represented by a location group name. */ - locationGroupName?: string; + locationGroupName?: string | null; /** * The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. */ - locationId?: string; + locationId?: string | null; /** * The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length. */ - postalCode?: string; + postalCode?: string | null; /** * Fixed shipping price, represented as a number. */ @@ -4483,41 +4519,41 @@ export namespace content_v2 { /** * The geographic region to which a shipping rate applies. */ - region?: string; + region?: string | null; /** * A free-form description of the service class or delivery speed. */ - service?: string; + service?: string | null; } export interface Schema$ProductShippingDimension { /** * The unit of value. */ - unit?: string; + unit?: string | null; /** * The dimension of the product used to calculate the shipping cost of the item. */ - value?: number; + value?: number | null; } export interface Schema$ProductShippingWeight { /** * The unit of value. */ - unit?: string; + unit?: string | null; /** * The weight of the product used to calculate the shipping cost of the item. */ - value?: number; + value?: number | null; } export interface Schema$ProductsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of products. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Product[]; } /** @@ -4527,7 +4563,7 @@ export namespace content_v2 { /** * Date on which the item has been created, in ISO 8601 format. */ - creationDate?: string; + creationDate?: string | null; /** * DEPRECATED - never populated */ @@ -4539,7 +4575,7 @@ export namespace content_v2 { /** * Date on which the item expires in Google Shopping, in ISO 8601 format. */ - googleExpirationDate?: string; + googleExpirationDate?: string | null; /** * A list of all issues associated with the product. */ @@ -4547,15 +4583,15 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productStatus". */ - kind?: string; + kind?: string | null; /** * Date on which the item has been last updated, in ISO 8601 format. */ - lastUpdateDate?: string; + lastUpdateDate?: string | null; /** * The link to the product. */ - link?: string; + link?: string | null; /** * Product data after applying all the join inputs. */ @@ -4563,40 +4599,40 @@ export namespace content_v2 { /** * The ID of the product for which status is reported. */ - productId?: string; + productId?: string | null; /** * The title of the product. */ - title?: string; + title?: string | null; } export interface Schema$ProductStatusDataQualityIssue { - destination?: string; - detail?: string; - fetchStatus?: string; - id?: string; - location?: string; - severity?: string; - timestamp?: string; - valueOnLandingPage?: string; - valueProvided?: string; + destination?: string | null; + detail?: string | null; + fetchStatus?: string | null; + id?: string | null; + location?: string | null; + severity?: string | null; + timestamp?: string | null; + valueOnLandingPage?: string | null; + valueProvided?: string | null; } export interface Schema$ProductStatusDestinationStatus { /** * Whether the approval status might change due to further processing. */ - approvalPending?: boolean; + approvalPending?: boolean | null; /** * The destination's approval status. */ - approvalStatus?: string; + approvalStatus?: string | null; /** * The name of the destination */ - destination?: string; + destination?: string | null; /** * Provided for backward compatibility only. Always set to "required". */ - intention?: string; + intention?: string | null; } export interface Schema$ProductstatusesCustomBatchRequest { /** @@ -4611,21 +4647,21 @@ export namespace content_v2 { /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ - destinations?: string[]; - includeAttributes?: boolean; + destinations?: string[] | null; + includeAttributes?: boolean | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The ID of the product whose status to get. */ - productId?: string; + productId?: string | null; } export interface Schema$ProductstatusesCustomBatchResponse { /** @@ -4635,7 +4671,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch productstatuses response. @@ -4644,7 +4680,7 @@ export namespace content_v2 { /** * The ID of the request entry this entry responds to. */ - batchId?: number; + batchId?: number | null; /** * A list of errors, if the request failed. */ @@ -4652,7 +4688,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The requested product status. Only defined if the request was successful. */ @@ -4662,92 +4698,92 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of products statuses. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$ProductStatus[]; } export interface Schema$ProductStatusItemLevelIssue { /** * The attribute's name, if the issue is caused by a single attribute. */ - attributeName?: string; + attributeName?: string | null; /** * The error code of the issue. */ - code?: string; + code?: string | null; /** * A short issue description in English. */ - description?: string; + description?: string | null; /** * The destination the issue applies to. */ - destination?: string; + destination?: string | null; /** * A detailed issue description in English. */ - detail?: string; + detail?: string | null; /** * The URL of a web page to help with resolving this issue. */ - documentation?: string; + documentation?: string | null; /** * Whether the issue can be resolved by the merchant. */ - resolution?: string; + resolution?: string | null; /** * How this issue affects serving of the offer. */ - servability?: string; + servability?: string | null; } export interface Schema$ProductTax { /** * The country within which the item is taxed, specified as a CLDR territory code. */ - country?: string; + country?: string | null; /** * The numeric ID of a location that the tax rate applies to as defined in the AdWords API. */ - locationId?: string; + locationId?: string | null; /** * The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*. */ - postalCode?: string; + postalCode?: string | null; /** * The percentage of tax rate that applies to the item price. */ - rate?: number; + rate?: number | null; /** * The geographic region to which the tax rate applies. */ - region?: string; + region?: string | null; /** * Set to true if tax is charged on shipping. */ - taxShip?: boolean; + taxShip?: boolean | null; } export interface Schema$ProductUnitPricingBaseMeasure { /** * The unit of the denominator. */ - unit?: string; + unit?: string | null; /** * The denominator of the unit price. */ - value?: string; + value?: string | null; } export interface Schema$ProductUnitPricingMeasure { /** * The unit of the measure. */ - unit?: string; + unit?: string | null; /** * The measure of an item. */ - value?: number; + value?: number | null; } export interface Schema$Promotion { /** @@ -4757,13 +4793,13 @@ export namespace content_v2 { /** * [required] ID of the promotion. */ - promotionId?: string; + promotionId?: string | null; } export interface Schema$RateGroup { /** * A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required. */ - applicableShippingLabels?: string[]; + applicableShippingLabels?: string[] | null; /** * A list of carrier rates that can be referred to by mainTable or singleValue. */ @@ -4775,7 +4811,7 @@ export namespace content_v2 { /** * Name of the rate group. Optional. If set has to be unique within shipping service. */ - name?: string; + name?: string | null; /** * The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set. */ @@ -4786,17 +4822,17 @@ export namespace content_v2 { subtables?: Schema$Table[]; } export interface Schema$RefundReason { - description?: string; - reasonCode?: string; + description?: string | null; + reasonCode?: string | null; } export interface Schema$ReturnShipment { - creationDate?: string; - deliveryDate?: string; - returnMethodType?: string; - shipmentId?: string; + creationDate?: string | null; + deliveryDate?: string | null; + returnMethodType?: string | null; + shipmentId?: string | null; shipmentTrackingInfos?: Schema$ShipmentTrackingInfo[]; - shippingDate?: string; - state?: string; + shippingDate?: string | null; + state?: string | null; } export interface Schema$Row { /** @@ -4808,15 +4844,15 @@ export namespace content_v2 { /** * A boolean exposing the active status of the shipping service. Required. */ - active?: boolean; + active?: boolean | null; /** * The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. */ - currency?: string; + currency?: string | null; /** * The CLDR territory code of the country to which the service applies. Required. */ - deliveryCountry?: string; + deliveryCountry?: string | null; /** * Time spent in various aspects from order to the delivery of the product. Required. */ @@ -4824,7 +4860,7 @@ export namespace content_v2 { /** * Eligibility for this service. */ - eligibility?: string; + eligibility?: string | null; /** * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. */ @@ -4832,7 +4868,7 @@ export namespace content_v2 { /** * Free-form name of the service. Must be unique within target account. Required. */ - name?: string; + name?: string | null; /** * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. */ @@ -4850,29 +4886,29 @@ export namespace content_v2 { /** * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ - shipmentGroupId?: string; + shipmentGroupId?: string | null; } export interface Schema$ShipmentInvoiceLineItemInvoice { /** * ID of the line item. Either lineItemId or productId must be set. */ - lineItemId?: string; + lineItemId?: string | null; /** * ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set. */ - productId?: string; + productId?: string | null; /** * [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units). */ - shipmentUnitIds?: string[]; + shipmentUnitIds?: string[] | null; /** * [required] Invoice details for a single unit. */ unitInvoice?: Schema$UnitInvoice; } export interface Schema$ShipmentTrackingInfo { - carrier?: string; - trackingNumber?: string; + carrier?: string | null; + trackingNumber?: string | null; } /** * The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. @@ -4881,7 +4917,7 @@ export namespace content_v2 { /** * The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses. */ - accountId?: string; + accountId?: string | null; /** * A list of postal code groups that can be referred to in services. Optional. */ @@ -4904,16 +4940,16 @@ export namespace content_v2 { /** * The ID of the account for which to get/update account shipping settings. */ - accountId?: string; + accountId?: string | null; /** * An entry ID, unique within the batch request. */ - batchId?: number; + batchId?: number | null; /** * The ID of the managing account. */ - merchantId?: string; - method?: string; + merchantId?: string | null; + method?: string | null; /** * The account shipping settings to update. Only defined if the method is update. */ @@ -4927,7 +4963,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse". */ - kind?: string; + kind?: string | null; } /** * A batch entry encoding a single non-batch shipping settings response. @@ -4936,7 +4972,7 @@ export namespace content_v2 { /** * The ID of the request entry to which this entry responds. */ - batchId?: number; + batchId?: number | null; /** * A list of errors defined if, and only if, the request failed. */ @@ -4944,7 +4980,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry". */ - kind?: string; + kind?: string | null; /** * The retrieved or updated account shipping settings. */ @@ -4958,7 +4994,7 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$ShippingsettingsGetSupportedHolidaysResponse { /** @@ -4968,17 +5004,17 @@ export namespace content_v2 { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse". */ - kind?: string; + kind?: string | null; } export interface Schema$ShippingsettingsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse". */ - kind?: string; + kind?: string | null; /** * The token for the retrieval of the next page of shipping settings. */ - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$ShippingSettings[]; } export interface Schema$Table { @@ -4989,7 +5025,7 @@ export namespace content_v2 { /** * Name of the table. Required for subtables, ignored for the main table. */ - name?: string; + name?: string | null; /** * Headers of the table's rows. Required. */ @@ -5007,11 +5043,11 @@ export namespace content_v2 { /** * Whether the orderinvoices service should support this order. */ - enableOrderinvoices?: boolean; + enableOrderinvoices?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "content#testOrder". */ - kind?: string; + kind?: string | null; /** * Line items that are ordered. At least one line item must be provided. */ @@ -5019,7 +5055,7 @@ export namespace content_v2 { /** * Determines if test order must be pulled by merchant or pushed to merchant via push integration. */ - notificationMode?: string; + notificationMode?: string | null; /** * The details of the payment method. */ @@ -5027,7 +5063,11 @@ export namespace content_v2 { /** * Identifier of one of the predefined delivery addresses for the delivery. */ - predefinedDeliveryAddress?: string; + predefinedDeliveryAddress?: string | null; + /** + * Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup. + */ + predefinedPickupDetails?: string | null; /** * Deprecated. Ignored if provided. */ @@ -5043,21 +5083,21 @@ export namespace content_v2 { /** * The requested shipping option. */ - shippingOption?: string; + shippingOption?: string | null; } export interface Schema$TestOrderCustomer { /** * Email address of the customer. */ - email?: string; + email?: string | null; /** * Deprecated. Please use marketingRightsInfo instead. */ - explicitMarketingPreference?: boolean; + explicitMarketingPreference?: boolean | null; /** * Full name of the customer. */ - fullName?: string; + fullName?: string | null; /** * Customer's marketing preferences. */ @@ -5067,11 +5107,11 @@ export namespace content_v2 { /** * Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. */ - explicitMarketingPreference?: string; + explicitMarketingPreference?: string | null; /** * Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. */ - lastUpdatedTimestamp?: string; + lastUpdatedTimestamp?: string | null; } export interface Schema$TestOrderLineItem { /** @@ -5081,7 +5121,7 @@ export namespace content_v2 { /** * Number of items ordered. */ - quantityOrdered?: number; + quantityOrdered?: number | null; /** * Details of the return policy for the line item. */ @@ -5099,19 +5139,19 @@ export namespace content_v2 { /** * Brand of the item. */ - brand?: string; + brand?: string | null; /** * Deprecated. */ - channel?: string; + channel?: string | null; /** * Condition or state of the item. */ - condition?: string; + condition?: string | null; /** * The two-letter ISO 639-1 language code for the item. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Fees for the item. Optional. */ @@ -5119,23 +5159,23 @@ export namespace content_v2 { /** * Global Trade Item Number (GTIN) of the item. Optional. */ - gtin?: string; + gtin?: string | null; /** * URL of an image of the item. */ - imageLink?: string; + imageLink?: string | null; /** * Shared identifier for all variants of the same product. Optional. */ - itemGroupId?: string; + itemGroupId?: string | null; /** * Manufacturer Part Number (MPN) of the item. Optional. */ - mpn?: string; + mpn?: string | null; /** * An identifier of the item. */ - offerId?: string; + offerId?: string | null; /** * The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. */ @@ -5143,11 +5183,11 @@ export namespace content_v2 { /** * The CLDR territory code of the target country of the product. */ - targetCountry?: string; + targetCountry?: string | null; /** * The title of the product. */ - title?: string; + title?: string | null; /** * Variant attributes for the item. Optional. */ @@ -5157,34 +5197,34 @@ export namespace content_v2 { /** * The card expiration month (January = 1, February = 2 etc.). */ - expirationMonth?: number; + expirationMonth?: number | null; /** * The card expiration year (4-digit, e.g. 2015). */ - expirationYear?: number; + expirationYear?: number | null; /** * The last four digits of the card number. */ - lastFourDigits?: string; + lastFourDigits?: string | null; /** * The billing address. */ - predefinedBillingAddress?: string; + predefinedBillingAddress?: string | null; /** * The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder. */ - type?: string; + type?: string | null; } export interface Schema$TransitTable { /** * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. */ - postalCodeGroupNames?: string[]; + postalCodeGroupNames?: string[] | null; rows?: Schema$TransitTableTransitTimeRow[]; /** * A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"]. */ - transitTimeLabels?: string[]; + transitTimeLabels?: string[] | null; } export interface Schema$TransitTableTransitTimeRow { values?: Schema$TransitTableTransitTimeRowTransitTimeValue[]; @@ -5193,11 +5233,11 @@ export namespace content_v2 { /** * Must be greater than or equal to minTransitTimeInDays. */ - maxTransitTimeInDays?: number; + maxTransitTimeInDays?: number | null; /** * Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery. */ - minTransitTimeInDays?: number; + minTransitTimeInDays?: number | null; } export interface Schema$UnitInvoice { /** @@ -5229,7 +5269,7 @@ export namespace content_v2 { /** * [required] Type of the additional charge. */ - type?: string; + type?: string | null; } export interface Schema$UnitInvoiceTaxLine { /** @@ -5239,11 +5279,11 @@ export namespace content_v2 { /** * Optional name of the tax type. This should only be provided if taxType is otherFeeTax. */ - taxName?: string; + taxName?: string | null; /** * [required] Type of the tax. */ - taxType?: string; + taxType?: string | null; } /** * The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. @@ -5252,7 +5292,7 @@ export namespace content_v2 { /** * The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. */ - carrierRateName?: string; + carrierRateName?: string | null; /** * A flat rate. Can only be set if all other fields are not set. */ @@ -5260,25 +5300,25 @@ export namespace content_v2 { /** * If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set. */ - noShipping?: boolean; + noShipping?: boolean | null; /** * A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set. */ - pricePercentage?: string; + pricePercentage?: string | null; /** * The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set. */ - subtableName?: string; + subtableName?: string | null; } export interface Schema$Weight { /** * The weight unit. */ - unit?: string; + unit?: string | null; /** * The weight represented as a number. */ - value?: string; + value?: string | null; } export class Resource$Accounts { diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index 7d307bf0e4f..bf6fc8ebdde 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -104,8 +104,8 @@ export namespace customsearch_v1 { export interface Schema$Context { facets?: Array< Array<{anchor?: string; label?: string; label_with_op?: string}> - >; - title?: string; + > | null; + title?: string | null; } export interface Schema$Promotion { bodyLines?: Array<{ @@ -113,59 +113,59 @@ export namespace customsearch_v1 { link?: string; title?: string; url?: string; - }>; - displayLink?: string; - htmlTitle?: string; - image?: {height?: number; source?: string; width?: number}; - link?: string; - title?: string; + }> | null; + displayLink?: string | null; + htmlTitle?: string | null; + image?: {height?: number; source?: string; width?: number} | null; + link?: string | null; + title?: string | null; } export interface Schema$Query { - count?: number; - cr?: string; - cx?: string; - dateRestrict?: string; - disableCnTwTranslation?: string; - exactTerms?: string; - excludeTerms?: string; - fileType?: string; - filter?: string; - gl?: string; - googleHost?: string; - highRange?: string; - hl?: string; - hq?: string; - imgColorType?: string; - imgDominantColor?: string; - imgSize?: string; - imgType?: string; - inputEncoding?: string; - language?: string; - linkSite?: string; - lowRange?: string; - orTerms?: string; - outputEncoding?: string; - relatedSite?: string; - rights?: string; - safe?: string; - searchTerms?: string; - searchType?: string; - siteSearch?: string; - siteSearchFilter?: string; - sort?: string; - startIndex?: number; - startPage?: number; - title?: string; - totalResults?: string; + count?: number | null; + cr?: string | null; + cx?: string | null; + dateRestrict?: string | null; + disableCnTwTranslation?: string | null; + exactTerms?: string | null; + excludeTerms?: string | null; + fileType?: string | null; + filter?: string | null; + gl?: string | null; + googleHost?: string | null; + highRange?: string | null; + hl?: string | null; + hq?: string | null; + imgColorType?: string | null; + imgDominantColor?: string | null; + imgSize?: string | null; + imgType?: string | null; + inputEncoding?: string | null; + language?: string | null; + linkSite?: string | null; + lowRange?: string | null; + orTerms?: string | null; + outputEncoding?: string | null; + relatedSite?: string | null; + rights?: string | null; + safe?: string | null; + searchTerms?: string | null; + searchType?: string | null; + siteSearch?: string | null; + siteSearchFilter?: string | null; + sort?: string | null; + startIndex?: number | null; + startPage?: number | null; + title?: string | null; + totalResults?: string | null; } export interface Schema$Result { - cacheId?: string; - displayLink?: string; - fileFormat?: string; - formattedUrl?: string; - htmlFormattedUrl?: string; - htmlSnippet?: string; - htmlTitle?: string; + cacheId?: string | null; + displayLink?: string | null; + fileFormat?: string | null; + formattedUrl?: string | null; + htmlFormattedUrl?: string | null; + htmlSnippet?: string | null; + htmlTitle?: string | null; image?: { byteSize?: number; contextLink?: string; @@ -174,33 +174,33 @@ export namespace customsearch_v1 { thumbnailLink?: string; thumbnailWidth?: number; width?: number; - }; - kind?: string; + } | null; + kind?: string | null; labels?: Array<{ displayName?: string; label_with_op?: string; name?: string; - }>; - link?: string; - mime?: string; - pagemap?: {[key: string]: Array<{[key: string]: any}>}; - snippet?: string; - title?: string; + }> | null; + link?: string | null; + mime?: string | null; + pagemap?: {[key: string]: Array<{[key: string]: any}>} | null; + snippet?: string | null; + title?: string | null; } export interface Schema$Search { context?: Schema$Context; items?: Schema$Result[]; - kind?: string; + kind?: string | null; promotions?: Schema$Promotion[]; - queries?: {[key: string]: Schema$Query[]}; + queries?: {[key: string]: Schema$Query[]} | null; searchInformation?: { formattedSearchTime?: string; formattedTotalResults?: string; searchTime?: number; totalResults?: string; - }; - spelling?: {correctedQuery?: string; htmlCorrectedQuery?: string}; - url?: {template?: string; type?: string}; + } | null; + spelling?: {correctedQuery?: string; htmlCorrectedQuery?: string} | null; + url?: {template?: string; type?: string} | null; } export class Resource$Cse { diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 023894eb818..2a873562ef2 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -124,7 +124,7 @@ export namespace dataflow_v1b3 { /** * Obsolete. */ - percentComplete?: number; + percentComplete?: number | null; /** * Obsolete. */ @@ -132,7 +132,7 @@ export namespace dataflow_v1b3 { /** * Obsolete. */ - remainingTime?: string; + remainingTime?: string | null; } /** * A progress measurement of a WorkItem by a worker. @@ -145,7 +145,7 @@ export namespace dataflow_v1b3 { /** * Completion as fraction of the input consumed, from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed). */ - fractionConsumed?: number; + fractionConsumed?: number | null; /** * A Position within the work to represent a progress. */ @@ -162,11 +162,11 @@ export namespace dataflow_v1b3 { /** * A fraction at which to split the work item, from 0.0 (beginning of the input) to 1.0 (end of the input). */ - fractionConsumed?: number; + fractionConsumed?: number | null; /** * The fraction of the remainder of work to split the work item at, from 0.0 (split at the current position) to 1.0 (end of the input). */ - fractionOfRemainder?: number; + fractionOfRemainder?: number | null; /** * A Position at which to split the work item. */ @@ -179,7 +179,7 @@ export namespace dataflow_v1b3 { /** * The current number of workers the job has. */ - currentNumWorkers?: string; + currentNumWorkers?: string | null; /** * A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers. */ @@ -187,19 +187,19 @@ export namespace dataflow_v1b3 { /** * The type of autoscaling event to report. */ - eventType?: string; + eventType?: string | null; /** * The target number of workers the worker pool wants to resize to use. */ - targetNumWorkers?: string; + targetNumWorkers?: string | null; /** * The time this event was emitted to indicate a new target or current num_workers value. */ - time?: string; + time?: string | null; /** * A short and friendly name for the worker pool this event refers to, populated from the value of PoolStageRelation::user_pool_name. */ - workerPool?: string; + workerPool?: string | null; } /** * Settings for WorkerPool autoscaling. @@ -208,11 +208,11 @@ export namespace dataflow_v1b3 { /** * The algorithm to use for autoscaling. */ - algorithm?: string; + algorithm?: string | null; /** * The maximum number of workers to cap scaling at. */ - maxNumWorkers?: number; + maxNumWorkers?: number | null; } /** * Metadata for a BigQuery connector used by the job. @@ -221,19 +221,19 @@ export namespace dataflow_v1b3 { /** * Dataset accessed in the connection. */ - dataset?: string; + dataset?: string | null; /** * Project accessed in the connection. */ - projectId?: string; + projectId?: string | null; /** * Query used to access data in the connection. */ - query?: string; + query?: string | null; /** * Table accessed in the connection. */ - table?: string; + table?: string | null; } /** * Metadata for a BigTable connector used by the job. @@ -242,15 +242,15 @@ export namespace dataflow_v1b3 { /** * InstanceId accessed in the connection. */ - instanceId?: string; + instanceId?: string | null; /** * ProjectId accessed in the connection. */ - projectId?: string; + projectId?: string | null; /** * TableId accessed in the connection. */ - tableId?: string; + tableId?: string | null; } /** * Description of an interstitial value between transforms in an execution stage. @@ -259,15 +259,15 @@ export namespace dataflow_v1b3 { /** * Dataflow service generated name for this source. */ - name?: string; + name?: string | null; /** * User name for the original user transform or collection with which this source is most closely associated. */ - originalTransformOrCollection?: string; + originalTransformOrCollection?: string | null; /** * Human-readable name for this transform; may be user or system generated. */ - userName?: string; + userName?: string | null; } /** * Description of a transform executed as part of an execution stage. @@ -276,15 +276,15 @@ export namespace dataflow_v1b3 { /** * Dataflow service generated name for this source. */ - name?: string; + name?: string | null; /** * User name for the original user transform with which this transform is most closely associated. */ - originalTransform?: string; + originalTransform?: string | null; /** * Human-readable name for this transform; may be user or system generated. */ - userName?: string; + userName?: string | null; } /** * All configuration data for a particular Computation. @@ -293,7 +293,7 @@ export namespace dataflow_v1b3 { /** * The ID of the computation. */ - computationId?: string; + computationId?: string | null; /** * The inputs to the computation. */ @@ -313,7 +313,7 @@ export namespace dataflow_v1b3 { /** * The system stage name. */ - systemStageName?: string; + systemStageName?: string | null; } /** * A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. @@ -322,7 +322,7 @@ export namespace dataflow_v1b3 { /** * Index of the inner source. */ - index?: number; + index?: number | null; /** * Position within the inner source. */ @@ -335,19 +335,19 @@ export namespace dataflow_v1b3 { /** * Human-readable description of the counter semantics. */ - description?: string; + description?: string | null; /** * Counter aggregation kind. */ - kind?: string; + kind?: string | null; /** * A string referring to the unit type. */ - otherUnits?: string; + otherUnits?: string | null; /** * System defined Units, see above enum. */ - standardUnits?: string; + standardUnits?: string | null; } /** * Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job. @@ -356,43 +356,43 @@ export namespace dataflow_v1b3 { /** * Name of the optimized step being executed by the workers. */ - componentStepName?: string; + componentStepName?: string | null; /** * Name of the stage. An execution step contains multiple component steps. */ - executionStepName?: string; + executionStepName?: string | null; /** * Index of an input collection that's being read from/written to as a side input. The index identifies a step's side inputs starting by 1 (e.g. the first side input has input_index 1, the third has input_index 3). Side inputs are identified by a pair of (original_step_name, input_index). This field helps uniquely identify them. */ - inputIndex?: number; + inputIndex?: number | null; /** * Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required. */ - name?: string; + name?: string | null; /** * One of the standard Origins defined above. */ - origin?: string; + origin?: string | null; /** * The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs. */ - originalRequestingStepName?: string; + originalRequestingStepName?: string | null; /** * System generated name of the original step in the user's graph, before optimization. */ - originalStepName?: string; + originalStepName?: string | null; /** * A string containing a more specific namespace of the counter's origin. */ - originNamespace?: string; + originNamespace?: string | null; /** * Portion of this counter, either key or value. */ - portion?: string; + portion?: string | null; /** * ID of a particular worker. */ - workerId?: string; + workerId?: string | null; } /** * A single message which encapsulates structured name and metadata for a given counter. @@ -414,11 +414,11 @@ export namespace dataflow_v1b3 { /** * Boolean value for And, Or. */ - boolean?: boolean; + boolean?: boolean | null; /** * True if this counter is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this counter is reported as a delta. */ - cumulative?: boolean; + cumulative?: boolean | null; /** * Distribution data */ @@ -426,7 +426,7 @@ export namespace dataflow_v1b3 { /** * Floating point value for Sum, Max, Min. */ - floatingPoint?: number; + floatingPoint?: number | null; /** * List of floating point numbers, for Set. */ @@ -454,7 +454,7 @@ export namespace dataflow_v1b3 { /** * Value for internally-defined counters used by the Dataflow service. */ - internal?: any; + internal?: any | null; /** * Counter name and aggregation type. */ @@ -462,7 +462,7 @@ export namespace dataflow_v1b3 { /** * The service-generated short identifier for this counter. The short_id -> (name, metadata) mapping is constant for the lifetime of a job. */ - shortId?: string; + shortId?: string | null; /** * List of strings, for Set. */ @@ -479,15 +479,15 @@ export namespace dataflow_v1b3 { /** * Average CPU utilization rate (% non-idle cpu / second) since previous sample. */ - rate?: number; + rate?: number | null; /** * Timestamp of the measurement. */ - timestamp?: string; + timestamp?: string | null; /** * Total active CPU time across all cores (ie., non-idle) in milliseconds since start-up. */ - totalMs?: string; + totalMs?: string | null; } /** * A request to create a Cloud Dataflow job from a template. @@ -500,19 +500,19 @@ export namespace dataflow_v1b3 { /** * Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`. */ - gcsPath?: string; + gcsPath?: string | null; /** * Required. The job name to use for the created job. */ - jobName?: string; + jobName?: string | null; /** * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. */ - location?: string; + location?: string | null; /** * The runtime parameters to pass to the job. */ - parameters?: {[key: string]: string}; + parameters?: {[key: string]: string} | null; } /** * Identifies the location of a custom souce. @@ -521,7 +521,7 @@ export namespace dataflow_v1b3 { /** * Whether this source is stateful. */ - stateful?: boolean; + stateful?: boolean | null; } /** * Data disk assignment for a given VM instance. @@ -530,11 +530,11 @@ export namespace dataflow_v1b3 { /** * Mounted data disks. The order is important a data disk's 0-based index in this list defines which persistent directory the disk is mounted to, for example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" }, { "myproject-1014-104817-4c2-harness-0-disk-1" }. */ - dataDisks?: string[]; + dataDisks?: string[] | null; /** * VM instance name the data disks mounted to, for example "myproject-1014-104817-4c2-harness-0". */ - vmInstance?: string; + vmInstance?: string | null; } /** * Metadata for a Datastore connector used by the job. @@ -543,11 +543,11 @@ export namespace dataflow_v1b3 { /** * Namespace used in the connection. */ - namespace?: string; + namespace?: string | null; /** * ProjectId accessed in the connection. */ - projectId?: string; + projectId?: string | null; } /** * Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. @@ -556,7 +556,7 @@ export namespace dataflow_v1b3 { /** * What source to base the produced source on (if any). */ - derivationMode?: string; + derivationMode?: string | null; /** * Specification of the source. */ @@ -569,15 +569,15 @@ export namespace dataflow_v1b3 { /** * Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Cloud Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard */ - diskType?: string; + diskType?: string | null; /** * Directory in a VM where disk is mounted. */ - mountPoint?: string; + mountPoint?: string | null; /** * Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. */ - sizeGb?: number; + sizeGb?: number | null; } /** * Data provided with a pipeline or transform to provide descriptive info. @@ -586,51 +586,51 @@ export namespace dataflow_v1b3 { /** * Contains value if the data is of a boolean type. */ - boolValue?: boolean; + boolValue?: boolean | null; /** * Contains value if the data is of duration type. */ - durationValue?: string; + durationValue?: string | null; /** * Contains value if the data is of float type. */ - floatValue?: number; + floatValue?: number | null; /** * Contains value if the data is of int64 type. */ - int64Value?: string; + int64Value?: string | null; /** * Contains value if the data is of java class type. */ - javaClassValue?: string; + javaClassValue?: string | null; /** * The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system. */ - key?: string; + key?: string | null; /** * An optional label to display in a dax UI for the element. */ - label?: string; + label?: string | null; /** * The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering. */ - namespace?: string; + namespace?: string | null; /** * A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip. */ - shortStrValue?: string; + shortStrValue?: string | null; /** * Contains value if the data is of string type. */ - strValue?: string; + strValue?: string | null; /** * Contains value if the data is of timestamp type. */ - timestampValue?: string; + timestampValue?: string | null; /** * An optional full URL. */ - url?: string; + url?: string | null; } /** * A metric value representing a distribution. @@ -659,7 +659,7 @@ export namespace dataflow_v1b3 { /** * Use a double since the sum of squares is likely to overflow int64. */ - sumOfSquares?: number; + sumOfSquares?: number | null; } /** * When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input. @@ -681,47 +681,47 @@ export namespace dataflow_v1b3 { /** * The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com". */ - clusterManagerApiService?: string; + clusterManagerApiService?: string | null; /** * The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} */ - dataset?: string; + dataset?: string | null; /** * The list of experiments to enable. */ - experiments?: string[]; + experiments?: string[] | null; /** * Which Flexible Resource Scheduling mode to run in. */ - flexResourceSchedulingGoal?: string; + flexResourceSchedulingGoal?: string | null; /** * Experimental settings. */ - internalExperiments?: {[key: string]: any}; + internalExperiments?: {[key: string]: any} | null; /** * The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way. */ - sdkPipelineOptions?: {[key: string]: any}; + sdkPipelineOptions?: {[key: string]: any} | null; /** * Identity to run virtual machines as. Defaults to the default account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; /** * If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY */ - serviceKmsKeyName?: string; + serviceKmsKeyName?: string | null; /** * The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ - tempStoragePrefix?: string; + tempStoragePrefix?: string | null; /** * A description of the process that generated the request. */ - userAgent?: {[key: string]: any}; + userAgent?: {[key: string]: any} | null; /** * A structure describing which components and their versions of the service are required in order to run the job. */ - version?: {[key: string]: any}; + version?: {[key: string]: any} | null; /** * The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. */ @@ -734,15 +734,15 @@ export namespace dataflow_v1b3 { /** * The time at which the stage transitioned to this state. */ - currentStateTime?: string; + currentStateTime?: string | null; /** * The name of the execution stage. */ - executionStageName?: string; + executionStageName?: string | null; /** * Executions stage states allow the same set of values as JobState. */ - executionStageState?: string; + executionStageState?: string | null; } /** * Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. @@ -759,7 +759,7 @@ export namespace dataflow_v1b3 { /** * Dataflow service generated id for this stage. */ - id?: string; + id?: string | null; /** * Input sources for this stage. */ @@ -767,11 +767,11 @@ export namespace dataflow_v1b3 { /** * Type of tranform this stage is executing. */ - kind?: string; + kind?: string | null; /** * Dataflow service generated name for this stage. */ - name?: string; + name?: string | null; /** * Output sources for this stage. */ @@ -784,7 +784,7 @@ export namespace dataflow_v1b3 { /** * The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. */ - name?: string; + name?: string | null; } /** * Metadata for a File connector used by the job. @@ -793,7 +793,7 @@ export namespace dataflow_v1b3 { /** * File Pattern used to access files by the connector. */ - filePattern?: string; + filePattern?: string | null; } /** * An instruction that copies its inputs (zero or more) to its (single) output. @@ -811,7 +811,7 @@ export namespace dataflow_v1b3 { /** * Elements of the list. */ - elements?: number[]; + elements?: number[] | null; } /** * A representation of a floating point mean metric contribution. @@ -824,7 +824,7 @@ export namespace dataflow_v1b3 { /** * The sum of all values being aggregated. */ - sum?: number; + sum?: number | null; } /** * Request to get updated debug configuration for component. @@ -833,15 +833,15 @@ export namespace dataflow_v1b3 { /** * The internal component id for which debug configuration is requested. */ - componentId?: string; + componentId?: string | null; /** * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ - location?: string; + location?: string | null; /** * The worker id, i.e., VM hostname. */ - workerId?: string; + workerId?: string | null; } /** * Response to a get debug configuration request. @@ -850,7 +850,7 @@ export namespace dataflow_v1b3 { /** * The encoded debug configuration for the requested component. */ - config?: string; + config?: string | null; } /** * The response to a GetTemplate request. @@ -872,11 +872,11 @@ export namespace dataflow_v1b3 { /** * Counts of values in each bucket. For efficiency, prefix and trailing buckets with count = 0 are elided. Buckets can store the full range of values of an unsigned long, with ULLONG_MAX falling into the 59th bucket with range [1e19, 2e19). */ - bucketCounts?: string[]; + bucketCounts?: string[] | null; /** * Starting index of first stored bucket. The non-inclusive upper-bound of the ith bucket is given by: pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3] */ - firstBucketOffset?: number; + firstBucketOffset?: number | null; } /** * Proto describing a hot key detected on a given WorkItem. @@ -885,15 +885,15 @@ export namespace dataflow_v1b3 { /** * The age of the hot key measured from when it was first detected. */ - hotKeyAge?: string; + hotKeyAge?: string | null; /** * System-defined name of the step containing this hot key. Unique across the workflow. */ - systemName?: string; + systemName?: string | null; /** * User-provided name of the step that contains this hot key. */ - userStepName?: string; + userStepName?: string | null; } /** * An input of an instruction, as a reference to an output of a producer instruction. @@ -902,11 +902,11 @@ export namespace dataflow_v1b3 { /** * The output index (origin zero) within the producer. */ - outputNum?: number; + outputNum?: number | null; /** * The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask. */ - producerInstructionIndex?: number; + producerInstructionIndex?: number | null; } /** * An output of an instruction. @@ -915,27 +915,27 @@ export namespace dataflow_v1b3 { /** * The codec to use to encode data being written via this output. */ - codec?: {[key: string]: any}; + codec?: {[key: string]: any} | null; /** * The user-provided name of this output. */ - name?: string; + name?: string | null; /** * For system-generated byte and mean byte metrics, certain instructions should only report the key size. */ - onlyCountKeyBytes?: boolean; + onlyCountKeyBytes?: boolean | null; /** * For system-generated byte and mean byte metrics, certain instructions should only report the value size. */ - onlyCountValueBytes?: boolean; + onlyCountValueBytes?: boolean | null; /** * System-defined name for this output in the original workflow graph. Outputs that do not contribute to an original instruction do not set this. */ - originalName?: string; + originalName?: string | null; /** * System-defined name of this output. Unique across the workflow. */ - systemName?: string; + systemName?: string | null; } /** * A metric value representing temporal values of a variable. @@ -944,7 +944,7 @@ export namespace dataflow_v1b3 { /** * The time at which this value was measured. Measured as msecs from epoch. */ - timestamp?: string; + timestamp?: string | null; /** * The value of the variable represented by this gauge. */ @@ -979,23 +979,23 @@ export namespace dataflow_v1b3 { /** * The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. */ - clientRequestId?: string; + clientRequestId?: string | null; /** * If this is specified, the job's initial state is populated from the given snapshot. */ - createdFromSnapshotId?: string; + createdFromSnapshotId?: string | null; /** * The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. */ - createTime?: string; + createTime?: string | null; /** * The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. */ - currentState?: string; + currentState?: string | null; /** * The timestamp associated with the current state. */ - currentStateTime?: string; + currentStateTime?: string | null; /** * The environment for the job. */ @@ -1007,7 +1007,7 @@ export namespace dataflow_v1b3 { /** * The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job. */ - id?: string; + id?: string | null; /** * This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher. */ @@ -1015,15 +1015,15 @@ export namespace dataflow_v1b3 { /** * User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ - location?: string; + location?: string | null; /** * The user-specified Cloud Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?` */ - name?: string; + name?: string | null; /** * Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. */ @@ -1031,19 +1031,19 @@ export namespace dataflow_v1b3 { /** * The ID of the Cloud Platform project that the job belongs to. */ - projectId?: string; + projectId?: string | null; /** * If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. */ - replacedByJobId?: string; + replacedByJobId?: string | null; /** * If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. */ - replaceJobId?: string; + replaceJobId?: string | null; /** * The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. */ - requestedState?: string; + requestedState?: string | null; /** * This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. */ @@ -1051,7 +1051,7 @@ export namespace dataflow_v1b3 { /** * The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. */ - startTime?: string; + startTime?: string | null; /** * Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. */ @@ -1059,19 +1059,19 @@ export namespace dataflow_v1b3 { /** * The GCS location where the steps are stored. */ - stepsLocation?: string; + stepsLocation?: string | null; /** * A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ - tempFiles?: string[]; + tempFiles?: string[] | null; /** * The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */ - transformNameMapping?: {[key: string]: string}; + transformNameMapping?: {[key: string]: string} | null; /** * The type of Cloud Dataflow job. */ - type?: string; + type?: string | null; } /** * Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. @@ -1080,7 +1080,7 @@ export namespace dataflow_v1b3 { /** * A mapping from each stage to the information about that stage. */ - stages?: {[key: string]: Schema$JobExecutionStageInfo}; + stages?: {[key: string]: Schema$JobExecutionStageInfo} | null; } /** * Contains information about how a particular google.dataflow.v1beta3.Step will be executed. @@ -1089,7 +1089,7 @@ export namespace dataflow_v1b3 { /** * The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. */ - stepName?: string[]; + stepName?: string[] | null; } /** * A particular message pertaining to a Dataflow job. @@ -1098,19 +1098,19 @@ export namespace dataflow_v1b3 { /** * Deprecated. */ - id?: string; + id?: string | null; /** * Importance level of the message. */ - messageImportance?: string; + messageImportance?: string | null; /** * The text of the message. */ - messageText?: string; + messageText?: string | null; /** * The timestamp of the message. */ - time?: string; + time?: string | null; } /** * Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. @@ -1156,7 +1156,7 @@ export namespace dataflow_v1b3 { /** * Timestamp as of which metric values are current. */ - metricTime?: string; + metricTime?: string | null; } /** * Data disk assignment information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON. @@ -1165,15 +1165,15 @@ export namespace dataflow_v1b3 { /** * The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". */ - dataDisk?: string; + dataDisk?: string | null; /** * The end (exclusive) of the key range. */ - end?: string; + end?: string | null; /** * The start (inclusive) of the key range. */ - start?: string; + start?: string | null; } /** * Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON. @@ -1182,23 +1182,23 @@ export namespace dataflow_v1b3 { /** * The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". */ - dataDisk?: string; + dataDisk?: string | null; /** * The physical location of this range assignment to be used for streaming computation cross-worker message delivery. */ - deliveryEndpoint?: string; + deliveryEndpoint?: string | null; /** * DEPRECATED. The location of the persistent state for this range, as a persistent directory in the worker local filesystem. */ - deprecatedPersistentDirectory?: string; + deprecatedPersistentDirectory?: string | null; /** * The end (exclusive) of the key range. */ - end?: string; + end?: string | null; /** * The start (inclusive) of the key range. */ - start?: string; + start?: string | null; } /** * Parameters to provide to the template being launched. @@ -1211,19 +1211,19 @@ export namespace dataflow_v1b3 { /** * Required. The job name to use for the created job. */ - jobName?: string; + jobName?: string | null; /** * The runtime parameters to pass to the job. */ - parameters?: {[key: string]: string}; + parameters?: {[key: string]: string} | null; /** * Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */ - transformNameMapping?: {[key: string]: string}; + transformNameMapping?: {[key: string]: string} | null; /** * If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state. */ - update?: boolean; + update?: boolean | null; } /** * Response to the request to launch a template. @@ -1241,31 +1241,31 @@ export namespace dataflow_v1b3 { /** * The current timestamp at the worker. */ - currentWorkerTime?: string; + currentWorkerTime?: string | null; /** * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. */ - location?: string; + location?: string | null; /** * The initial lease period. */ - requestedLeaseDuration?: string; + requestedLeaseDuration?: string | null; /** * Untranslated bag-of-bytes WorkRequest from UnifiedWorker. */ - unifiedWorkerRequest?: {[key: string]: any}; + unifiedWorkerRequest?: {[key: string]: any} | null; /** * Worker capabilities. WorkItems might be limited to workers with specific capabilities. */ - workerCapabilities?: string[]; + workerCapabilities?: string[] | null; /** * Identifies the worker leasing work -- typically the ID of the virtual machine running the worker. */ - workerId?: string; + workerId?: string | null; /** * Filter for WorkItem type. */ - workItemTypes?: string[]; + workItemTypes?: string[] | null; } /** * Response to a request to lease WorkItems. @@ -1274,7 +1274,7 @@ export namespace dataflow_v1b3 { /** * Untranslated bag-of-bytes WorkResponse for UnifiedWorker. */ - unifiedWorkerResponse?: {[key: string]: any}; + unifiedWorkerResponse?: {[key: string]: any} | null; /** * A list of the leased WorkItems. */ @@ -1295,7 +1295,7 @@ export namespace dataflow_v1b3 { /** * The token to obtain the next page of results if there are more. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response to a request to list Cloud Dataflow jobs. This may be a partial response, depending on the page size in the ListJobsRequest. @@ -1312,7 +1312,7 @@ export namespace dataflow_v1b3 { /** * Set if there may be more results than fit in this response. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem. Each instruction must appear in the list before any instructions which depends on its output. @@ -1321,7 +1321,7 @@ export namespace dataflow_v1b3 { /** * Counter prefix that can be used to prefix counters. Not currently used in Dataflow. */ - counterPrefix?: string; + counterPrefix?: string | null; /** * The instructions in the MapTask. */ @@ -1329,11 +1329,11 @@ export namespace dataflow_v1b3 { /** * System-defined name of the stage containing this MapTask. Unique across the workflow. */ - stageName?: string; + stageName?: string | null; /** * System-defined name of this MapTask. Unique across the workflow. */ - systemName?: string; + systemName?: string | null; } /** * The metric short id is returned to the user alongside an offset into ReportWorkItemStatusRequest @@ -1342,11 +1342,11 @@ export namespace dataflow_v1b3 { /** * The index of the corresponding metric in the ReportWorkItemStatusRequest. Required. */ - metricIndex?: number; + metricIndex?: number | null; /** * The service-generated short identifier for the metric. */ - shortId?: string; + shortId?: string | null; } /** * Identifies a metric, by describing the source which generated the metric. @@ -1355,15 +1355,15 @@ export namespace dataflow_v1b3 { /** * Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>. */ - context?: {[key: string]: string}; + context?: {[key: string]: string} | null; /** * Worker-defined metric name. */ - name?: string; + name?: string | null; /** * Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK. */ - origin?: string; + origin?: string | null; } /** * Describes the state of a metric. @@ -1372,31 +1372,31 @@ export namespace dataflow_v1b3 { /** * True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem. */ - cumulative?: boolean; + cumulative?: boolean | null; /** * A struct value describing properties of a distribution of numeric values. */ - distribution?: any; + distribution?: any | null; /** * A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value. */ - gauge?: any; + gauge?: any | null; /** * Worker-computed aggregate value for internal use by the Dataflow service. */ - internal?: any; + internal?: any | null; /** * Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value. */ - kind?: string; + kind?: string | null; /** * Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long. */ - meanCount?: any; + meanCount?: any | null; /** * Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double. */ - meanSum?: any; + meanSum?: any | null; /** * Name of the metric. */ @@ -1404,15 +1404,15 @@ export namespace dataflow_v1b3 { /** * Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean. */ - scalar?: any; + scalar?: any | null; /** * Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type. */ - set?: any; + set?: any | null; /** * Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API. */ - updateTime?: string; + updateTime?: string | null; } /** * Describes mounted data disk. @@ -1421,7 +1421,7 @@ export namespace dataflow_v1b3 { /** * The name of the data disk. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". */ - dataDisk?: string; + dataDisk?: string | null; } /** * Information about an output of a multi-output DoFn. @@ -1430,7 +1430,7 @@ export namespace dataflow_v1b3 { /** * The id of the tag the user code will emit to this output by; this should correspond to the tag of some SideInputInfo. */ - tag?: string; + tag?: string | null; } /** * Basic metadata about a counter. @@ -1439,11 +1439,11 @@ export namespace dataflow_v1b3 { /** * Counter aggregation kind. */ - kind?: string; + kind?: string | null; /** * Name of the counter. */ - name?: string; + name?: string | null; } /** * The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run. @@ -1452,11 +1452,11 @@ export namespace dataflow_v1b3 { /** * The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/ */ - location?: string; + location?: string | null; /** * The name of the package. */ - name?: string; + name?: string | null; } /** * Describes a particular operation comprising a MapTask. @@ -1469,11 +1469,11 @@ export namespace dataflow_v1b3 { /** * User-provided name of this operation. */ - name?: string; + name?: string | null; /** * System-defined name for the operation in the original workflow graph. */ - originalName?: string; + originalName?: string | null; /** * Describes the outputs of the instruction. */ @@ -1493,7 +1493,7 @@ export namespace dataflow_v1b3 { /** * System-defined name of this operation. Unique across the workflow. */ - systemName?: string; + systemName?: string | null; /** * Additional information for Write instructions. */ @@ -1506,11 +1506,11 @@ export namespace dataflow_v1b3 { /** * Key or name for this parameter. */ - key?: string; + key?: string | null; /** * Value for this parameter. */ - value?: any; + value?: any | null; } /** * Metadata for a specific parameter. @@ -1519,23 +1519,23 @@ export namespace dataflow_v1b3 { /** * Required. The help text to display for the parameter. */ - helpText?: string; + helpText?: string | null; /** * Optional. Whether the parameter is optional. Defaults to false. */ - isOptional?: boolean; + isOptional?: boolean | null; /** * Required. The label to display for the parameter. */ - label?: string; + label?: string | null; /** * Required. The name of the parameter. */ - name?: string; + name?: string | null; /** * Optional. Regexes that the parameter must match. */ - regexes?: string[]; + regexes?: string[] | null; } /** * An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code. @@ -1552,7 +1552,7 @@ export namespace dataflow_v1b3 { /** * The number of outputs. */ - numOutputs?: number; + numOutputs?: number | null; /** * Zero or more side inputs. */ @@ -1560,7 +1560,7 @@ export namespace dataflow_v1b3 { /** * The user function to invoke. */ - userFn?: {[key: string]: any}; + userFn?: {[key: string]: any} | null; } /** * An instruction that does a partial group-by-key. One input and one output. @@ -1573,15 +1573,15 @@ export namespace dataflow_v1b3 { /** * The codec to use for interpreting an element in the input PTable. */ - inputElementCodec?: {[key: string]: any}; + inputElementCodec?: {[key: string]: any} | null; /** * If this instruction includes a combining function this is the name of the intermediate store between the GBK and the CombineValues. */ - originalCombineValuesInputStoreName?: string; + originalCombineValuesInputStoreName?: string | null; /** * If this instruction includes a combining function, this is the name of the CombineValues instruction lifted into this instruction. */ - originalCombineValuesStepName?: string; + originalCombineValuesStepName?: string | null; /** * Zero or more side inputs. */ @@ -1589,7 +1589,7 @@ export namespace dataflow_v1b3 { /** * The value combining function to invoke. */ - valueCombiningFn?: {[key: string]: any}; + valueCombiningFn?: {[key: string]: any} | null; } /** * A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. @@ -1615,7 +1615,7 @@ export namespace dataflow_v1b3 { /** * Position is a byte offset. */ - byteOffset?: string; + byteOffset?: string | null; /** * CloudPosition is a concat position. */ @@ -1623,19 +1623,19 @@ export namespace dataflow_v1b3 { /** * Position is past all other positions. Also useful for the end position of an unbounded range. */ - end?: boolean; + end?: boolean | null; /** * Position is a string key, ordered lexicographically. */ - key?: string; + key?: string | null; /** * Position is a record index. */ - recordIndex?: string; + recordIndex?: string | null; /** * CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). */ - shufflePosition?: string; + shufflePosition?: string | null; } /** * Metadata for a PubSub connector used by the job. @@ -1644,11 +1644,11 @@ export namespace dataflow_v1b3 { /** * Subscription used in the connection. */ - subscription?: string; + subscription?: string | null; /** * Topic accessed in the connection. */ - topic?: string; + topic?: string | null; } /** * Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. @@ -1657,31 +1657,31 @@ export namespace dataflow_v1b3 { /** * Indicates whether the pipeline allows late-arriving data. */ - dropLateData?: boolean; + dropLateData?: boolean | null; /** * If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort. */ - idLabel?: string; + idLabel?: string | null; /** * A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/<project-id>/<subscription-name>" */ - subscription?: string; + subscription?: string | null; /** * If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival. */ - timestampLabel?: string; + timestampLabel?: string | null; /** * A pubsub topic, in the form of "pubsub.googleapis.com/topics/<project-id>/<topic-name>" */ - topic?: string; + topic?: string | null; /** * If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation. */ - trackingSubscription?: string; + trackingSubscription?: string | null; /** * If true, then the client has requested to get pubsub attributes. */ - withAttributes?: boolean; + withAttributes?: boolean | null; } /** * An instruction that reads records. Takes no inputs, produces one output. @@ -1699,11 +1699,11 @@ export namespace dataflow_v1b3 { /** * Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack. */ - isInfinite?: boolean; + isInfinite?: boolean | null; /** * Specifies the level of parallelism in case it is finite. */ - value?: number; + value?: number | null; } /** * Request to report the status of WorkItems. @@ -1712,19 +1712,19 @@ export namespace dataflow_v1b3 { /** * The current timestamp at the worker. */ - currentWorkerTime?: string; + currentWorkerTime?: string | null; /** * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. */ - location?: string; + location?: string | null; /** * Untranslated bag-of-bytes WorkProgressUpdateRequest from UnifiedWorker. */ - unifiedWorkerRequest?: {[key: string]: any}; + unifiedWorkerRequest?: {[key: string]: any} | null; /** * The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service believes currently has the lease on the WorkItem, the report will be dropped (with an error response). */ - workerId?: string; + workerId?: string | null; /** * The order is unimportant, except that the order of the WorkItemServiceState messages in the ReportWorkItemStatusResponse corresponds to the order of WorkItemStatus messages here. */ @@ -1737,7 +1737,7 @@ export namespace dataflow_v1b3 { /** * Untranslated bag-of-bytes WorkProgressUpdateResponse for UnifiedWorker. */ - unifiedWorkerResponse?: {[key: string]: any}; + unifiedWorkerResponse?: {[key: string]: any} | null; /** * A set of messages indicating the service-side state for each WorkItem whose status was reported, in the same order as the WorkItemStatus messages in the ReportWorkItemStatusRequest which resulting in this response. */ @@ -1763,51 +1763,55 @@ export namespace dataflow_v1b3 { /** * Additional experiment flags for the job. */ - additionalExperiments?: string[]; + additionalExperiments?: string[] | null; /** * Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. */ - additionalUserLabels?: {[key: string]: string}; + additionalUserLabels?: {[key: string]: string} | null; /** * Whether to bypass the safety checks for the job's temporary directory. Use with caution. */ - bypassTempDirValidation?: boolean; + bypassTempDirValidation?: boolean | null; /** * Optional. Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key> */ - kmsKeyName?: string; + kmsKeyName?: string | null; /** * The machine type to use for the job. Defaults to the value from the template if not specified. */ - machineType?: string; + machineType?: string | null; /** * The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. */ - maxWorkers?: number; + maxWorkers?: number | null; /** * Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */ - network?: string; + network?: string | null; /** * The initial number of Google Compute Engine instnaces for the job. */ - numWorkers?: number; + numWorkers?: number | null; /** * The email address of the service account to run the job as. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; /** * Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". */ - subnetwork?: string; + subnetwork?: string | null; /** * The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */ - tempLocation?: string; + tempLocation?: string | null; + /** + * Optional. Specifies whether worker pools should be started with private IP addresses. False by default. + */ + usePrivateIps?: boolean | null; /** * The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. */ - zone?: string; + zone?: string | null; } /** * The version of the SDK used to run the job. @@ -1816,15 +1820,15 @@ export namespace dataflow_v1b3 { /** * The support status for this SDK version. */ - sdkSupportStatus?: string; + sdkSupportStatus?: string | null; /** * The version of the SDK used to run the job. */ - version?: string; + version?: string | null; /** * A readable string describing the version of the SDK. */ - versionDisplayName?: string; + versionDisplayName?: string | null; } /** * Request to send encoded debug information. @@ -1833,19 +1837,19 @@ export namespace dataflow_v1b3 { /** * The internal component id for which debug information is sent. */ - componentId?: string; + componentId?: string | null; /** * The encoded debug information. */ - data?: string; + data?: string | null; /** * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ - location?: string; + location?: string | null; /** * The worker id, i.e., VM hostname. */ - workerId?: string; + workerId?: string | null; } /** * Response to a send capture request. nothing @@ -1858,7 +1862,7 @@ export namespace dataflow_v1b3 { /** * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job. */ - location?: string; + location?: string | null; /** * The WorkerMessages to send. */ @@ -1884,7 +1888,7 @@ export namespace dataflow_v1b3 { /** * The user-provided name of the SeqDo operation. */ - name?: string; + name?: string | null; /** * Information about each of the outputs. */ @@ -1892,15 +1896,15 @@ export namespace dataflow_v1b3 { /** * System-defined name of the stage containing the SeqDo operation. Unique across the workflow. */ - stageName?: string; + stageName?: string | null; /** * System-defined name of the SeqDo operation. Unique across the workflow. */ - systemName?: string; + systemName?: string | null; /** * The user function to invoke. */ - userFn?: {[key: string]: any}; + userFn?: {[key: string]: any} | null; } /** * Information about an output of a SeqMapTask. @@ -1913,7 +1917,7 @@ export namespace dataflow_v1b3 { /** * The id of the TupleTag the user code will tag the output value by. */ - tag?: string; + tag?: string | null; } /** * A task which consists of a shell command for the worker to execute. @@ -1922,11 +1926,11 @@ export namespace dataflow_v1b3 { /** * The shell command to run. */ - command?: string; + command?: string | null; /** * Exit code for the task. */ - exitCode?: number; + exitCode?: number | null; } /** * Information about a side input of a DoFn or an input of a SeqDoFn. @@ -1935,7 +1939,7 @@ export namespace dataflow_v1b3 { /** * How to interpret the source element(s) as a side input value. */ - kind?: {[key: string]: any}; + kind?: {[key: string]: any} | null; /** * The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required. */ @@ -1943,7 +1947,7 @@ export namespace dataflow_v1b3 { /** * The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo. */ - tag?: string; + tag?: string | null; } /** * A sink that records can be encoded and written to. @@ -1952,11 +1956,11 @@ export namespace dataflow_v1b3 { /** * The codec to use to encode data written to the sink. */ - codec?: {[key: string]: any}; + codec?: {[key: string]: any} | null; /** * The sink to write to, plus its parameters. */ - spec?: {[key: string]: any}; + spec?: {[key: string]: any} | null; } /** * A source that records can be read and decoded from. @@ -1965,15 +1969,15 @@ export namespace dataflow_v1b3 { /** * While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). */ - baseSpecs?: Array<{[key: string]: any}>; + baseSpecs?: Array<{[key: string]: any}> | null; /** * The codec to use to decode data read from the source. */ - codec?: {[key: string]: any}; + codec?: {[key: string]: any} | null; /** * Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. */ - doesNotNeedSplitting?: boolean; + doesNotNeedSplitting?: boolean | null; /** * Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. */ @@ -1981,7 +1985,7 @@ export namespace dataflow_v1b3 { /** * The source to read from, plus its parameters. */ - spec?: {[key: string]: any}; + spec?: {[key: string]: any} | null; } /** * DEPRECATED in favor of DynamicSourceSplit. @@ -2029,15 +2033,15 @@ export namespace dataflow_v1b3 { /** * An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. */ - estimatedSizeBytes?: string; + estimatedSizeBytes?: string | null; /** * Specifies that the size of this source is known to be infinite (this is a streaming source). */ - infinite?: boolean; + infinite?: boolean | null; /** * Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. */ - producesSortedKeys?: boolean; + producesSortedKeys?: boolean | null; } /** * A work item that represents the different operations that can be performed on a user-defined Source specification. @@ -2050,11 +2054,11 @@ export namespace dataflow_v1b3 { /** * User-provided name of the Read instruction for this source. */ - name?: string; + name?: string | null; /** * System-defined name for the Read instruction for this source in the original workflow graph. */ - originalName?: string; + originalName?: string | null; /** * Information about a request to split a source. */ @@ -2062,11 +2066,11 @@ export namespace dataflow_v1b3 { /** * System-defined name of the stage containing the source operation. Unique across the workflow. */ - stageName?: string; + stageName?: string | null; /** * System-defined name of the Read instruction for this source. Unique across the workflow. */ - systemName?: string; + systemName?: string | null; } /** * The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed. @@ -2088,11 +2092,11 @@ export namespace dataflow_v1b3 { /** * The source should be split into a set of bundles where the estimated size of each is approximately this many bytes. */ - desiredBundleSizeBytes?: string; + desiredBundleSizeBytes?: string | null; /** * DEPRECATED in favor of desired_bundle_size_bytes. */ - desiredShardSizeBytes?: string; + desiredShardSizeBytes?: string | null; } /** * Represents the operation to split a high-level Source specification into bundles (parts for parallel processing). At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used "as is". Otherwise, splitting is applied recursively to each produced DerivedSource. As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it. @@ -2118,7 +2122,7 @@ export namespace dataflow_v1b3 { /** * Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" without splitting. "bundles" is ignored in this case. If this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the source was split. */ - outcome?: string; + outcome?: string | null; /** * DEPRECATED in favor of bundles. */ @@ -2131,7 +2135,7 @@ export namespace dataflow_v1b3 { /** * DEPRECATED */ - derivationMode?: string; + derivationMode?: string | null; /** * DEPRECATED */ @@ -2144,15 +2148,15 @@ export namespace dataflow_v1b3 { /** * DatabaseId accessed in the connection. */ - databaseId?: string; + databaseId?: string | null; /** * InstanceId accessed in the connection. */ - instanceId?: string; + instanceId?: string | null; /** * ProjectId accessed in the connection. */ - projectId?: string; + projectId?: string | null; } /** * A representation of an int64, n, that is immune to precision loss when encoded in JSON. @@ -2161,11 +2165,11 @@ export namespace dataflow_v1b3 { /** * The high order bits, including the sign: n >> 32. */ - highBits?: number; + highBits?: number | null; /** * The low order bits: n & 0xffffffff. */ - lowBits?: number; + lowBits?: number | null; } /** * Description of an input or output of an execution stage. @@ -2174,19 +2178,19 @@ export namespace dataflow_v1b3 { /** * Dataflow service generated name for this source. */ - name?: string; + name?: string | null; /** * User name for the original user transform or collection with which this source is most closely associated. */ - originalTransformOrCollection?: string; + originalTransformOrCollection?: string | null; /** * Size of the source, if measurable. */ - sizeBytes?: string; + sizeBytes?: string | null; /** * Human-readable name for this source; may be user or system generated. */ - userName?: string; + userName?: string | null; } /** * State family configuration. @@ -2195,11 +2199,11 @@ export namespace dataflow_v1b3 { /** * If true, this family corresponds to a read operation. */ - isRead?: boolean; + isRead?: boolean | null; /** * The state family value. */ - stateFamily?: string; + stateFamily?: 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). @@ -2208,15 +2212,15 @@ export namespace dataflow_v1b3 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Defines a particular step within a Cloud Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce. @@ -2225,15 +2229,15 @@ export namespace dataflow_v1b3 { /** * The kind of step in the Cloud Dataflow job. */ - kind?: string; + kind?: string | null; /** * The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job. */ - name?: string; + name?: string | null; /** * Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL. */ - properties?: {[key: string]: any}; + properties?: {[key: string]: any} | null; } /** * Streaming appliance snapshot configuration. @@ -2242,11 +2246,11 @@ export namespace dataflow_v1b3 { /** * Indicates which endpoint is used to import appliance state. */ - importStateEndpoint?: string; + importStateEndpoint?: string | null; /** * If set, indicates the snapshot id for the snapshot being performed. */ - snapshotId?: string; + snapshotId?: string | null; } /** * Configuration information for a single streaming computation. @@ -2255,7 +2259,7 @@ export namespace dataflow_v1b3 { /** * Unique identifier for this computation. */ - computationId?: string; + computationId?: string | null; /** * Instructions that comprise the computation. */ @@ -2263,15 +2267,15 @@ export namespace dataflow_v1b3 { /** * Stage name of this computation. */ - stageName?: string; + stageName?: string | null; /** * System defined name for this computation. */ - systemName?: string; + systemName?: string | null; /** * Map from user name of stateful transforms in this stage to their state family. */ - transformUserNameToStateFamily?: {[key: string]: string}; + transformUserNameToStateFamily?: {[key: string]: string} | null; } /** * Describes full or partial data disk assignment information of the computation ranges. @@ -2280,7 +2284,7 @@ export namespace dataflow_v1b3 { /** * The ID of the computation. */ - computationId?: string; + computationId?: string | null; /** * Data disk assignments for ranges from this computation. */ @@ -2301,16 +2305,24 @@ export namespace dataflow_v1b3 { /** * A type of streaming computation task. */ - taskType?: string; + taskType?: string | null; } /** * A task that carries configuration information for streaming computations. */ export interface Schema$StreamingConfigTask { + /** + * Chunk size for commit streams from the harness to windmill. + */ + commitStreamChunkSizeBytes?: string | null; + /** + * Chunk size for get data streams from the harness to windmill. + */ + getDataStreamChunkSizeBytes?: string | null; /** * Maximum size for work item commit supported windmill storage layer. */ - maxWorkItemCommitBytes?: string; + maxWorkItemCommitBytes?: string | null; /** * Set of computation configuration information. */ @@ -2318,15 +2330,15 @@ export namespace dataflow_v1b3 { /** * Map from user step names to state families. */ - userStepToStateFamilyNameMap?: {[key: string]: string}; + userStepToStateFamilyNameMap?: {[key: string]: string} | null; /** * If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using. */ - windmillServiceEndpoint?: string; + windmillServiceEndpoint?: string | null; /** * If present, the worker must use this port to communicate with Windmill Service dispatchers. Only applicable when windmill_service_endpoint is specified. */ - windmillServicePort?: string; + windmillServicePort?: string | null; } /** * A task which initializes part of a streaming Dataflow job. @@ -2335,11 +2347,11 @@ export namespace dataflow_v1b3 { /** * The user has requested drain. */ - drain?: boolean; + drain?: boolean | null; /** * The TCP port on which the worker should listen for messages from other streaming computation workers. */ - receiveWorkPort?: number; + receiveWorkPort?: number | null; /** * Configures streaming appliance snapshot. */ @@ -2351,7 +2363,7 @@ export namespace dataflow_v1b3 { /** * The TCP port used by the worker to communicate with the Dataflow worker harness. */ - workerHarnessPort?: number; + workerHarnessPort?: number | null; } /** * Identifies the location of a streaming side input. @@ -2360,11 +2372,11 @@ export namespace dataflow_v1b3 { /** * Identifies the state family where this side input is stored. */ - stateFamily?: string; + stateFamily?: string | null; /** * Identifies the particular side input within the streaming Dataflow job. */ - tag?: string; + tag?: string | null; } /** * Identifies the location of a streaming computation stage, for stage-to-stage communication. @@ -2373,7 +2385,7 @@ export namespace dataflow_v1b3 { /** * Identifies the particular stream within the streaming Dataflow job. */ - streamId?: string; + streamId?: string | null; } /** * Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job. @@ -2403,7 +2415,7 @@ export namespace dataflow_v1b3 { /** * Elements of the list. */ - elements?: string[]; + elements?: string[] | null; } /** * A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption. @@ -2412,11 +2424,11 @@ export namespace dataflow_v1b3 { /** * Identifier for this message type. Used by external systems to internationalize or personalize message. */ - messageKey?: string; + messageKey?: string | null; /** * Human-readable version of message. */ - messageText?: string; + messageText?: string | null; /** * The structured data associated with this message. */ @@ -2429,51 +2441,51 @@ export namespace dataflow_v1b3 { /** * Whether to also send taskrunner log info to stderr. */ - alsologtostderr?: boolean; + alsologtostderr?: boolean | null; /** * The location on the worker for task-specific subdirectories. */ - baseTaskDir?: string; + baseTaskDir?: string | null; /** * The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" */ - baseUrl?: string; + baseUrl?: string | null; /** * The file to store preprocessing commands in. */ - commandlinesFileName?: string; + commandlinesFileName?: string | null; /** * Whether to continue taskrunner if an exception is hit. */ - continueOnException?: boolean; + continueOnException?: boolean | null; /** * The API version of endpoint, e.g. "v1b3" */ - dataflowApiVersion?: string; + dataflowApiVersion?: string | null; /** * The command to launch the worker harness. */ - harnessCommand?: string; + harnessCommand?: string | null; /** * The suggested backend language. */ - languageHint?: string; + languageHint?: string | null; /** * The directory on the VM to store logs. */ - logDir?: string; + logDir?: string | null; /** * Whether to send taskrunner log info to Google Compute Engine VM serial console. */ - logToSerialconsole?: boolean; + logToSerialconsole?: boolean | null; /** * Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ - logUploadLocation?: string; + logUploadLocation?: string | null; /** * The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. */ - oauthScopes?: string[]; + oauthScopes?: string[] | null; /** * The settings to pass to the parallel worker harness. */ @@ -2481,27 +2493,27 @@ export namespace dataflow_v1b3 { /** * The streaming worker main class name. */ - streamingWorkerMainClass?: string; + streamingWorkerMainClass?: string | null; /** * The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". */ - taskGroup?: string; + taskGroup?: string | null; /** * The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". */ - taskUser?: string; + taskUser?: string | null; /** * The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ - tempStoragePrefix?: string; + tempStoragePrefix?: string | null; /** * The ID string of the VM. */ - vmId?: string; + vmId?: string | null; /** * The file to store the workflow in. */ - workflowFileName?: string; + workflowFileName?: string | null; } /** * Metadata describing a template. @@ -2510,11 +2522,11 @@ export namespace dataflow_v1b3 { /** * Optional. A description of the template. */ - description?: string; + description?: string | null; /** * Required. The name of the template. */ - name?: string; + name?: string | null; /** * The parameters for the template. */ @@ -2535,15 +2547,15 @@ export namespace dataflow_v1b3 { /** * The size (in bits) of keys that will be assigned to source messages. */ - forwardingKeyBits?: number; + forwardingKeyBits?: number | null; /** * Version number for persistent state. */ - persistentStateVersion?: number; + persistentStateVersion?: number | null; /** * Maps user stage names to stable computation names. */ - userStageToComputationNameMap?: {[key: string]: string}; + userStageToComputationNameMap?: {[key: string]: string} | null; } /** * Description of the type, names/ids, and input/outputs for a transform. @@ -2556,23 +2568,23 @@ export namespace dataflow_v1b3 { /** * SDK generated id of this transform instance. */ - id?: string; + id?: string | null; /** * User names for all collection inputs to this transform. */ - inputCollectionName?: string[]; + inputCollectionName?: string[] | null; /** * Type of transform. */ - kind?: string; + kind?: string | null; /** * User provided name for this transform instance. */ - name?: string; + name?: string | null; /** * User names for all collection outputs to this transform. */ - outputCollectionName?: string[]; + outputCollectionName?: string[] | null; } /** * Response to the validation request. @@ -2581,7 +2593,7 @@ export namespace dataflow_v1b3 { /** * Will be empty if validation succeeds. */ - errorMessage?: string; + errorMessage?: string | null; } /** * WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. @@ -2590,27 +2602,27 @@ export namespace dataflow_v1b3 { /** * A message describing any unusual health reports. */ - msg?: string; + msg?: string | null; /** * The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod This field is used by the worker to send the status of the indvidual containers running on each worker. */ - pods?: Array<{[key: string]: any}>; + pods?: Array<{[key: string]: any}> | null; /** * The interval at which the worker is sending health reports. The default value of 0 should be interpreted as the field is not being explicitly set by the worker. */ - reportInterval?: string; + reportInterval?: string | null; /** * Whether the VM is in a permanently broken state. Broken VMs should be abandoned or deleted ASAP to avoid assigning or completing any work. */ - vmIsBroken?: boolean; + vmIsBroken?: boolean | null; /** * Whether the VM is currently healthy. */ - vmIsHealthy?: boolean; + vmIsHealthy?: boolean | null; /** * The time the VM was booted. */ - vmStartupTime?: string; + vmStartupTime?: string | null; } /** * WorkerHealthReportResponse contains information returned to the worker in response to a health ping. @@ -2619,7 +2631,7 @@ export namespace dataflow_v1b3 { /** * A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server. */ - reportInterval?: string; + reportInterval?: string | null; } /** * A report of an event in a worker's lifecycle. The proto contains one event, because the worker is expected to asynchronously send each message immediately after the event. Due to this asynchrony, messages may arrive out of order (or missing), and it is up to the consumer to interpret. The timestamp of the event is in the enclosing WorkerMessage proto. @@ -2628,15 +2640,15 @@ export namespace dataflow_v1b3 { /** * The start time of this container. All events will report this so that events can be grouped together across container/VM restarts. */ - containerStartTime?: string; + containerStartTime?: string | null; /** * The event being reported. */ - event?: string; + event?: string | null; /** * Other stats that can accompany an event. E.g. { "downloaded_bytes" : "123456" } */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; } /** * WorkerMessage provides information to the backend about a worker. @@ -2645,11 +2657,11 @@ export namespace dataflow_v1b3 { /** * Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The timestamp of the worker_message. */ - time?: string; + time?: string | null; /** * The health of a worker. */ @@ -2678,11 +2690,11 @@ export namespace dataflow_v1b3 { /** * The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a GCS file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change. */ - code?: string; + code?: string | null; /** * Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; } /** * A worker_message response allows the server to pass information to the sender. @@ -2716,51 +2728,51 @@ export namespace dataflow_v1b3 { /** * The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. */ - defaultPackageSet?: string; + defaultPackageSet?: string | null; /** * Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. */ - diskSizeGb?: number; + diskSizeGb?: number | null; /** * Fully qualified source image for disks. */ - diskSourceImage?: string; + diskSourceImage?: string | null; /** * Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. */ - diskType?: string; + diskType?: string | null; /** * Configuration for VM IPs. */ - ipConfiguration?: string; + ipConfiguration?: string | null; /** * The kind of the worker pool; currently only `harness` and `shuffle` are supported. */ - kind?: string; + kind?: string | null; /** * Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. */ - machineType?: string; + machineType?: string | null; /** * Metadata to set on the Google Compute Engine VMs. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */ - network?: string; + network?: string | null; /** * The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming). */ - numThreadsPerWorker?: number; + numThreadsPerWorker?: number | null; /** * Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. */ - numWorkers?: number; + numWorkers?: number | null; /** * The action to take on host maintenance, as defined by the Google Compute Engine API. */ - onHostMaintenance?: string; + onHostMaintenance?: string | null; /** * Packages to be installed on workers. */ @@ -2768,11 +2780,11 @@ export namespace dataflow_v1b3 { /** * Extra arguments for this worker pool. */ - poolArgs?: {[key: string]: any}; + poolArgs?: {[key: string]: any} | null; /** * Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". */ - subnetwork?: string; + subnetwork?: string | null; /** * Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. */ @@ -2780,15 +2792,15 @@ export namespace dataflow_v1b3 { /** * Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. */ - teardownPolicy?: string; + teardownPolicy?: string | null; /** * Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. */ - workerHarnessContainerImage?: string; + workerHarnessContainerImage?: string | null; /** * Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. */ - zone?: string; + zone?: string | null; } /** * Provides data to pass through to the worker harness. @@ -2797,27 +2809,27 @@ export namespace dataflow_v1b3 { /** * The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" */ - baseUrl?: string; + baseUrl?: string | null; /** * Whether to send work progress updates to the service. */ - reportingEnabled?: boolean; + reportingEnabled?: boolean | null; /** * The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". */ - servicePath?: string; + servicePath?: string | null; /** * The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". */ - shuffleServicePath?: string; + shuffleServicePath?: string | null; /** * The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ - tempStoragePrefix?: string; + tempStoragePrefix?: string | null; /** * The ID of the worker running this pipeline. */ - workerId?: string; + workerId?: string | null; } /** * Shutdown notification from workers. This is to be sent by the shutdown script of the worker VM so that the backend knows that the VM is being shut down. @@ -2826,7 +2838,7 @@ export namespace dataflow_v1b3 { /** * The reason for the worker shutdown. Current possible values are: "UNKNOWN": shutdown reason is unknown. "PREEMPTION": shutdown reason is preemption. Other possible reasons may be added in the future. */ - reason?: string; + reason?: string | null; } /** * Service-side response to WorkerMessage issuing shutdown notice. @@ -2839,23 +2851,23 @@ export namespace dataflow_v1b3 { /** * Work item-specific configuration as an opaque blob. */ - configuration?: string; + configuration?: string | null; /** * Identifies this WorkItem. */ - id?: string; + id?: string | null; /** * The initial index to use when reporting the status of the WorkItem. */ - initialReportIndex?: string; + initialReportIndex?: string | null; /** * Identifies the workflow job this WorkItem belongs to. */ - jobId?: string; + jobId?: string | null; /** * Time when the lease on this Work will expire. */ - leaseExpireTime?: string; + leaseExpireTime?: string | null; /** * Additional information for MapTask WorkItems. */ @@ -2867,11 +2879,11 @@ export namespace dataflow_v1b3 { /** * Identifies the cloud project this WorkItem belongs to. */ - projectId?: string; + projectId?: string | null; /** * Recommended reporting interval. */ - reportStatusInterval?: string; + reportStatusInterval?: string | null; /** * Additional information for SeqMapTask WorkItems. */ @@ -2904,7 +2916,7 @@ export namespace dataflow_v1b3 { /** * Other data returned by the service, specific to the particular worker harness. */ - harnessData?: {[key: string]: any}; + harnessData?: {[key: string]: any} | null; /** * A hot key is a symptom of poor data distribution in which there are enough elements mapped to a single key to impact pipeline performance. When present, this field includes metadata associated with any hot key. */ @@ -2912,7 +2924,7 @@ export namespace dataflow_v1b3 { /** * Time at which the current lease will expire. */ - leaseExpireTime?: string; + leaseExpireTime?: string | null; /** * The short ids that workers should use in subsequent metric updates. Workers should strive to use short ids whenever possible, but it is ok to request the short_id again if a worker lost track of it (e.g. if the worker is recovering from a crash). NOTE: it is possible that the response may have short ids for a subset of the metrics. */ @@ -2920,11 +2932,11 @@ export namespace dataflow_v1b3 { /** * The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts. */ - nextReportIndex?: string; + nextReportIndex?: string | null; /** * New recommended reporting interval. */ - reportStatusInterval?: string; + reportStatusInterval?: string | null; /** * The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task. */ @@ -2945,7 +2957,7 @@ export namespace dataflow_v1b3 { /** * True if the WorkItem was completed (successfully or unsuccessfully). */ - completed?: boolean; + completed?: boolean | null; /** * Worker output counters for this WorkItem. */ @@ -2973,11 +2985,11 @@ export namespace dataflow_v1b3 { /** * The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service. */ - reportIndex?: string; + reportIndex?: string | null; /** * Amount of time the worker requests for its lease. */ - requestedLeaseDuration?: string; + requestedLeaseDuration?: string | null; /** * DEPRECATED in favor of dynamic_source_split. */ @@ -2993,11 +3005,11 @@ export namespace dataflow_v1b3 { /** * Total time the worker spent being throttled by external systems. */ - totalThrottlerWaitTimeSeconds?: number; + totalThrottlerWaitTimeSeconds?: number | null; /** * Identifies the WorkItem. */ - workItemId?: string; + workItemId?: string | null; } /** * An instruction that writes records. Takes one input, produces no outputs. diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index 0b9a5c96062..d3f21fb7c81 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -125,11 +125,11 @@ export namespace datafusion_v1beta1 { * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ - service?: string; + 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. @@ -138,11 +138,11 @@ export namespace datafusion_v1beta1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Authorization-related information used by Cloud Audit Logging. @@ -151,7 +151,7 @@ export namespace datafusion_v1beta1 { /** * The type of the permission that was checked. */ - permissionType?: string; + permissionType?: string | null; } /** * Associates `members` with a `role`. @@ -164,11 +164,11 @@ export namespace datafusion_v1beta1 { /** * 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`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * The request message for Operations.CancelOperation. @@ -185,7 +185,7 @@ export namespace datafusion_v1beta1 { /** * The log_name to populate in the Cloud Audit Record. */ - logName?: string; + logName?: string | null; } /** * A condition to be met. @@ -194,23 +194,23 @@ export namespace datafusion_v1beta1 { /** * Trusted attributes supplied by the IAM system. */ - iam?: string; + iam?: string | null; /** * An operator to apply the subject with. */ - op?: string; + op?: string | null; /** * Trusted attributes discharged by the service. */ - svc?: string; + svc?: string | null; /** * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ - sys?: string; + sys?: string | null; /** * The objects of the condition. */ - values?: string[]; + values?: string[] | null; } /** * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). @@ -219,11 +219,11 @@ export namespace datafusion_v1beta1 { /** * The field value to attribute. */ - field?: string; + field?: string | null; /** * The metric to update. */ - metric?: string; + metric?: string | null; } /** * Write a Data Access (Gin) log @@ -232,7 +232,7 @@ export namespace datafusion_v1beta1 { /** * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. */ - logMode?: string; + logMode?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -245,19 +245,19 @@ export namespace datafusion_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Represents a Data Fusion instance. @@ -266,31 +266,31 @@ export namespace datafusion_v1beta1 { /** * Output only. The time the instance was created. */ - createTime?: string; + createTime?: string | null; /** * An optional description of this instance. */ - description?: string; + description?: string | null; /** * Display name for an instance. */ - displayName?: string; + displayName?: string | null; /** * Option to enable Stackdriver Logging. */ - enableStackdriverLogging?: boolean; + enableStackdriverLogging?: boolean | null; /** * Option to enable Stackdriver Monitoring. */ - enableStackdriverMonitoring?: boolean; + enableStackdriverMonitoring?: boolean | null; /** * The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. */ - name?: string; + name?: string | null; /** * Network configuration options. These are required when a private Data Fusion instance is to be created. */ @@ -298,43 +298,43 @@ export namespace datafusion_v1beta1 { /** * Map of additional options used to configure the behavior of Data Fusion instance. */ - options?: {[key: string]: string}; + options?: {[key: string]: string} | null; /** * Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. */ - privateInstance?: boolean; + privateInstance?: boolean | null; /** * Output only. Service account which will be used to access resources in the customer project." */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Output only. Endpoint on which the Data Fusion UI and REST APIs are accessible. */ - serviceEndpoint?: string; + serviceEndpoint?: string | null; /** * Output only. The current state of this Data Fusion instance. */ - state?: string; + state?: string | null; /** * Output only. Additional information about the current state of this Data Fusion instance if available. */ - stateMessage?: string; + stateMessage?: string | null; /** * Required. Instance type. */ - type?: string; + type?: string | null; /** * Output only. The time the instance was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. Current version of the Data Fusion. */ - version?: string; + version?: string | null; /** * Name of the zone in which the Data Fusion instance will be created. */ - zone?: string; + zone?: string | null; } /** * Response message for the list instance request. @@ -347,11 +347,11 @@ export namespace datafusion_v1beta1 { /** * Token to retrieve the next page of results or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -364,7 +364,7 @@ export namespace datafusion_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -373,7 +373,7 @@ export namespace datafusion_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -386,23 +386,23 @@ export namespace datafusion_v1beta1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Specifies what kind of log the caller must write @@ -428,11 +428,11 @@ export namespace datafusion_v1beta1 { /** * The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network. */ - ipAllocation?: string; + ipAllocation?: string | null; /** * Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. */ - network?: string; + network?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -441,7 +441,7 @@ export namespace datafusion_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -449,15 +449,15 @@ export namespace datafusion_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Represents the metadata of a long-running operation. @@ -466,31 +466,31 @@ export namespace datafusion_v1beta1 { /** * API version used to start the operation. */ - apiVersion?: string; + apiVersion?: string | null; /** * The time the operation was created. */ - createTime?: string; + createTime?: string | null; /** * The time the operation finished running. */ - endTime?: string; + endTime?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ - requestedCancellation?: boolean; + requestedCancellation?: boolean | null; /** * Human-readable status of the operation if any. */ - statusDetail?: string; + statusDetail?: string | null; /** * Server-defined resource path for the target of the operation. */ - target?: string; + target?: string | null; /** * Name of the verb executed by the operation. */ - verb?: string; + verb?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -507,8 +507,8 @@ export namespace datafusion_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ - etag?: string; - iamOwned?: boolean; + etag?: string | null; + iamOwned?: boolean | null; /** * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ @@ -516,7 +516,7 @@ export namespace datafusion_v1beta1 { /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Request message for restarting a Data Fusion instance. @@ -529,7 +529,7 @@ export namespace datafusion_v1beta1 { /** * Required */ - action?: string; + action?: string | null; /** * Additional restrictions that must be met. All conditions must pass for the rule to match. */ @@ -537,11 +537,11 @@ export namespace datafusion_v1beta1 { /** * Human-readable description of the rule. */ - description?: string; + description?: string | null; /** * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ - in?: string[]; + in?: string[] | null; /** * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ @@ -549,11 +549,11 @@ export namespace datafusion_v1beta1 { /** * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries can be found at in the Local IAM documentation (see go/local-iam#features). */ - notIn?: string[]; + notIn?: string[] | null; /** * A permission is a string of form '<service>.<resource type>.<verb>' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Request message for `SetIamPolicy` method. @@ -566,7 +566,7 @@ export namespace datafusion_v1beta1 { /** * 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; + updateMask?: 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). @@ -575,15 +575,15 @@ export namespace datafusion_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -592,7 +592,7 @@ export namespace datafusion_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -601,7 +601,7 @@ export namespace datafusion_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Request message for upgrading a Data Fusion instance. To change the instance properties, instance update should be used. diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 2807391916e..6946d090b4a 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -124,11 +124,80 @@ export namespace dataproc_v1 { /** * The number of the accelerator cards of this type exposed to this instance. */ - acceleratorCount?: number; + 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. */ - acceleratorTypeUri?: string; + acceleratorTypeUri?: string | null; + } + /** + * Autoscaling Policy config associated with the cluster. + */ + 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. + */ + policyUri?: string | null; + } + /** + * Describes an autoscaling policy for Dataproc cluster autoscaler. + */ + export interface Schema$AutoscalingPolicy { + basicAlgorithm?: Schema$BasicAutoscalingAlgorithm; + /** + * Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. + */ + id?: string | null; + /** + * Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + */ + name?: string | null; + /** + * Optional. Describes how the autoscaler will operate for secondary workers. + */ + secondaryWorkerConfig?: Schema$InstanceGroupAutoscalingPolicyConfig; + /** + * Required. Describes how the autoscaler will operate for primary workers. + */ + workerConfig?: Schema$InstanceGroupAutoscalingPolicyConfig; + } + /** + * Basic algorithm for autoscaling. + */ + export interface Schema$BasicAutoscalingAlgorithm { + /** + * Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m. + */ + cooldownPeriod?: string | null; + /** + * Required. YARN autoscaling configuration. + */ + yarnConfig?: Schema$BasicYarnAutoscalingConfig; + } + /** + * Basic autoscaling configurations for YARN. + */ + export interface Schema$BasicYarnAutoscalingConfig { + /** + * Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d. + */ + gracefulDecommissionTimeout?: string | null; + /** + * Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0. + */ + scaleDownFactor?: number | null; + /** + * Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0. + */ + scaleDownMinWorkerFraction?: number | null; + /** + * Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0. + */ + scaleUpFactor?: number | null; + /** + * Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0. + */ + scaleUpMinWorkerFraction?: number | null; } /** * Associates members with a role. @@ -141,11 +210,11 @@ export namespace dataproc_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. */ - role?: string; + role?: string | null; } /** * A request to cancel a job. @@ -158,11 +227,11 @@ export namespace dataproc_v1 { /** * Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster. */ - clusterUuid?: string; + clusterUuid?: string | null; /** * Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated. */ @@ -170,7 +239,7 @@ export namespace dataproc_v1 { /** * Optional. The labels to associate with this cluster. 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 cluster. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ @@ -178,7 +247,7 @@ export namespace dataproc_v1 { /** * Required. The Google Cloud Platform project ID that the cluster belongs to. */ - projectId?: string; + projectId?: string | null; /** * Output only. Cluster status. */ @@ -192,10 +261,14 @@ export namespace dataproc_v1 { * The cluster config. */ export interface Schema$ClusterConfig { + /** + * Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset. + */ + 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). */ - configBucket?: string; + configBucket?: string | null; /** * Optional. Encryption settings for the cluster. */ @@ -240,11 +313,11 @@ export namespace dataproc_v1 { /** * The HDFS metrics. */ - hdfsMetrics?: {[key: string]: string}; + hdfsMetrics?: {[key: string]: string} | null; /** * The YARN metrics. */ - yarnMetrics?: {[key: string]: string}; + yarnMetrics?: {[key: string]: string} | null; } /** * The cluster operation triggered by a workflow. @@ -253,15 +326,15 @@ export namespace dataproc_v1 { /** * Output only. Indicates the operation is done. */ - done?: boolean; + done?: boolean | null; /** * Output only. Error, if operation failed. */ - error?: string; + error?: string | null; /** * Output only. The id of the cluster operation. */ - operationId?: string; + operationId?: string | null; } /** * Metadata describing the operation. @@ -270,23 +343,23 @@ export namespace dataproc_v1 { /** * Output only. Name of the cluster for the operation. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. Cluster UUID for the operation. */ - clusterUuid?: string; + clusterUuid?: string | null; /** * Output only. Short description of operation. */ - description?: string; + description?: string | null; /** * Output only. Labels associated with the operation */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The operation type. */ - operationType?: string; + operationType?: string | null; /** * Output only. Current operation status. */ @@ -298,7 +371,7 @@ export namespace dataproc_v1 { /** * Output only. Errors encountered during operation execution. */ - warnings?: string[]; + warnings?: string[] | null; } /** * The status of the operation. @@ -307,19 +380,19 @@ export namespace dataproc_v1 { /** * Output only. A message containing any operation metadata details. */ - details?: string; + details?: string | null; /** * Output only. A message containing the detailed operation state. */ - innerState?: string; + innerState?: string | null; /** * Output only. A message containing the operation state. */ - state?: string; + state?: string | null; /** * Output only. The time this state was entered. */ - stateStartTime?: string; + stateStartTime?: string | null; } /** * A selector that chooses target cluster for jobs based on metadata. @@ -328,11 +401,11 @@ export namespace dataproc_v1 { /** * Required. The cluster labels. Cluster must have all labels to match. */ - clusterLabels?: {[key: string]: string}; + clusterLabels?: {[key: string]: string} | null; /** * Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used. */ - zone?: string; + zone?: string | null; } /** * The status of a cluster and its instances. @@ -341,19 +414,19 @@ export namespace dataproc_v1 { /** * Output only. Optional details of cluster's state. */ - detail?: string; + detail?: string | null; /** * Output only. The cluster's state. */ - state?: string; + state?: string | null; /** * Output only. Time when this state was entered. */ - stateStartTime?: string; + stateStartTime?: string | null; /** * Output only. Additional state information that includes status reported by the agent. */ - substate?: string; + substate?: string | null; } /** * A request to collect cluster diagnostic information. @@ -366,7 +439,7 @@ export namespace dataproc_v1 { /** * Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics. */ - outputUri?: string; + outputUri?: string | null; } /** * Specifies the config of disk options for a group of VM instances. @@ -375,15 +448,15 @@ export namespace dataproc_v1 { /** * Optional. Size in GB of the boot disk (default is 500GB). */ - bootDiskSizeGb?: number; + bootDiskSizeGb?: number | null; /** * Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). */ - bootDiskType?: string; + bootDiskType?: string | null; /** * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries. */ - numLocalSsds?: number; + numLocalSsds?: number | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. @@ -396,7 +469,7 @@ export namespace dataproc_v1 { /** * Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster. */ - gcePdKmsKeyName?: string; + gcePdKmsKeyName?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -405,19 +478,19 @@ export namespace dataproc_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. @@ -426,35 +499,35 @@ export namespace dataproc_v1 { /** * Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses. */ - internalIpOnly?: boolean; + internalIpOnly?: boolean | null; /** * The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default projects/[project_id]/regions/global/default default */ - networkUri?: string; + 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 */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control */ - serviceAccountScopes?: string[]; + serviceAccountScopes?: string[] | null; /** * Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0 sub0 */ - subnetworkUri?: string; + subnetworkUri?: string | null; /** * The Compute Engine tags to add to all instances (see Tagging instances). */ - tags?: string[]; + 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 */ - zoneUri?: string; + zoneUri?: string | null; } /** * Request message for GetIamPolicy method. @@ -470,9 +543,9 @@ export namespace dataproc_v1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + 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). @@ -481,19 +554,19 @@ export namespace dataproc_v1 { /** * Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip. */ - archiveUris?: string[]; + archiveUris?: string[] | null; /** * Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ - args?: string[]; + args?: string[] | null; /** * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. */ - fileUris?: string[]; + fileUris?: string[] | null; /** * Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -501,15 +574,15 @@ export namespace dataproc_v1 { /** * The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris. */ - mainClass?: string; + mainClass?: string | null; /** * The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' */ - mainJarFileUri?: string; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; } /** * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. @@ -518,19 +591,19 @@ export namespace dataproc_v1 { /** * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ - continueOnFailure?: boolean; + continueOnFailure?: boolean | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. */ - jarFileUris?: string[]; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The HCFS URI of the script that contains Hive queries. */ - queryFileUri?: string; + queryFileUri?: string | null; /** * A list of queries. */ @@ -538,7 +611,24 @@ export namespace dataproc_v1 { /** * Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). */ - scriptVariables?: {[key: string]: string}; + scriptVariables?: {[key: string]: string} | null; + } + /** + * Configuration for the size bounds of an instance group, including its proportional size to other groups. + */ + export interface Schema$InstanceGroupAutoscalingPolicyConfig { + /** + * Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0. + */ + maxInstances?: number | null; + /** + * Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0. + */ + minInstances?: number | null; + /** + * Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers. + */ + weight?: number | null; } /** * Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. @@ -555,19 +645,19 @@ export namespace dataproc_v1 { /** * Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version. */ - imageUri?: string; + imageUri?: string | null; /** * Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group. */ - instanceNames?: string[]; + instanceNames?: string[] | null; /** * Optional. Specifies that this instance group contains preemptible instances. */ - isPreemptible?: boolean; + 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. */ - machineTypeUri?: string; + machineTypeUri?: string | null; /** * Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups. */ @@ -575,7 +665,7 @@ export namespace dataproc_v1 { /** * Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1. */ - numInstances?: number; + numInstances?: number | null; } /** * A request to instantiate a workflow template. @@ -584,15 +674,15 @@ export namespace dataproc_v1 { /** * Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters. */ - parameters?: {[key: string]: string}; + parameters?: {[key: string]: string} | null; /** * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ - requestId?: string; + requestId?: string | null; /** * Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template. */ - version?: number; + version?: number | null; } /** * A Cloud Dataproc job resource. @@ -601,11 +691,11 @@ export namespace dataproc_v1 { /** * Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. */ - driverControlFilesUri?: string; + driverControlFilesUri?: string | null; /** * Output only. A URI pointing to the location of the stdout of the job's driver program. */ - driverOutputResourceUri?: string; + driverOutputResourceUri?: string | null; /** * Job is a Hadoop job. */ @@ -617,11 +707,11 @@ export namespace dataproc_v1 { /** * 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. */ - jobUuid?: string; + jobUuid?: string | null; /** * 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}; + labels?: {[key: string]: string} | null; /** * Job is a Pig job. */ @@ -670,11 +760,11 @@ export namespace dataproc_v1 { /** * Required. The name of the cluster where the job will be submitted. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. */ - clusterUuid?: string; + clusterUuid?: string | null; } /** * Encapsulates the full scoping used to reference a job. @@ -683,11 +773,11 @@ export namespace dataproc_v1 { /** * 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; + jobId?: string | null; /** * Required. The ID of the Google Cloud Platform project that the job belongs to. */ - projectId?: string; + projectId?: string | null; } /** * Job scheduling options. @@ -696,7 +786,7 @@ export namespace dataproc_v1 { /** * Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. */ - maxFailuresPerHour?: number; + maxFailuresPerHour?: number | null; } /** * Cloud Dataproc job status. @@ -705,19 +795,19 @@ export namespace dataproc_v1 { /** * Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. */ - details?: string; + details?: string | null; /** * Output only. A state message specifying the overall job state. */ - state?: string; + state?: string | null; /** * Output only. The time when this state was entered. */ - stateStartTime?: string; + stateStartTime?: string | null; /** * Output only. Additional state information, which includes status reported by the agent. */ - substate?: string; + substate?: string | null; } /** * Specifies Kerberos related configuration. @@ -726,63 +816,63 @@ export namespace dataproc_v1 { /** * Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */ - crossRealmTrustAdminServer?: string; + crossRealmTrustAdminServer?: string | null; /** * Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */ - crossRealmTrustKdc?: string; + crossRealmTrustKdc?: string | null; /** * Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust. */ - crossRealmTrustRealm?: string; + crossRealmTrustRealm?: string | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship. */ - crossRealmTrustSharedPasswordUri?: string; + crossRealmTrustSharedPasswordUri?: string | null; /** * Optional. Flag to indicate whether to Kerberize the cluster. */ - enableKerberos?: boolean; + enableKerberos?: boolean | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database. */ - kdcDbKeyUri?: string; + kdcDbKeyUri?: string | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc. */ - keyPasswordUri?: string; + keyPasswordUri?: string | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc. */ - keystorePasswordUri?: string; + keystorePasswordUri?: string | null; /** * Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. */ - keystoreUri?: string; + keystoreUri?: string | null; /** * Required. The uri of the KMS key used to encrypt various sensitive files. */ - kmsKeyUri?: string; + kmsKeyUri?: string | null; /** * Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm. */ - realm?: string; + realm?: string | null; /** * Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password. */ - rootPrincipalPasswordUri?: string; + rootPrincipalPasswordUri?: string | null; /** * Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used. */ - tgtLifetimeHours?: number; + tgtLifetimeHours?: number | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc. */ - truststorePasswordUri?: string; + truststorePasswordUri?: string | null; /** * Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. */ - truststoreUri?: string; + truststoreUri?: string | null; } /** * Specifies the cluster auto-delete schedule configuration. @@ -791,19 +881,32 @@ export namespace dataproc_v1 { /** * Optional. The time when cluster will be auto-deleted. */ - autoDeleteTime?: string; + 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.. */ - autoDeleteTtl?: string; + 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. */ - idleDeleteTtl?: string; + idleDeleteTtl?: string | null; /** * Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness. */ - idleStartTime?: string; + idleStartTime?: string | null; + } + /** + * A response to a request to list autoscaling policies in a project. + */ + export interface Schema$ListAutoscalingPoliciesResponse { + /** + * Output only. This token is included in the response if there are more results to fetch. + */ + nextPageToken?: string | null; + /** + * Output only. Autoscaling policies list. + */ + policies?: Schema$AutoscalingPolicy[]; } /** * The list of all clusters in a project. @@ -816,7 +919,7 @@ export namespace dataproc_v1 { /** * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A list of jobs in a project. @@ -829,7 +932,7 @@ export namespace dataproc_v1 { /** * Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListJobsRequest</code>. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -838,7 +941,7 @@ export namespace dataproc_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -851,7 +954,7 @@ export namespace dataproc_v1 { /** * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListWorkflowTemplatesRequest</code>. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. WorkflowTemplates list. */ @@ -864,7 +967,7 @@ export namespace dataproc_v1 { /** * The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' */ - driverLogLevels?: {[key: string]: string}; + driverLogLevels?: {[key: string]: string} | null; } /** * Cluster that is managed by the workflow. @@ -873,7 +976,7 @@ export namespace dataproc_v1 { /** * Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters. */ - clusterName?: string; + clusterName?: string | null; /** * Required. The cluster configuration. */ @@ -881,7 +984,7 @@ export namespace dataproc_v1 { /** * Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } /** * Specifies the resources used to actively manage an instance group. @@ -890,11 +993,11 @@ export namespace dataproc_v1 { /** * Output only. The name of the Instance Group Manager for this group. */ - instanceGroupManagerName?: string; + instanceGroupManagerName?: string | null; /** * Output only. The name of the Instance Template used for the Managed Instance Group. */ - instanceTemplateName?: string; + instanceTemplateName?: string | null; } /** * Specifies an executable to run on a fully configured node and a timeout period for executable completion. @@ -903,11 +1006,11 @@ export namespace dataproc_v1 { /** * Required. Cloud Storage URI of executable file. */ - executableFile?: string; + 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. */ - executionTimeout?: string; + executionTimeout?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -916,7 +1019,7 @@ export namespace dataproc_v1 { /** * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -924,15 +1027,15 @@ export namespace dataproc_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A job executed by the workflow. @@ -949,7 +1052,7 @@ export namespace dataproc_v1 { /** * 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}; + labels?: {[key: string]: string} | null; /** * Job is a Pig job. */ @@ -957,7 +1060,7 @@ export namespace dataproc_v1 { /** * Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. */ - prerequisiteStepIds?: string[]; + prerequisiteStepIds?: string[] | null; /** * Job is a Pyspark job. */ @@ -977,7 +1080,7 @@ export namespace dataproc_v1 { /** * 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. */ - stepId?: string; + stepId?: string | null; } /** * Configuration for parameter validation. @@ -999,11 +1102,11 @@ export namespace dataproc_v1 { /** * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ - continueOnFailure?: boolean; + continueOnFailure?: boolean | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1011,11 +1114,11 @@ export namespace dataproc_v1 { /** * 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The HCFS URI of the script that contains the Pig queries. */ - queryFileUri?: string; + queryFileUri?: string | null; /** * A list of queries. */ @@ -1023,7 +1126,7 @@ export namespace dataproc_v1 { /** * Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). */ - scriptVariables?: {[key: string]: string}; + scriptVariables?: {[key: string]: string} | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). @@ -1036,11 +1139,11 @@ export namespace dataproc_v1 { /** * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + 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. @@ -1049,19 +1152,19 @@ export namespace dataproc_v1 { /** * Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. */ - archiveUris?: string[]; + archiveUris?: string[] | null; /** * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ - args?: string[]; + args?: string[] | null; /** * Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. */ - fileUris?: string[]; + fileUris?: string[] | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1069,15 +1172,15 @@ export namespace dataproc_v1 { /** * Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. */ - mainPythonFileUri?: string; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. */ - pythonFileUris?: string[]; + pythonFileUris?: string[] | null; } /** * A list of queries to run on a cluster. @@ -1086,7 +1189,7 @@ export namespace dataproc_v1 { /** * Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } */ - queries?: string[]; + queries?: string[] | null; } /** * Validation based on regular expressions. @@ -1095,7 +1198,7 @@ export namespace dataproc_v1 { /** * Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient). */ - regexes?: string[]; + regexes?: string[] | null; } /** * Security related configuration, including Kerberos. @@ -1122,15 +1225,15 @@ export namespace dataproc_v1 { /** * 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. */ - imageVersion?: string; + imageVersion?: string | null; /** * The set of optional components to activate on the cluster. */ - optionalComponents?: string[]; + optionalComponents?: string[] | null; /** * Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more information, see Cluster properties. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; } /** * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. @@ -1139,19 +1242,19 @@ export namespace dataproc_v1 { /** * Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. */ - archiveUris?: string[]; + archiveUris?: string[] | null; /** * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ - args?: string[]; + args?: string[] | null; /** * Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. */ - fileUris?: string[]; + fileUris?: string[] | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1159,15 +1262,15 @@ export namespace dataproc_v1 { /** * The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. */ - mainClass?: string; + mainClass?: string | null; /** * The HCFS URI of the jar file that contains the main class. */ - mainJarFileUri?: string; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; } /** * A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. @@ -1176,7 +1279,7 @@ export namespace dataproc_v1 { /** * Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1184,11 +1287,11 @@ export namespace dataproc_v1 { /** * 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The HCFS URI of the script that contains SQL queries. */ - queryFileUri?: string; + queryFileUri?: string | null; /** * A list of queries. */ @@ -1196,7 +1299,7 @@ export namespace dataproc_v1 { /** * Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). */ - scriptVariables?: {[key: string]: string}; + scriptVariables?: {[key: string]: 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). @@ -1205,15 +1308,15 @@ export namespace dataproc_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A request to submit a job. @@ -1226,7 +1329,7 @@ export namespace dataproc_v1 { /** * Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job 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. */ - requestId?: string; + requestId?: string | null; } /** * A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector) @@ -1235,15 +1338,15 @@ export namespace dataproc_v1 { /** * Optional. Brief description of the parameter. Must not exceed 1024 characters. */ - description?: string; + description?: string | null; /** * Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args */ - fields?: string[]; + fields?: string[] | null; /** * Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters. */ - name?: string; + name?: string | null; /** * Optional. Validation rules to be applied to this parameter's value. */ @@ -1256,7 +1359,7 @@ export namespace dataproc_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for TestIamPermissions method. @@ -1265,7 +1368,7 @@ export namespace dataproc_v1 { /** * A subset of TestPermissionsRequest.permissions that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Validation based on a list of allowed values. @@ -1274,7 +1377,7 @@ export namespace dataproc_v1 { /** * Required. List of allowed values for the parameter. */ - values?: string[]; + values?: string[] | null; } /** * The workflow graph. @@ -1292,11 +1395,11 @@ export namespace dataproc_v1 { /** * Output only. The name of the target cluster. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. The UUID of target cluster. */ - clusterUuid?: string; + clusterUuid?: string | null; /** * Output only. The create cluster operation metadata. */ @@ -1308,7 +1411,7 @@ export namespace dataproc_v1 { /** * Output only. Workflow end time. */ - endTime?: string; + endTime?: string | null; /** * Output only. The workflow graph. */ @@ -1316,23 +1419,23 @@ export namespace dataproc_v1 { /** * Map from parameter names to values that were used for those parameters. */ - parameters?: {[key: string]: string}; + parameters?: {[key: string]: string} | null; /** * Output only. Workflow start time. */ - startTime?: string; + startTime?: string | null; /** * Output only. The workflow state. */ - state?: string; + state?: string | null; /** * Output only. The resource name of the workflow template as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} */ - template?: string; + template?: string | null; /** * Output only. The version of template at the time of workflow instantiation. */ - version?: number; + version?: number | null; } /** * The workflow node. @@ -1341,23 +1444,23 @@ export namespace dataproc_v1 { /** * Output only. The error detail. */ - error?: string; + error?: string | null; /** * Output only. The job id; populated after the node enters RUNNING state. */ - jobId?: string; + jobId?: string | null; /** * Output only. Node's prerequisite nodes. */ - prerequisiteStepIds?: string[]; + prerequisiteStepIds?: string[] | null; /** * Output only. The node state. */ - state?: string; + state?: string | null; /** * Output only. The name of the node. */ - stepId?: string; + stepId?: string | null; } /** * A Cloud Dataproc workflow template resource. @@ -1366,11 +1469,11 @@ export namespace dataproc_v1 { /** * Output only. The time template was created. */ - createTime?: string; + createTime?: string | null; /** * Required. The template id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. */ - id?: string; + id?: string | null; /** * Required. The Directed Acyclic Graph of Jobs to submit. */ @@ -1378,11 +1481,11 @@ export namespace dataproc_v1 { /** * Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.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 template. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} */ - name?: string; + name?: string | null; /** * Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. */ @@ -1394,11 +1497,11 @@ export namespace dataproc_v1 { /** * Output only. The time template was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. */ - version?: number; + version?: number | null; } /** * Specifies workflow execution target.Either managed_cluster or cluster_selector is required. @@ -1420,19 +1523,19 @@ export namespace dataproc_v1 { /** * Required. The application name. */ - name?: string; + name?: string | null; /** * Required. The numerical progress of the application, from 1 to 100. */ - progress?: number; + progress?: number | null; /** * Required. The application state. */ - state?: string; + state?: string | null; /** * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. */ - trackingUrl?: string; + trackingUrl?: string | null; } export class Resource$Projects { @@ -1448,116 +1551,68 @@ export namespace dataproc_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + autoscalingPolicies: Resource$Projects$Locations$Autoscalingpolicies; workflowTemplates: Resource$Projects$Locations$Workflowtemplates; constructor(context: APIRequestContext) { this.context = context; + this.autoscalingPolicies = new Resource$Projects$Locations$Autoscalingpolicies( + this.context + ); this.workflowTemplates = new Resource$Projects$Locations$Workflowtemplates( this.context ); } } - export class Resource$Projects$Locations$Workflowtemplates { + export class Resource$Projects$Locations$Autoscalingpolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * dataproc.projects.locations.workflowTemplates.create - * @desc Creates new workflow template. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Cloud Dataproc API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dataproc = google.dataproc('v1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The "resource name" of the region, as described in - * // https://cloud.google.com/apis/design/resource_names of the form - * // projects/{project_id}/regions/{region} - * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dataproc.projects.locations.workflowTemplates.create(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getClient({ - * scopes: ['https://www.googleapis.com/auth/cloud-platform'] - * }).then(client => { - * callback(client); - * }).catch(err => { - * console.error('authentication failed: ', err); - * }); - * } - * @alias dataproc.projects.locations.workflowTemplates.create + * dataproc.projects.locations.autoscalingPolicies.create + * @desc Creates new autoscaling policy. + * @alias dataproc.projects.locations.autoscalingPolicies.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} - * @param {().WorkflowTemplate} params.resource Request body data + * @param {string} params.parent Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} + * @param {().AutoscalingPolicy} params.resource Request body data * @param {object} [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$Workflowtemplates$Create, + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Workflowtemplates$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Workflowtemplates$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Create - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Autoscalingpolicies$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Create; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Create; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Create; options = {}; } @@ -1570,7 +1625,7 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/workflowTemplates').replace( + url: (rootUrl + '/v1/{+parent}/autoscalingPolicies').replace( /([^:]\/)\/+/g, '$1' ), @@ -1584,98 +1639,52 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataproc.projects.locations.workflowTemplates.delete - * @desc Deletes a workflow template. It does not cancel in-progress workflows. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Cloud Dataproc API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dataproc = google.dataproc('v1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The "resource name" of the workflow template, as described in - * // https://cloud.google.com/apis/design/resource_names of the form - * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dataproc.projects.locations.workflowTemplates.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * google.auth.getClient({ - * scopes: ['https://www.googleapis.com/auth/cloud-platform'] - * }).then(client => { - * callback(client); - * }).catch(err => { - * console.error('authentication failed: ', err); - * }); - * } - * @alias dataproc.projects.locations.workflowTemplates.delete + * dataproc.projects.locations.autoscalingPolicies.delete + * @desc Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. + * @alias dataproc.projects.locations.autoscalingPolicies.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} - * @param {integer=} params.version Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. + * @param {string} params.name Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Delete + | Params$Resource$Projects$Locations$Autoscalingpolicies$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Delete; options = {}; } @@ -1706,96 +1715,47 @@ export namespace dataproc_v1 { } /** - * dataproc.projects.locations.workflowTemplates.get - * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Cloud Dataproc API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dataproc = google.dataproc('v1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The "resource name" of the workflow template, as described in - * // https://cloud.google.com/apis/design/resource_names of the form - * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dataproc.projects.locations.workflowTemplates.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getClient({ - * scopes: ['https://www.googleapis.com/auth/cloud-platform'] - * }).then(client => { - * callback(client); - * }).catch(err => { - * console.error('authentication failed: ', err); - * }); - * } - * @alias dataproc.projects.locations.workflowTemplates.get - * @memberOf! () + * dataproc.projects.locations.autoscalingPolicies.get + * @desc Retrieves autoscaling policy. + * @alias dataproc.projects.locations.autoscalingPolicies.get + * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} - * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version. + * @param {string} params.name Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Get, + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Workflowtemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Workflowtemplates$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Get - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Autoscalingpolicies$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Get; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Get; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Get; options = {}; } @@ -1819,14 +1779,14 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataproc.projects.locations.workflowTemplates.getIamPolicy + * dataproc.projects.locations.autoscalingPolicies.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. * @example * * // BEFORE RUNNING: @@ -1850,7 +1810,7 @@ export namespace dataproc_v1 { * var request = { * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for * // the appropriate value for this field. - * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * resource_: 'projects/my-project/locations/my-location/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1859,7 +1819,7 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.locations.workflowTemplates.getIamPolicy(request, function(err, response) { + * dataproc.projects.locations.autoscalingPolicies.getIamPolicy(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -1879,7 +1839,7 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * }); * } - * @alias dataproc.projects.locations.workflowTemplates.getIamPolicy + * @alias dataproc.projects.locations.autoscalingPolicies.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -1890,33 +1850,33 @@ export namespace dataproc_v1 { * @return {object} Request object */ getIamPolicy( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy(callback: BodyResponseCallback): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + | Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy; options = {}; } @@ -1950,8 +1910,93 @@ export namespace dataproc_v1 { } /** - * dataproc.projects.locations.workflowTemplates.instantiate - * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful completion, Operation.response will be Empty. + * dataproc.projects.locations.autoscalingPolicies.list + * @desc Lists autoscaling policies in the project. + * @alias dataproc.projects.locations.autoscalingPolicies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. + * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. + * @param {string} params.parent Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{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 + */ + list( + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autoscalingpolicies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autoscalingPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dataproc.projects.locations.autoscalingPolicies.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: * // --------------- @@ -1972,10 +2017,9 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The "resource name" of the workflow template, as described in - * // https://cloud.google.com/apis/design/resource_names of the form - * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1984,7 +2028,7 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.locations.workflowTemplates.instantiate(request, function(err, response) { + * dataproc.projects.locations.autoscalingPolicies.setIamPolicy(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -2004,46 +2048,44 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * }); * } - * @alias dataproc.projects.locations.workflowTemplates.instantiate + * @alias dataproc.projects.locations.autoscalingPolicies.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} - * @param {().InstantiateWorkflowTemplateRequest} params.resource Request body data + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - instantiate( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - instantiate( - params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - instantiate( - params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy, + callback: BodyResponseCallback ): void; - instantiate(callback: BodyResponseCallback): void; - instantiate( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Instantiate - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Instantiate; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Instantiate; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy; options = {}; } @@ -2056,7 +2098,7 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:instantiate').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -2065,20 +2107,20 @@ export namespace dataproc_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataproc.projects.locations.workflowTemplates.instantiateInline - * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful completion, Operation.response will be Empty. + * dataproc.projects.locations.autoscalingPolicies.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. * @example * * // BEFORE RUNNING: * // --------------- @@ -2099,10 +2141,9 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The "resource name" of the workflow template region, as described in - * // https://cloud.google.com/apis/design/resource_names of the form - * // projects/{project_id}/regions/{region} - * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2111,7 +2152,7 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.locations.workflowTemplates.instantiateInline(request, function(err, response) { + * dataproc.projects.locations.autoscalingPolicies.testIamPermissions(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -2131,47 +2172,50 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * }); * } - * @alias dataproc.projects.locations.workflowTemplates.instantiateInline + * @alias dataproc.projects.locations.autoscalingPolicies.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} - * @param {string=} params.requestId Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. - * @param {().WorkflowTemplate} params.resource Request body data + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - instantiateInline( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - instantiateInline( - params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - instantiateInline( - params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - instantiateInline(callback: BodyResponseCallback): void; - instantiateInline( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions; options = {}; } @@ -2184,78 +2228,1968 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/workflowTemplates:instantiateInline' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataproc.projects.locations.workflowTemplates.list - * @desc Lists workflows that match the specified filter in the request. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Cloud Dataproc API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dataproc = google.dataproc('v1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The "resource name" of the region, as described in - * // https://cloud.google.com/apis/design/resource_names of the form - * // projects/{project_id}/regions/{region} - * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * dataproc.projects.locations.autoscalingPolicies.update + * @desc Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. + * @alias dataproc.projects.locations.autoscalingPolicies.update + * @memberOf! () * - * auth: authClient, + * @param {object} params Parameters for request + * @param {string} params.name Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + * @param {().AutoscalingPolicy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autoscalingpolicies$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutoscalingPolicy; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. + */ + pageSize?: number; + /** + * Optional. The page token, returned by a previous call, to request the next page of results. + */ + pageToken?: string; + /** + * Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$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$Autoscalingpolicies$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutoscalingPolicy; + } + + export class Resource$Projects$Locations$Workflowtemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataproc.projects.locations.workflowTemplates.create + * @desc Creates new workflow template. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} + * @param {().WorkflowTemplate} params.resource Request body data + * @param {object} [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$Workflowtemplates$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Workflowtemplates$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workflowtemplates$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workflowTemplates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.delete + * @desc Deletes a workflow template. It does not cancel in-progress workflows. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + * @param {integer=} params.version Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified 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 + */ + delete( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.get + * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current 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 + */ + get( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Workflowtemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workflowtemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.getIamPolicy(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.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.instantiate + * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful completion, Operation.response will be Empty. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.instantiate(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.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.instantiate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + * @param {().InstantiateWorkflowTemplateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + instantiate( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, + options?: MethodOptions + ): GaxiosPromise; + instantiate( + params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + instantiate( + params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, + callback: BodyResponseCallback + ): void; + instantiate(callback: BodyResponseCallback): void; + instantiate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Instantiate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Instantiate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Instantiate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:instantiate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.instantiateInline + * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful completion, Operation.response will be Empty. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.instantiateInline(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.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.instantiateInline + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} + * @param {string=} params.requestId Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + * @param {().WorkflowTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + instantiateInline( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, + options?: MethodOptions + ): GaxiosPromise; + instantiateInline( + params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + instantiateInline( + params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, + callback: BodyResponseCallback + ): void; + instantiateInline(callback: BodyResponseCallback): void; + instantiateInline( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/workflowTemplates:instantiateInline' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.list + * @desc Lists workflows that match the specified filter in the request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var templatesPage = response['templates']; + * if (!templatesPage) { + * return; + * } + * for (var i = 0; i < templatesPage.length; i++) { + * // TODO: Change code below to process each resource in `templatesPage`: + * console.log(JSON.stringify(templatesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dataproc.projects.locations.workflowTemplates.list(request, handlePage); + * } + * }; + * + * dataproc.projects.locations.workflowTemplates.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum 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.parent Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{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 + */ + list( + params?: Params$Resource$Projects$Locations$Workflowtemplates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Workflowtemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Workflowtemplates$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workflowTemplates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.setIamPolicy(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.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.testIamPermissions(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.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.update + * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Output only. The "resource name" of the template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + * @param {().WorkflowTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Workflowtemplates$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Workflowtemplates$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Workflowtemplates$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowTemplate; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + */ + name?: string; + /** + * Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. + */ + version?: number; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + */ + name?: string; + /** + * Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version. + */ + version?: number; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstantiateWorkflowTemplateRequest; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} + */ + parent?: string; + /** + * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowTemplate; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of results to return in each response. + */ + pageSize?: number; + /** + * Optional. The page token, returned by a previous call, to request the next page of results. + */ + pageToken?: string; + /** + * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$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$Workflowtemplates$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowTemplate; + } + + export class Resource$Projects$Regions { + context: APIRequestContext; + autoscalingPolicies: Resource$Projects$Regions$Autoscalingpolicies; + clusters: Resource$Projects$Regions$Clusters; + jobs: Resource$Projects$Regions$Jobs; + operations: Resource$Projects$Regions$Operations; + workflowTemplates: Resource$Projects$Regions$Workflowtemplates; + constructor(context: APIRequestContext) { + this.context = context; + this.autoscalingPolicies = new Resource$Projects$Regions$Autoscalingpolicies( + this.context + ); + this.clusters = new Resource$Projects$Regions$Clusters(this.context); + this.jobs = new Resource$Projects$Regions$Jobs(this.context); + this.operations = new Resource$Projects$Regions$Operations(this.context); + this.workflowTemplates = new Resource$Projects$Regions$Workflowtemplates( + this.context + ); + } + } + + export class Resource$Projects$Regions$Autoscalingpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataproc.projects.regions.autoscalingPolicies.create + * @desc Creates new autoscaling policy. + * @alias dataproc.projects.regions.autoscalingPolicies.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} + * @param {().AutoscalingPolicy} params.resource Request body data + * @param {object} [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$Regions$Autoscalingpolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Regions$Autoscalingpolicies$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autoscalingPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.regions.autoscalingPolicies.delete + * @desc Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. + * @alias dataproc.projects.regions.autoscalingPolicies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Regions$Autoscalingpolicies$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.regions.autoscalingPolicies.get + * @desc Retrieves autoscaling policy. + * @alias dataproc.projects.regions.autoscalingPolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Regions$Autoscalingpolicies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.regions.autoscalingPolicies.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, * }; * - * var handlePage = function(err, response) { + * dataproc.projects.regions.autoscalingPolicies.getIamPolicy(request, function(err, response) { * if (err) { * console.error(err); * return; * } * - * var templatesPage = response['templates']; - * if (!templatesPage) { - * return; - * } - * for (var i = 0; i < templatesPage.length; i++) { - * // TODO: Change code below to process each resource in `templatesPage`: - * console.log(JSON.stringify(templatesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dataproc.projects.locations.workflowTemplates.list(request, handlePage); - * } - * }; - * - * dataproc.projects.locations.workflowTemplates.list(request, handlePage); + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); * }); * * function authorize(callback) { @@ -2267,51 +4201,124 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * }); * } - * @alias dataproc.projects.locations.workflowTemplates.list + * @alias dataproc.projects.regions.autoscalingPolicies.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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); + } + } + + /** + * dataproc.projects.regions.autoscalingPolicies.list + * @desc Lists autoscaling policies in the project. + * @alias dataproc.projects.regions.autoscalingPolicies.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. + * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. - * @param {string} params.parent Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} + * @param {string} params.parent Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{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 */ list( - params?: Params$Resource$Projects$Locations$Workflowtemplates$List, + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Workflowtemplates$List, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Workflowtemplates$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Regions$Autoscalingpolicies$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$List - | BodyResponseCallback, + | Params$Resource$Projects$Regions$Autoscalingpolicies$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$List; + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$List; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$List; options = {}; } @@ -2324,7 +4331,7 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/workflowTemplates').replace( + url: (rootUrl + '/v1/{+parent}/autoscalingPolicies').replace( /([^:]\/)\/+/g, '$1' ), @@ -2338,19 +4345,19 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * dataproc.projects.locations.workflowTemplates.setIamPolicy + * dataproc.projects.regions.autoscalingPolicies.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: @@ -2374,7 +4381,7 @@ export namespace dataproc_v1 { * var request = { * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for * // the appropriate value for this field. - * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * resource_: 'projects/my-project/regions/my-region/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2383,7 +4390,7 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.locations.workflowTemplates.setIamPolicy(request, function(err, response) { + * dataproc.projects.regions.autoscalingPolicies.setIamPolicy(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -2403,7 +4410,7 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * }); * } - * @alias dataproc.projects.locations.workflowTemplates.setIamPolicy + * @alias dataproc.projects.regions.autoscalingPolicies.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -2414,33 +4421,33 @@ export namespace dataproc_v1 { * @return {object} Request object */ setIamPolicy( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy(callback: BodyResponseCallback): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + | Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy; options = {}; } @@ -2474,7 +4481,7 @@ export namespace dataproc_v1 { } /** - * dataproc.projects.locations.workflowTemplates.testIamPermissions + * dataproc.projects.regions.autoscalingPolicies.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. * @example * * // BEFORE RUNNING: @@ -2498,7 +4505,7 @@ export namespace dataproc_v1 { * var request = { * // REQUIRED: The resource for which the policy detail is being requested. See the operation * // documentation for the appropriate value for this field. - * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * resource_: 'projects/my-project/regions/my-region/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2507,7 +4514,7 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.locations.workflowTemplates.testIamPermissions(request, function(err, response) { + * dataproc.projects.regions.autoscalingPolicies.testIamPermissions(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -2527,7 +4534,7 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * }); * } - * @alias dataproc.projects.locations.workflowTemplates.testIamPermissions + * @alias dataproc.projects.regions.autoscalingPolicies.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -2538,18 +4545,18 @@ export namespace dataproc_v1 { * @return {object} Request object */ testIamPermissions( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -2557,7 +4564,7 @@ export namespace dataproc_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + | Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -2565,12 +4572,12 @@ export namespace dataproc_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions; options = {}; } @@ -2607,101 +4614,48 @@ export namespace dataproc_v1 { } /** - * dataproc.projects.locations.workflowTemplates.update - * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Cloud Dataproc API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dataproc = google.dataproc('v1'); - * - * authorize(function(authClient) { - * var request = { - * // Output only. The "resource name" of the template, as described in - * // https://cloud.google.com/apis/design/resource_names of the form - * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dataproc.projects.locations.workflowTemplates.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getClient({ - * scopes: ['https://www.googleapis.com/auth/cloud-platform'] - * }).then(client => { - * callback(client); - * }).catch(err => { - * console.error('authentication failed: ', err); - * }); - * } - * @alias dataproc.projects.locations.workflowTemplates.update + * dataproc.projects.regions.autoscalingPolicies.update + * @desc Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. + * @alias dataproc.projects.regions.autoscalingPolicies.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} - * @param {().WorkflowTemplate} params.resource Request body data + * @param {string} params.name Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} + * @param {().AutoscalingPolicy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Update, + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Update, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; update( - params: Params$Resource$Projects$Locations$Workflowtemplates$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; update( - params: Params$Resource$Projects$Locations$Workflowtemplates$Update, - callback: BodyResponseCallback + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Update, + callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; update( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Update - | BodyResponseCallback, + | Params$Resource$Projects$Regions$Autoscalingpolicies$Update + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Update; + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Update; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Update; options = {}; } @@ -2725,14 +4679,14 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Create + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -2740,16 +4694,16 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} + * Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$WorkflowTemplate; + requestBody?: Schema$AutoscalingPolicy; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -2757,15 +4711,11 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} */ name?: string; - /** - * Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. - */ - version?: number; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Get + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -2773,15 +4723,11 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} */ name?: string; - /** - * Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version. - */ - version?: number; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -2798,45 +4744,7 @@ export namespace dataproc_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstantiateWorkflowTemplateRequest; - } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} - */ - parent?: string; - /** - * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$WorkflowTemplate; - } - export interface Params$Resource$Projects$Locations$Workflowtemplates$List + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$List extends StandardParameters { /** * Auth client or API Key for the request @@ -2844,7 +4752,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return in each response. + * Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. */ pageSize?: number; /** @@ -2852,11 +4760,11 @@ export namespace dataproc_v1 { */ pageToken?: string; /** - * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} + * Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} */ parent?: string; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -2873,7 +4781,7 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request @@ -2890,7 +4798,7 @@ export namespace dataproc_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Update + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Update extends StandardParameters { /** * Auth client or API Key for the request @@ -2898,31 +4806,14 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} + * Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} */ name?: string; /** * Request body metadata */ - requestBody?: Schema$WorkflowTemplate; - } - - export class Resource$Projects$Regions { - context: APIRequestContext; - clusters: Resource$Projects$Regions$Clusters; - jobs: Resource$Projects$Regions$Jobs; - operations: Resource$Projects$Regions$Operations; - workflowTemplates: Resource$Projects$Regions$Workflowtemplates; - constructor(context: APIRequestContext) { - this.context = context; - this.clusters = new Resource$Projects$Regions$Clusters(this.context); - this.jobs = new Resource$Projects$Regions$Jobs(this.context); - this.operations = new Resource$Projects$Regions$Operations(this.context); - this.workflowTemplates = new Resource$Projects$Regions$Workflowtemplates( - this.context - ); - } + requestBody?: Schema$AutoscalingPolicy; } export class Resource$Projects$Regions$Clusters { diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 30a3b6e625c..6e283695968 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -124,11 +124,11 @@ export namespace dataproc_v1beta2 { /** * The number of the accelerator cards of this type exposed to this instance. */ - acceleratorCount?: number; + 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. */ - acceleratorTypeUri?: string; + acceleratorTypeUri?: string | null; } /** * Autoscaling Policy config associated with the cluster. @@ -137,7 +137,7 @@ export namespace dataproc_v1beta2 { /** * 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. */ - policyUri?: string; + policyUri?: string | null; } /** * Describes an autoscaling policy for Dataproc cluster autoscaler. @@ -147,11 +147,11 @@ export namespace dataproc_v1beta2 { /** * Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. */ - id?: string; + id?: string | null; /** * Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} */ - name?: string; + name?: string | null; /** * Optional. Describes how the autoscaler will operate for secondary workers. */ @@ -168,7 +168,7 @@ export namespace dataproc_v1beta2 { /** * Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m. */ - cooldownPeriod?: string; + cooldownPeriod?: string | null; /** * Required. YARN autoscaling configuration. */ @@ -181,23 +181,23 @@ export namespace dataproc_v1beta2 { /** * Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d. */ - gracefulDecommissionTimeout?: string; + gracefulDecommissionTimeout?: string | null; /** * Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0. */ - scaleDownFactor?: number; + scaleDownFactor?: number | null; /** * Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0. */ - scaleDownMinWorkerFraction?: number; + scaleDownMinWorkerFraction?: number | null; /** * Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0. */ - scaleUpFactor?: number; + scaleUpFactor?: number | null; /** * Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0. */ - scaleUpMinWorkerFraction?: number; + scaleUpMinWorkerFraction?: number | null; } /** * Associates members with a role. @@ -210,11 +210,11 @@ export namespace dataproc_v1beta2 { /** * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. */ - role?: string; + role?: string | null; } /** * A request to cancel a job. @@ -227,11 +227,11 @@ export namespace dataproc_v1beta2 { /** * Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster. */ - clusterUuid?: string; + clusterUuid?: string | null; /** * Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated. */ @@ -239,7 +239,7 @@ export namespace dataproc_v1beta2 { /** * Optional. The labels to associate with this cluster. 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 cluster. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ @@ -247,7 +247,7 @@ export namespace dataproc_v1beta2 { /** * Required. The Google Cloud Platform project ID that the cluster belongs to. */ - projectId?: string; + projectId?: string | null; /** * Output only. Cluster status. */ @@ -268,7 +268,7 @@ export namespace dataproc_v1beta2 { /** * 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). */ - configBucket?: string; + configBucket?: string | null; /** * Optional. Encryption settings for the cluster. */ @@ -317,11 +317,11 @@ export namespace dataproc_v1beta2 { /** * The HDFS metrics. */ - hdfsMetrics?: {[key: string]: string}; + hdfsMetrics?: {[key: string]: string} | null; /** * The YARN metrics. */ - yarnMetrics?: {[key: string]: string}; + yarnMetrics?: {[key: string]: string} | null; } /** * The cluster operation triggered by a workflow. @@ -330,15 +330,15 @@ export namespace dataproc_v1beta2 { /** * Output only. Indicates the operation is done. */ - done?: boolean; + done?: boolean | null; /** * Output only. Error, if operation failed. */ - error?: string; + error?: string | null; /** * Output only. The id of the cluster operation. */ - operationId?: string; + operationId?: string | null; } /** * Metadata describing the operation. @@ -347,23 +347,23 @@ export namespace dataproc_v1beta2 { /** * Output only. Name of the cluster for the operation. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. Cluster UUID for the operation. */ - clusterUuid?: string; + clusterUuid?: string | null; /** * Output only. Short description of operation. */ - description?: string; + description?: string | null; /** * Output only. Labels associated with the operation */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The operation type. */ - operationType?: string; + operationType?: string | null; /** * Output only. Current operation status. */ @@ -375,7 +375,7 @@ export namespace dataproc_v1beta2 { /** * Output only. Errors encountered during operation execution. */ - warnings?: string[]; + warnings?: string[] | null; } /** * The status of the operation. @@ -384,19 +384,19 @@ export namespace dataproc_v1beta2 { /** * Output only. A message containing any operation metadata details. */ - details?: string; + details?: string | null; /** * Output only. A message containing the detailed operation state. */ - innerState?: string; + innerState?: string | null; /** * Output only. A message containing the operation state. */ - state?: string; + state?: string | null; /** * Output only. The time this state was entered. */ - stateStartTime?: string; + stateStartTime?: string | null; } /** * A selector that chooses target cluster for jobs based on metadata. @@ -405,11 +405,11 @@ export namespace dataproc_v1beta2 { /** * Required. The cluster labels. Cluster must have all labels to match. */ - clusterLabels?: {[key: string]: string}; + clusterLabels?: {[key: string]: string} | null; /** * Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used. */ - zone?: string; + zone?: string | null; } /** * The status of a cluster and its instances. @@ -418,19 +418,19 @@ export namespace dataproc_v1beta2 { /** * Output only. Optional details of cluster's state. */ - detail?: string; + detail?: string | null; /** * Output only. The cluster's state. */ - state?: string; + state?: string | null; /** * Output only. Time when this state was entered. */ - stateStartTime?: string; + stateStartTime?: string | null; /** * Output only. Additional state information that includes status reported by the agent. */ - substate?: string; + substate?: string | null; } /** * A request to collect cluster diagnostic information. @@ -443,7 +443,7 @@ export namespace dataproc_v1beta2 { /** * Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics. */ - outputUri?: string; + outputUri?: string | null; } /** * Specifies the config of disk options for a group of VM instances. @@ -452,15 +452,15 @@ export namespace dataproc_v1beta2 { /** * Optional. Size in GB of the boot disk (default is 500GB). */ - bootDiskSizeGb?: number; + bootDiskSizeGb?: number | null; /** * Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). */ - bootDiskType?: string; + bootDiskType?: string | null; /** * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries. */ - numLocalSsds?: number; + numLocalSsds?: number | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. @@ -473,7 +473,7 @@ export namespace dataproc_v1beta2 { /** * Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster. */ - gcePdKmsKeyName?: string; + gcePdKmsKeyName?: string | null; } /** * Endpoint config for this cluster @@ -482,11 +482,11 @@ export namespace dataproc_v1beta2 { /** * Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false. */ - enableHttpPortAccess?: boolean; + enableHttpPortAccess?: boolean | null; /** * Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true. */ - httpPorts?: {[key: string]: string}; + httpPorts?: {[key: string]: string} | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -495,19 +495,19 @@ export namespace dataproc_v1beta2 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. @@ -516,15 +516,15 @@ export namespace dataproc_v1beta2 { /** * Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses. */ - internalIpOnly?: boolean; + internalIpOnly?: boolean | null; /** * The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default projects/[project_id]/regions/global/default default */ - networkUri?: string; + networkUri?: string | null; /** * Optional. Reservation Affinity for consuming Zonal reservation. */ @@ -532,23 +532,23 @@ export namespace dataproc_v1beta2 { /** * 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 */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control */ - serviceAccountScopes?: string[]; + serviceAccountScopes?: string[] | null; /** * Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0 sub0 */ - subnetworkUri?: string; + subnetworkUri?: string | null; /** * The Compute Engine tags to add to all instances (see Tagging instances). */ - tags?: string[]; + 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 */ - zoneUri?: string; + zoneUri?: string | null; } /** * Request message for GetIamPolicy method. @@ -564,9 +564,9 @@ export namespace dataproc_v1beta2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + 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). @@ -575,19 +575,19 @@ export namespace dataproc_v1beta2 { /** * Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip. */ - archiveUris?: string[]; + archiveUris?: string[] | null; /** * Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ - args?: string[]; + args?: string[] | null; /** * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. */ - fileUris?: string[]; + fileUris?: string[] | null; /** * Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -595,15 +595,15 @@ export namespace dataproc_v1beta2 { /** * The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris. */ - mainClass?: string; + mainClass?: string | null; /** * The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' */ - mainJarFileUri?: string; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; } /** * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. @@ -612,19 +612,19 @@ export namespace dataproc_v1beta2 { /** * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ - continueOnFailure?: boolean; + continueOnFailure?: boolean | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. */ - jarFileUris?: string[]; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The HCFS URI of the script that contains Hive queries. */ - queryFileUri?: string; + queryFileUri?: string | null; /** * A list of queries. */ @@ -632,7 +632,7 @@ export namespace dataproc_v1beta2 { /** * Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). */ - scriptVariables?: {[key: string]: string}; + scriptVariables?: {[key: string]: string} | null; } /** * Configuration for the size bounds of an instance group, including its proportional size to other groups. @@ -641,15 +641,15 @@ export namespace dataproc_v1beta2 { /** * Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0. */ - maxInstances?: number; + maxInstances?: number | null; /** * Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0. */ - minInstances?: number; + minInstances?: number | null; /** * Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers. */ - weight?: number; + weight?: number | null; } /** * Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. @@ -666,19 +666,19 @@ export namespace dataproc_v1beta2 { /** * Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version. */ - imageUri?: string; + imageUri?: string | null; /** * Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group. */ - instanceNames?: string[]; + instanceNames?: string[] | null; /** * Optional. Specifies that this instance group contains preemptible instances. */ - isPreemptible?: boolean; + 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. */ - machineTypeUri?: string; + machineTypeUri?: string | null; /** * Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups. */ @@ -686,11 +686,11 @@ export namespace dataproc_v1beta2 { /** * Optional. Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc&rarr;Minimum CPU Platform. */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1. */ - numInstances?: number; + numInstances?: number | null; } /** * A request to instantiate a workflow template. @@ -699,19 +699,19 @@ export namespace dataproc_v1beta2 { /** * Deprecated. Please use request_id field instead. */ - instanceId?: string; + instanceId?: string | null; /** * Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters. */ - parameters?: {[key: string]: string}; + parameters?: {[key: string]: string} | null; /** * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ - requestId?: string; + requestId?: string | null; /** * Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template. */ - version?: number; + version?: number | null; } /** * A Cloud Dataproc job resource. @@ -720,11 +720,11 @@ export namespace dataproc_v1beta2 { /** * Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. */ - driverControlFilesUri?: string; + driverControlFilesUri?: string | null; /** * Output only. A URI pointing to the location of the stdout of the job's driver program. */ - driverOutputResourceUri?: string; + driverOutputResourceUri?: string | null; /** * Job is a Hadoop job. */ @@ -736,11 +736,11 @@ export namespace dataproc_v1beta2 { /** * 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. */ - jobUuid?: string; + jobUuid?: string | null; /** * 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}; + labels?: {[key: string]: string} | null; /** * Job is a Pig job. */ @@ -788,7 +788,7 @@ export namespace dataproc_v1beta2 { /** * Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. */ - submittedBy?: string; + submittedBy?: string | null; /** * Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ @@ -801,11 +801,11 @@ export namespace dataproc_v1beta2 { /** * Required. The name of the cluster where the job will be submitted. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. */ - clusterUuid?: string; + clusterUuid?: string | null; } /** * Encapsulates the full scoping used to reference a job. @@ -814,11 +814,11 @@ export namespace dataproc_v1beta2 { /** * 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; + jobId?: string | null; /** * Required. The ID of the Google Cloud Platform project that the job belongs to. */ - projectId?: string; + projectId?: string | null; } /** * Job scheduling options. @@ -827,7 +827,7 @@ export namespace dataproc_v1beta2 { /** * Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. */ - maxFailuresPerHour?: number; + maxFailuresPerHour?: number | null; } /** * Cloud Dataproc job status. @@ -836,19 +836,19 @@ export namespace dataproc_v1beta2 { /** * Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. */ - details?: string; + details?: string | null; /** * Output only. A state message specifying the overall job state. */ - state?: string; + state?: string | null; /** * Output only. The time when this state was entered. */ - stateStartTime?: string; + stateStartTime?: string | null; /** * Output only. Additional state information, which includes status reported by the agent. */ - substate?: string; + substate?: string | null; } /** * Specifies Kerberos related configuration. @@ -857,63 +857,63 @@ export namespace dataproc_v1beta2 { /** * Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */ - crossRealmTrustAdminServer?: string; + crossRealmTrustAdminServer?: string | null; /** * Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */ - crossRealmTrustKdc?: string; + crossRealmTrustKdc?: string | null; /** * Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust. */ - crossRealmTrustRealm?: string; + crossRealmTrustRealm?: string | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship. */ - crossRealmTrustSharedPasswordUri?: string; + crossRealmTrustSharedPasswordUri?: string | null; /** * Optional. Flag to indicate whether to Kerberize the cluster. */ - enableKerberos?: boolean; + enableKerberos?: boolean | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database. */ - kdcDbKeyUri?: string; + kdcDbKeyUri?: string | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc. */ - keyPasswordUri?: string; + keyPasswordUri?: string | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc. */ - keystorePasswordUri?: string; + keystorePasswordUri?: string | null; /** * Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. */ - keystoreUri?: string; + keystoreUri?: string | null; /** * Required. The uri of the KMS key used to encrypt various sensitive files. */ - kmsKeyUri?: string; + kmsKeyUri?: string | null; /** * Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm. */ - realm?: string; + realm?: string | null; /** * Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password. */ - rootPrincipalPasswordUri?: string; + rootPrincipalPasswordUri?: string | null; /** * Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used. */ - tgtLifetimeHours?: number; + tgtLifetimeHours?: number | null; /** * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc. */ - truststorePasswordUri?: string; + truststorePasswordUri?: string | null; /** * Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. */ - truststoreUri?: string; + truststoreUri?: string | null; } /** * Specifies the cluster auto-delete schedule configuration. @@ -922,19 +922,19 @@ export namespace dataproc_v1beta2 { /** * Optional. The time when cluster will be auto-deleted. */ - autoDeleteTime?: string; + 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.. */ - autoDeleteTtl?: string; + 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. */ - idleDeleteTtl?: string; + idleDeleteTtl?: string | null; /** * Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness. */ - idleStartTime?: string; + idleStartTime?: string | null; } /** * A response to a request to list autoscaling policies in a project. @@ -943,7 +943,7 @@ export namespace dataproc_v1beta2 { /** * Output only. This token is included in the response if there are more results to fetch. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. Autoscaling policies list. */ @@ -960,7 +960,7 @@ export namespace dataproc_v1beta2 { /** * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListClustersRequest</code>. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A list of jobs in a project. @@ -973,7 +973,7 @@ export namespace dataproc_v1beta2 { /** * Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListJobsRequest</code>. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -982,7 +982,7 @@ export namespace dataproc_v1beta2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -995,7 +995,7 @@ export namespace dataproc_v1beta2 { /** * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListWorkflowTemplatesRequest</code>. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. WorkflowTemplates list. */ @@ -1008,7 +1008,7 @@ export namespace dataproc_v1beta2 { /** * The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' */ - driverLogLevels?: {[key: string]: string}; + driverLogLevels?: {[key: string]: string} | null; } /** * Cluster that is managed by the workflow. @@ -1017,7 +1017,7 @@ export namespace dataproc_v1beta2 { /** * Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters. */ - clusterName?: string; + clusterName?: string | null; /** * Required. The cluster configuration. */ @@ -1025,7 +1025,7 @@ export namespace dataproc_v1beta2 { /** * Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } /** * Specifies the resources used to actively manage an instance group. @@ -1034,11 +1034,11 @@ export namespace dataproc_v1beta2 { /** * Output only. The name of the Instance Group Manager for this group. */ - instanceGroupManagerName?: string; + instanceGroupManagerName?: string | null; /** * Output only. The name of the Instance Template used for the Managed Instance Group. */ - instanceTemplateName?: string; + instanceTemplateName?: string | null; } /** * Specifies an executable to run on a fully configured node and a timeout period for executable completion. @@ -1047,11 +1047,11 @@ export namespace dataproc_v1beta2 { /** * Required. Cloud Storage URI of executable file. */ - executableFile?: string; + 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. */ - executionTimeout?: string; + executionTimeout?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1060,7 +1060,7 @@ export namespace dataproc_v1beta2 { /** * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1068,15 +1068,15 @@ export namespace dataproc_v1beta2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A job executed by the workflow. @@ -1093,7 +1093,7 @@ export namespace dataproc_v1beta2 { /** * 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}; + labels?: {[key: string]: string} | null; /** * Job is a Pig job. */ @@ -1101,7 +1101,7 @@ export namespace dataproc_v1beta2 { /** * Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. */ - prerequisiteStepIds?: string[]; + prerequisiteStepIds?: string[] | null; /** * Job is a Pyspark job. */ @@ -1121,7 +1121,7 @@ export namespace dataproc_v1beta2 { /** * 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. */ - stepId?: string; + stepId?: string | null; } /** * Configuration for parameter validation. @@ -1143,11 +1143,11 @@ export namespace dataproc_v1beta2 { /** * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ - continueOnFailure?: boolean; + continueOnFailure?: boolean | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1155,11 +1155,11 @@ export namespace dataproc_v1beta2 { /** * 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The HCFS URI of the script that contains the Pig queries. */ - queryFileUri?: string; + queryFileUri?: string | null; /** * A list of queries. */ @@ -1167,7 +1167,7 @@ export namespace dataproc_v1beta2 { /** * Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). */ - scriptVariables?: {[key: string]: string}; + scriptVariables?: {[key: string]: string} | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). @@ -1180,11 +1180,11 @@ export namespace dataproc_v1beta2 { /** * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * A Cloud Dataproc job for running Presto (https://prestosql.io/) queries @@ -1193,11 +1193,11 @@ export namespace dataproc_v1beta2 { /** * Optional. Presto client tags to attach to this query */ - clientTags?: string[]; + clientTags?: string[] | null; /** * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ - continueOnFailure?: boolean; + continueOnFailure?: boolean | null; /** * Optional. The runtime log config for job execution. */ @@ -1205,15 +1205,15 @@ export namespace dataproc_v1beta2 { /** * Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats */ - outputFormat?: string; + outputFormat?: string | null; /** * Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The HCFS URI of the script that contains SQL queries. */ - queryFileUri?: string; + queryFileUri?: string | null; /** * A list of queries. */ @@ -1226,19 +1226,19 @@ export namespace dataproc_v1beta2 { /** * Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. */ - archiveUris?: string[]; + archiveUris?: string[] | null; /** * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ - args?: string[]; + args?: string[] | null; /** * Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. */ - fileUris?: string[]; + fileUris?: string[] | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1246,15 +1246,15 @@ export namespace dataproc_v1beta2 { /** * Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. */ - mainPythonFileUri?: string; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. */ - pythonFileUris?: string[]; + pythonFileUris?: string[] | null; } /** * A list of queries to run on a cluster. @@ -1263,7 +1263,7 @@ export namespace dataproc_v1beta2 { /** * Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } */ - queries?: string[]; + queries?: string[] | null; } /** * Validation based on regular expressions. @@ -1272,7 +1272,7 @@ export namespace dataproc_v1beta2 { /** * Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient). */ - regexes?: string[]; + regexes?: string[] | null; } /** * Reservation Affinity for consuming Zonal reservation. @@ -1281,15 +1281,15 @@ export namespace dataproc_v1beta2 { /** * Optional. Type of reservation to consume */ - consumeReservationType?: string; + consumeReservationType?: string | null; /** * Optional. Corresponds to the label key of reservation resource. */ - key?: string; + key?: string | null; /** * Optional. Corresponds to the label values of reservation resource. */ - values?: string[]; + values?: string[] | null; } /** * Security related configuration, including encryption, Kerberos, etc. @@ -1316,15 +1316,15 @@ export namespace dataproc_v1beta2 { /** * 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. */ - imageVersion?: string; + imageVersion?: string | null; /** * The set of optional components to activate on the cluster. */ - optionalComponents?: string[]; + optionalComponents?: string[] | null; /** * Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more information, see Cluster properties. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; } /** * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. @@ -1333,19 +1333,19 @@ export namespace dataproc_v1beta2 { /** * Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. */ - archiveUris?: string[]; + archiveUris?: string[] | null; /** * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ - args?: string[]; + args?: string[] | null; /** * Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. */ - fileUris?: string[]; + fileUris?: string[] | null; /** * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1353,15 +1353,15 @@ export namespace dataproc_v1beta2 { /** * The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. */ - mainClass?: string; + mainClass?: string | null; /** * The HCFS URI of the jar file that contains the main class. */ - mainJarFileUri?: string; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; } /** * A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. @@ -1370,15 +1370,15 @@ export namespace dataproc_v1beta2 { /** * Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. */ - archiveUris?: string[]; + archiveUris?: string[] | null; /** * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ - args?: string[]; + args?: string[] | null; /** * Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. */ - fileUris?: string[]; + fileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1386,11 +1386,11 @@ export namespace dataproc_v1beta2 { /** * Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. */ - mainRFileUri?: string; + 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; } /** * A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. @@ -1399,7 +1399,7 @@ export namespace dataproc_v1beta2 { /** * Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. */ - jarFileUris?: string[]; + jarFileUris?: string[] | null; /** * Optional. The runtime log config for job execution. */ @@ -1407,11 +1407,11 @@ export namespace dataproc_v1beta2 { /** * 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. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The HCFS URI of the script that contains SQL queries. */ - queryFileUri?: string; + queryFileUri?: string | null; /** * A list of queries. */ @@ -1419,7 +1419,7 @@ export namespace dataproc_v1beta2 { /** * Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). */ - scriptVariables?: {[key: string]: string}; + scriptVariables?: {[key: string]: 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). @@ -1428,15 +1428,15 @@ export namespace dataproc_v1beta2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A request to submit a job. @@ -1449,7 +1449,7 @@ export namespace dataproc_v1beta2 { /** * Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job 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. */ - requestId?: string; + requestId?: string | null; } /** * A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector) @@ -1458,15 +1458,15 @@ export namespace dataproc_v1beta2 { /** * Optional. Brief description of the parameter. Must not exceed 1024 characters. */ - description?: string; + description?: string | null; /** * Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args */ - fields?: string[]; + fields?: string[] | null; /** * Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters. */ - name?: string; + name?: string | null; /** * Optional. Validation rules to be applied to this parameter's value. */ @@ -1479,7 +1479,7 @@ export namespace dataproc_v1beta2 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for TestIamPermissions method. @@ -1488,7 +1488,7 @@ export namespace dataproc_v1beta2 { /** * A subset of TestPermissionsRequest.permissions that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Validation based on a list of allowed values. @@ -1497,7 +1497,7 @@ export namespace dataproc_v1beta2 { /** * Required. List of allowed values for the parameter. */ - values?: string[]; + values?: string[] | null; } /** * The workflow graph. @@ -1515,11 +1515,11 @@ export namespace dataproc_v1beta2 { /** * Output only. The name of the target cluster. */ - clusterName?: string; + clusterName?: string | null; /** * Output only. The UUID of target cluster. */ - clusterUuid?: string; + clusterUuid?: string | null; /** * Output only. The create cluster operation metadata. */ @@ -1531,7 +1531,7 @@ export namespace dataproc_v1beta2 { /** * Output only. Workflow end time. */ - endTime?: string; + endTime?: string | null; /** * Output only. The workflow graph. */ @@ -1539,23 +1539,23 @@ export namespace dataproc_v1beta2 { /** * Map from parameter names to values that were used for those parameters. */ - parameters?: {[key: string]: string}; + parameters?: {[key: string]: string} | null; /** * Output only. Workflow start time. */ - startTime?: string; + startTime?: string | null; /** * Output only. The workflow state. */ - state?: string; + state?: string | null; /** * Output only. The resource name of the workflow template as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} */ - template?: string; + template?: string | null; /** * Output only. The version of template at the time of workflow instantiation. */ - version?: number; + version?: number | null; } /** * The workflow node. @@ -1564,23 +1564,23 @@ export namespace dataproc_v1beta2 { /** * Output only. The error detail. */ - error?: string; + error?: string | null; /** * Output only. The job id; populated after the node enters RUNNING state. */ - jobId?: string; + jobId?: string | null; /** * Output only. Node's prerequisite nodes. */ - prerequisiteStepIds?: string[]; + prerequisiteStepIds?: string[] | null; /** * Output only. The node state. */ - state?: string; + state?: string | null; /** * Output only. The name of the node. */ - stepId?: string; + stepId?: string | null; } /** * A Cloud Dataproc workflow template resource. @@ -1589,11 +1589,11 @@ export namespace dataproc_v1beta2 { /** * Output only. The time template was created. */ - createTime?: string; + createTime?: string | null; /** * Required. The template id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.. */ - id?: string; + id?: string | null; /** * Required. The Directed Acyclic Graph of Jobs to submit. */ @@ -1601,11 +1601,11 @@ export namespace dataproc_v1beta2 { /** * Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.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 template. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} */ - name?: string; + name?: string | null; /** * Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. */ @@ -1617,11 +1617,11 @@ export namespace dataproc_v1beta2 { /** * Output only. The time template was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. */ - version?: number; + version?: number | null; } /** * Specifies workflow execution target.Either managed_cluster or cluster_selector is required. @@ -1643,19 +1643,19 @@ export namespace dataproc_v1beta2 { /** * Required. The application name. */ - name?: string; + name?: string | null; /** * Required. The numerical progress of the application, from 1 to 100. */ - progress?: number; + progress?: number | null; /** * Required. The application state. */ - state?: string; + state?: string | null; /** * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. */ - trackingUrl?: string; + trackingUrl?: string | null; } export class Resource$Projects { @@ -1912,7 +1912,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2340,7 +2340,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** @@ -2650,7 +2650,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3237,7 +3237,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** @@ -3608,7 +3608,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4036,7 +4036,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** @@ -4435,7 +4435,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4923,7 +4923,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** @@ -5267,7 +5267,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5791,7 +5791,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** @@ -6145,7 +6145,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6487,7 +6487,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** @@ -6784,7 +6784,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7371,7 +7371,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index af93cd071e4..c4efbaa133a 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -160,7 +160,7 @@ export namespace datastore_v1 { /** * The transaction identifier (always present). */ - transaction?: string; + transaction?: string | null; } /** * The request for Datastore.Commit. @@ -169,7 +169,7 @@ export namespace datastore_v1 { /** * The type of commit to perform. Defaults to `TRANSACTIONAL`. */ - mode?: string; + mode?: string | null; /** * The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity. */ @@ -177,7 +177,7 @@ export namespace datastore_v1 { /** * The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ - transaction?: string; + transaction?: string | null; } /** * The response for Datastore.Commit. @@ -186,7 +186,7 @@ export namespace datastore_v1 { /** * The number of index entries updated during the commit, or zero if none were updated. */ - indexUpdates?: number; + indexUpdates?: number | null; /** * The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request. */ @@ -203,7 +203,7 @@ export namespace datastore_v1 { /** * The operator for combining multiple filters. */ - op?: string; + op?: 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 `{}`. @@ -220,7 +220,7 @@ export namespace datastore_v1 { /** * The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. */ - properties?: {[key: string]: Schema$Value}; + properties?: {[key: string]: Schema$Value} | null; } /** * The result of fetching an entity from Datastore. @@ -229,7 +229,7 @@ export namespace datastore_v1 { /** * A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message. */ - cursor?: string; + cursor?: string | null; /** * The resulting entity. */ @@ -237,7 +237,7 @@ export namespace datastore_v1 { /** * The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. */ - version?: string; + version?: string | null; } /** * A holder for any type of filter. @@ -259,23 +259,23 @@ export namespace datastore_v1 { /** * The time the operation ended, either successfully or otherwise. */ - endTime?: string; + endTime?: string | null; /** * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The type of the operation. Can be used as a filter in ListOperationsRequest. */ - operationType?: string; + operationType?: string | null; /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; /** * The current state of the Operation. */ - state?: string; + state?: string | null; } /** * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] @@ -284,11 +284,11 @@ export namespace datastore_v1 { /** * If empty, then this represents all kinds. */ - kinds?: string[]; + kinds?: string[] | null; /** * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ - namespaceIds?: string[]; + namespaceIds?: string[] | null; } /** * Metadata for ExportEntities operations. @@ -305,7 +305,7 @@ export namespace datastore_v1 { /** * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. */ - outputUrlPrefix?: string; + outputUrlPrefix?: string | null; /** * An estimate of the number of bytes processed. */ @@ -322,7 +322,7 @@ export namespace datastore_v1 { /** * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ - outputUrl?: string; + outputUrl?: string | null; } /** * Metadata for ImportEntities operations. @@ -339,7 +339,7 @@ export namespace datastore_v1 { /** * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. */ - inputUrl?: string; + inputUrl?: string | null; /** * An estimate of the number of bytes processed. */ @@ -356,11 +356,11 @@ export namespace datastore_v1 { /** * The amount of work that has been completed. Note that this may be greater than work_estimated. */ - workCompleted?: string; + workCompleted?: string | null; /** * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ - workEstimated?: string; + workEstimated?: string | null; } /** * Metadata common to all Datastore Admin operations. @@ -369,23 +369,23 @@ export namespace datastore_v1 { /** * The time the operation ended, either successfully or otherwise. */ - endTime?: string; + endTime?: string | null; /** * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The type of the operation. Can be used as a filter in ListOperationsRequest. */ - operationType?: string; + operationType?: string | null; /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; /** * The current state of the Operation. */ - state?: string; + state?: string | null; } /** * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] @@ -394,11 +394,11 @@ export namespace datastore_v1 { /** * If empty, then this represents all kinds. */ - kinds?: string[]; + kinds?: string[] | null; /** * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ - namespaceIds?: string[]; + namespaceIds?: string[] | null; } /** * Metadata for ExportEntities operations. @@ -415,7 +415,7 @@ export namespace datastore_v1 { /** * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ - outputUrlPrefix?: string; + outputUrlPrefix?: string | null; /** * An estimate of the number of bytes processed. */ @@ -436,11 +436,11 @@ export namespace datastore_v1 { /** * Client-assigned labels. */ - labels?: {[key: string]: string}; + 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. */ - outputUrlPrefix?: string; + outputUrlPrefix?: string | null; } /** * The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities. @@ -449,7 +449,7 @@ export namespace datastore_v1 { /** * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ - outputUrl?: string; + outputUrl?: string | null; } /** * Metadata for ImportEntities operations. @@ -466,7 +466,7 @@ export namespace datastore_v1 { /** * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. */ - inputUrl?: string; + inputUrl?: string | null; /** * An estimate of the number of bytes processed. */ @@ -487,11 +487,11 @@ export namespace datastore_v1 { /** * 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; + inputUrl?: string | null; /** * Client-assigned labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } /** * A minimal index definition. @@ -500,19 +500,19 @@ export namespace datastore_v1 { /** * The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. Required. */ - ancestor?: string; + ancestor?: string | null; /** * The resource ID of the index. Output only. */ - indexId?: string; + indexId?: string | null; /** * The entity kind to which this index applies. Required. */ - kind?: string; + kind?: string | null; /** * Project ID. Output only. */ - projectId?: string; + projectId?: string | null; /** * An ordered sequence of property names and their index attributes. Required. */ @@ -520,7 +520,7 @@ export namespace datastore_v1 { /** * The state of the index. Output only. */ - state?: string; + state?: string | null; } /** * A property of an index. @@ -529,11 +529,11 @@ export namespace datastore_v1 { /** * The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. Required. */ - direction?: string; + direction?: string | null; /** * The property name to index. Required. */ - name?: string; + name?: string | null; } /** * Metadata for Index operations. @@ -546,7 +546,7 @@ export namespace datastore_v1 { /** * The index resource ID that this operation is acting on. */ - indexId?: string; + indexId?: string | null; /** * An estimate of the number of entities processed. */ @@ -563,7 +563,7 @@ export namespace datastore_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Measures the progress of a particular metric. @@ -572,11 +572,11 @@ export namespace datastore_v1 { /** * The amount of work that has been completed. Note that this may be greater than work_estimated. */ - workCompleted?: string; + workCompleted?: string | null; /** * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ - workEstimated?: string; + workEstimated?: string | null; } /** * The response message for Operations.ListOperations. @@ -585,7 +585,7 @@ export namespace datastore_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -598,7 +598,7 @@ export namespace datastore_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -606,15 +606,15 @@ export namespace datastore_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). @@ -623,11 +623,11 @@ export namespace datastore_v1 { /** * When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is. */ - allowLiterals?: boolean; + allowLiterals?: boolean | null; /** * For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `""`. */ - namedBindings?: {[key: string]: Schema$GqlQueryParameter}; + namedBindings?: {[key: string]: Schema$GqlQueryParameter} | null; /** * Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true. */ @@ -635,7 +635,7 @@ export namespace datastore_v1 { /** * A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). */ - queryString?: string; + queryString?: string | null; } /** * A binding parameter for a GQL query. @@ -644,7 +644,7 @@ export namespace datastore_v1 { /** * A query cursor. Query cursors are returned in query result batches. */ - cursor?: string; + cursor?: string | null; /** * A value parameter. */ @@ -670,7 +670,7 @@ export namespace datastore_v1 { /** * The name of the kind. */ - name?: string; + name?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -679,11 +679,11 @@ export namespace datastore_v1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * The request for Datastore.Lookup. @@ -722,7 +722,7 @@ export namespace datastore_v1 { /** * The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. */ - baseVersion?: string; + baseVersion?: string | null; /** * The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. */ @@ -747,7 +747,7 @@ export namespace datastore_v1 { /** * Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation. */ - conflictDetected?: boolean; + conflictDetected?: boolean | null; /** * The automatically allocated key. Set only when the mutation allocated a key. */ @@ -755,7 +755,7 @@ export namespace datastore_v1 { /** * The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity. */ - version?: string; + version?: string | null; } /** * A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. @@ -764,11 +764,11 @@ export namespace datastore_v1 { /** * If not empty, the ID of the namespace to which the entities belong. */ - namespaceId?: string; + namespaceId?: string | null; /** * The ID of the project to which the entities belong. */ - projectId?: string; + projectId?: string | null; } /** * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. @@ -777,15 +777,15 @@ export namespace datastore_v1 { /** * The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. */ - id?: string; + id?: string | null; /** * The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ - kind?: string; + kind?: string | null; /** * The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ - name?: string; + name?: string | null; } /** * A representation of a property in a projection. @@ -803,7 +803,7 @@ export namespace datastore_v1 { /** * The operator to filter by. */ - op?: string; + op?: string | null; /** * The property to filter by. */ @@ -820,7 +820,7 @@ export namespace datastore_v1 { /** * The direction to order by. Defaults to `ASCENDING`. */ - direction?: string; + direction?: string | null; /** * The property to order by. */ @@ -833,7 +833,7 @@ export namespace datastore_v1 { /** * The name of the property. If name includes "."s, it may be interpreted as a property name path. */ - name?: string; + name?: string | null; } /** * A query for entities. @@ -846,7 +846,7 @@ export namespace datastore_v1 { /** * An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ - endCursor?: string; + endCursor?: string | null; /** * The filter to apply. */ @@ -858,11 +858,11 @@ export namespace datastore_v1 { /** * The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. */ - limit?: number; + limit?: number | null; /** * The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified. */ - offset?: number; + offset?: number | null; /** * The order to apply to the query results (if empty, order is unspecified). */ @@ -874,7 +874,7 @@ export namespace datastore_v1 { /** * A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ - startCursor?: string; + startCursor?: string | null; } /** * A batch of results produced by a query. @@ -883,7 +883,7 @@ export namespace datastore_v1 { /** * A cursor that points to the position after the last result in the batch. */ - endCursor?: string; + endCursor?: string | null; /** * The results for this batch. */ @@ -891,23 +891,23 @@ export namespace datastore_v1 { /** * The result type for every entity in `entity_results`. */ - entityResultType?: string; + entityResultType?: string | null; /** * The state of the query after the current batch. */ - moreResults?: string; + moreResults?: string | null; /** * A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0. */ - skippedCursor?: string; + skippedCursor?: string | null; /** * The number of results skipped, typically because of an offset. */ - skippedResults?: number; + skippedResults?: number | null; /** * The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries. */ - snapshotVersion?: string; + snapshotVersion?: string | null; } /** * Options specific to read-only transactions. @@ -920,11 +920,11 @@ export namespace datastore_v1 { /** * The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries. */ - readConsistency?: string; + readConsistency?: string | null; /** * The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ - transaction?: string; + transaction?: string | null; } /** * Options specific to read / write transactions. @@ -933,7 +933,7 @@ export namespace datastore_v1 { /** * The transaction identifier of the transaction being retried. */ - previousTransaction?: string; + previousTransaction?: string | null; } /** * The request for Datastore.ReserveIds. @@ -942,7 +942,7 @@ export namespace datastore_v1 { /** * If not empty, the ID of the database against which to make the request. */ - databaseId?: string; + databaseId?: string | null; /** * A list of keys with complete key paths whose numeric IDs should not be auto-allocated. */ @@ -959,7 +959,7 @@ export namespace datastore_v1 { /** * The transaction identifier, returned by a call to Datastore.BeginTransaction. */ - transaction?: string; + transaction?: string | null; } /** * The response for Datastore.Rollback. (an empty message). @@ -1006,15 +1006,15 @@ export namespace datastore_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. @@ -1040,15 +1040,15 @@ export namespace datastore_v1 { /** * A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. */ - blobValue?: string; + blobValue?: string | null; /** * A boolean value. */ - booleanValue?: boolean; + booleanValue?: boolean | null; /** * A double value. */ - doubleValue?: number; + doubleValue?: number | null; /** * An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. */ @@ -1056,7 +1056,7 @@ export namespace datastore_v1 { /** * If the value should be excluded from all indexes including those defined explicitly. */ - excludeFromIndexes?: boolean; + excludeFromIndexes?: boolean | null; /** * A geo point value representing a point on the surface of Earth. */ @@ -1064,7 +1064,7 @@ export namespace datastore_v1 { /** * An integer value. */ - integerValue?: string; + integerValue?: string | null; /** * A key value. */ @@ -1072,19 +1072,19 @@ export namespace datastore_v1 { /** * The `meaning` field should only be populated for backwards compatibility. */ - meaning?: number; + meaning?: number | null; /** * A null value. */ - nullValue?: string; + nullValue?: string | null; /** * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes. */ - stringValue?: string; + stringValue?: string | null; /** * A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. */ - timestampValue?: string; + timestampValue?: string | null; } export class Resource$Projects { diff --git a/src/apis/datastore/v1beta1.ts b/src/apis/datastore/v1beta1.ts index bb73a73d96b..821791ac2b3 100644 --- a/src/apis/datastore/v1beta1.ts +++ b/src/apis/datastore/v1beta1.ts @@ -124,23 +124,23 @@ export namespace datastore_v1beta1 { /** * The time the operation ended, either successfully or otherwise. */ - endTime?: string; + endTime?: string | null; /** * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The type of the operation. Can be used as a filter in ListOperationsRequest. */ - operationType?: string; + operationType?: string | null; /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; /** * The current state of the Operation. */ - state?: string; + state?: string | null; } /** * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] @@ -149,11 +149,11 @@ export namespace datastore_v1beta1 { /** * If empty, then this represents all kinds. */ - kinds?: string[]; + kinds?: string[] | null; /** * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ - namespaceIds?: string[]; + namespaceIds?: string[] | null; } /** * Metadata for ExportEntities operations. @@ -170,7 +170,7 @@ export namespace datastore_v1beta1 { /** * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. */ - outputUrlPrefix?: string; + outputUrlPrefix?: string | null; /** * An estimate of the number of bytes processed. */ @@ -191,11 +191,11 @@ export namespace datastore_v1beta1 { /** * Client-assigned labels. */ - labels?: {[key: string]: string}; + 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.v1beta1.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; + outputUrlPrefix?: string | null; } /** * The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. @@ -204,7 +204,7 @@ export namespace datastore_v1beta1 { /** * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ - outputUrl?: string; + outputUrl?: string | null; } /** * Metadata for ImportEntities operations. @@ -221,7 +221,7 @@ export namespace datastore_v1beta1 { /** * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. */ - inputUrl?: string; + inputUrl?: string | null; /** * An estimate of the number of bytes processed. */ @@ -242,11 +242,11 @@ export namespace datastore_v1beta1 { /** * 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.v1beta1.ExportEntitiesResponse.output_url. */ - inputUrl?: string; + inputUrl?: string | null; /** * Client-assigned labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; } /** * Measures the progress of a particular metric. @@ -255,11 +255,11 @@ export namespace datastore_v1beta1 { /** * The amount of work that has been completed. Note that this may be greater than work_estimated. */ - workCompleted?: string; + workCompleted?: string | null; /** * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ - workEstimated?: string; + workEstimated?: string | null; } /** * Metadata common to all Datastore Admin operations. @@ -268,23 +268,23 @@ export namespace datastore_v1beta1 { /** * The time the operation ended, either successfully or otherwise. */ - endTime?: string; + endTime?: string | null; /** * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The type of the operation. Can be used as a filter in ListOperationsRequest. */ - operationType?: string; + operationType?: string | null; /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; /** * The current state of the Operation. */ - state?: string; + state?: string | null; } /** * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] @@ -293,11 +293,11 @@ export namespace datastore_v1beta1 { /** * If empty, then this represents all kinds. */ - kinds?: string[]; + kinds?: string[] | null; /** * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ - namespaceIds?: string[]; + namespaceIds?: string[] | null; } /** * Metadata for ExportEntities operations. @@ -314,7 +314,7 @@ export namespace datastore_v1beta1 { /** * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ - outputUrlPrefix?: string; + outputUrlPrefix?: string | null; /** * An estimate of the number of bytes processed. */ @@ -331,7 +331,7 @@ export namespace datastore_v1beta1 { /** * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ - outputUrl?: string; + outputUrl?: string | null; } /** * Metadata for ImportEntities operations. @@ -348,7 +348,7 @@ export namespace datastore_v1beta1 { /** * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. */ - inputUrl?: string; + inputUrl?: string | null; /** * An estimate of the number of bytes processed. */ @@ -369,7 +369,7 @@ export namespace datastore_v1beta1 { /** * The index resource ID that this operation is acting on. */ - indexId?: string; + indexId?: string | null; /** * An estimate of the number of entities processed. */ @@ -382,11 +382,11 @@ export namespace datastore_v1beta1 { /** * The amount of work that has been completed. Note that this may be greater than work_estimated. */ - workCompleted?: string; + workCompleted?: string | null; /** * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ - workEstimated?: string; + workEstimated?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -395,7 +395,7 @@ export namespace datastore_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -403,15 +403,15 @@ export namespace datastore_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -420,15 +420,15 @@ export namespace datastore_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index 0a1fe2beee7..8d1a53ae119 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -160,7 +160,7 @@ export namespace datastore_v1beta3 { /** * The transaction identifier (always present). */ - transaction?: string; + transaction?: string | null; } /** * The request for Datastore.Commit. @@ -169,7 +169,7 @@ export namespace datastore_v1beta3 { /** * The type of commit to perform. Defaults to `TRANSACTIONAL`. */ - mode?: string; + mode?: string | null; /** * The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity. */ @@ -177,7 +177,7 @@ export namespace datastore_v1beta3 { /** * The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ - transaction?: string; + transaction?: string | null; } /** * The response for Datastore.Commit. @@ -186,7 +186,7 @@ export namespace datastore_v1beta3 { /** * The number of index entries updated during the commit, or zero if none were updated. */ - indexUpdates?: number; + indexUpdates?: number | null; /** * The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request. */ @@ -203,7 +203,7 @@ export namespace datastore_v1beta3 { /** * The operator for combining multiple filters. */ - op?: string; + op?: string | null; } /** * A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. @@ -216,7 +216,7 @@ export namespace datastore_v1beta3 { /** * The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. */ - properties?: {[key: string]: Schema$Value}; + properties?: {[key: string]: Schema$Value} | null; } /** * The result of fetching an entity from Datastore. @@ -225,7 +225,7 @@ export namespace datastore_v1beta3 { /** * A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message. */ - cursor?: string; + cursor?: string | null; /** * The resulting entity. */ @@ -233,7 +233,7 @@ export namespace datastore_v1beta3 { /** * The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. */ - version?: string; + version?: string | null; } /** * A holder for any type of filter. @@ -255,23 +255,23 @@ export namespace datastore_v1beta3 { /** * The time the operation ended, either successfully or otherwise. */ - endTime?: string; + endTime?: string | null; /** * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The type of the operation. Can be used as a filter in ListOperationsRequest. */ - operationType?: string; + operationType?: string | null; /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; /** * The current state of the Operation. */ - state?: string; + state?: string | null; } /** * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] @@ -280,11 +280,11 @@ export namespace datastore_v1beta3 { /** * If empty, then this represents all kinds. */ - kinds?: string[]; + kinds?: string[] | null; /** * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ - namespaceIds?: string[]; + namespaceIds?: string[] | null; } /** * Metadata for ExportEntities operations. @@ -301,7 +301,7 @@ export namespace datastore_v1beta3 { /** * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. */ - outputUrlPrefix?: string; + outputUrlPrefix?: string | null; /** * An estimate of the number of bytes processed. */ @@ -318,7 +318,7 @@ export namespace datastore_v1beta3 { /** * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ - outputUrl?: string; + outputUrl?: string | null; } /** * Metadata for ImportEntities operations. @@ -335,7 +335,7 @@ export namespace datastore_v1beta3 { /** * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. */ - inputUrl?: string; + inputUrl?: string | null; /** * An estimate of the number of bytes processed. */ @@ -352,11 +352,11 @@ export namespace datastore_v1beta3 { /** * The amount of work that has been completed. Note that this may be greater than work_estimated. */ - workCompleted?: string; + workCompleted?: string | null; /** * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ - workEstimated?: string; + workEstimated?: string | null; } /** * Metadata common to all Datastore Admin operations. @@ -365,23 +365,23 @@ export namespace datastore_v1beta3 { /** * The time the operation ended, either successfully or otherwise. */ - endTime?: string; + endTime?: string | null; /** * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The type of the operation. Can be used as a filter in ListOperationsRequest. */ - operationType?: string; + operationType?: string | null; /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; /** * The current state of the Operation. */ - state?: string; + state?: string | null; } /** * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] @@ -390,11 +390,11 @@ export namespace datastore_v1beta3 { /** * If empty, then this represents all kinds. */ - kinds?: string[]; + kinds?: string[] | null; /** * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ - namespaceIds?: string[]; + namespaceIds?: string[] | null; } /** * Metadata for ExportEntities operations. @@ -411,7 +411,7 @@ export namespace datastore_v1beta3 { /** * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ - outputUrlPrefix?: string; + outputUrlPrefix?: string | null; /** * An estimate of the number of bytes processed. */ @@ -428,7 +428,7 @@ export namespace datastore_v1beta3 { /** * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ - outputUrl?: string; + outputUrl?: string | null; } /** * Metadata for ImportEntities operations. @@ -445,7 +445,7 @@ export namespace datastore_v1beta3 { /** * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. */ - inputUrl?: string; + inputUrl?: string | null; /** * An estimate of the number of bytes processed. */ @@ -466,7 +466,7 @@ export namespace datastore_v1beta3 { /** * The index resource ID that this operation is acting on. */ - indexId?: string; + indexId?: string | null; /** * An estimate of the number of entities processed. */ @@ -479,11 +479,11 @@ export namespace datastore_v1beta3 { /** * The amount of work that has been completed. Note that this may be greater than work_estimated. */ - workCompleted?: string; + workCompleted?: string | null; /** * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ - workEstimated?: string; + workEstimated?: string | null; } /** * A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). @@ -492,11 +492,11 @@ export namespace datastore_v1beta3 { /** * When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is. */ - allowLiterals?: boolean; + allowLiterals?: boolean | null; /** * For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `""`. */ - namedBindings?: {[key: string]: Schema$GqlQueryParameter}; + namedBindings?: {[key: string]: Schema$GqlQueryParameter} | null; /** * Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true. */ @@ -504,7 +504,7 @@ export namespace datastore_v1beta3 { /** * A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). */ - queryString?: string; + queryString?: string | null; } /** * A binding parameter for a GQL query. @@ -513,7 +513,7 @@ export namespace datastore_v1beta3 { /** * A query cursor. Query cursors are returned in query result batches. */ - cursor?: string; + cursor?: string | null; /** * A value parameter. */ @@ -539,7 +539,7 @@ export namespace datastore_v1beta3 { /** * The name of the kind. */ - name?: string; + name?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -548,11 +548,11 @@ export namespace datastore_v1beta3 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * The request for Datastore.Lookup. @@ -591,7 +591,7 @@ export namespace datastore_v1beta3 { /** * The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. */ - baseVersion?: string; + baseVersion?: string | null; /** * The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. */ @@ -616,7 +616,7 @@ export namespace datastore_v1beta3 { /** * Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation. */ - conflictDetected?: boolean; + conflictDetected?: boolean | null; /** * The automatically allocated key. Set only when the mutation allocated a key. */ @@ -624,7 +624,7 @@ export namespace datastore_v1beta3 { /** * The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity. */ - version?: string; + version?: string | null; } /** * A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. @@ -633,11 +633,11 @@ export namespace datastore_v1beta3 { /** * If not empty, the ID of the namespace to which the entities belong. */ - namespaceId?: string; + namespaceId?: string | null; /** * The ID of the project to which the entities belong. */ - projectId?: string; + projectId?: string | null; } /** * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. @@ -646,15 +646,15 @@ export namespace datastore_v1beta3 { /** * The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. */ - id?: string; + id?: string | null; /** * The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ - kind?: string; + kind?: string | null; /** * The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ - name?: string; + name?: string | null; } /** * A representation of a property in a projection. @@ -672,7 +672,7 @@ export namespace datastore_v1beta3 { /** * The operator to filter by. */ - op?: string; + op?: string | null; /** * The property to filter by. */ @@ -689,7 +689,7 @@ export namespace datastore_v1beta3 { /** * The direction to order by. Defaults to `ASCENDING`. */ - direction?: string; + direction?: string | null; /** * The property to order by. */ @@ -702,7 +702,7 @@ export namespace datastore_v1beta3 { /** * The name of the property. If name includes "."s, it may be interpreted as a property name path. */ - name?: string; + name?: string | null; } /** * A query for entities. @@ -715,7 +715,7 @@ export namespace datastore_v1beta3 { /** * An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ - endCursor?: string; + endCursor?: string | null; /** * The filter to apply. */ @@ -727,11 +727,11 @@ export namespace datastore_v1beta3 { /** * The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. */ - limit?: number; + limit?: number | null; /** * The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified. */ - offset?: number; + offset?: number | null; /** * The order to apply to the query results (if empty, order is unspecified). */ @@ -743,7 +743,7 @@ export namespace datastore_v1beta3 { /** * A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ - startCursor?: string; + startCursor?: string | null; } /** * A batch of results produced by a query. @@ -752,7 +752,7 @@ export namespace datastore_v1beta3 { /** * A cursor that points to the position after the last result in the batch. */ - endCursor?: string; + endCursor?: string | null; /** * The results for this batch. */ @@ -760,23 +760,23 @@ export namespace datastore_v1beta3 { /** * The result type for every entity in `entity_results`. */ - entityResultType?: string; + entityResultType?: string | null; /** * The state of the query after the current batch. */ - moreResults?: string; + moreResults?: string | null; /** * A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0. */ - skippedCursor?: string; + skippedCursor?: string | null; /** * The number of results skipped, typically because of an offset. */ - skippedResults?: number; + skippedResults?: number | null; /** * The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries. */ - snapshotVersion?: string; + snapshotVersion?: string | null; } /** * Options specific to read-only transactions. @@ -789,11 +789,11 @@ export namespace datastore_v1beta3 { /** * The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries. */ - readConsistency?: string; + readConsistency?: string | null; /** * The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ - transaction?: string; + transaction?: string | null; } /** * Options specific to read / write transactions. @@ -802,7 +802,7 @@ export namespace datastore_v1beta3 { /** * The transaction identifier of the transaction being retried. */ - previousTransaction?: string; + previousTransaction?: string | null; } /** * The request for Datastore.ReserveIds. @@ -811,7 +811,7 @@ export namespace datastore_v1beta3 { /** * If not empty, the ID of the database against which to make the request. */ - databaseId?: string; + databaseId?: string | null; /** * A list of keys with complete key paths whose numeric IDs should not be auto-allocated. */ @@ -828,7 +828,7 @@ export namespace datastore_v1beta3 { /** * The transaction identifier, returned by a call to Datastore.BeginTransaction. */ - transaction?: string; + transaction?: string | null; } /** * The response for Datastore.Rollback. (an empty message). @@ -892,15 +892,15 @@ export namespace datastore_v1beta3 { /** * A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. */ - blobValue?: string; + blobValue?: string | null; /** * A boolean value. */ - booleanValue?: boolean; + booleanValue?: boolean | null; /** * A double value. */ - doubleValue?: number; + doubleValue?: number | null; /** * An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. */ @@ -908,7 +908,7 @@ export namespace datastore_v1beta3 { /** * If the value should be excluded from all indexes including those defined explicitly. */ - excludeFromIndexes?: boolean; + excludeFromIndexes?: boolean | null; /** * A geo point value representing a point on the surface of Earth. */ @@ -916,7 +916,7 @@ export namespace datastore_v1beta3 { /** * An integer value. */ - integerValue?: string; + integerValue?: string | null; /** * A key value. */ @@ -924,19 +924,19 @@ export namespace datastore_v1beta3 { /** * The `meaning` field should only be populated for backwards compatibility. */ - meaning?: number; + meaning?: number | null; /** * A null value. */ - nullValue?: string; + nullValue?: string | null; /** * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes. */ - stringValue?: string; + stringValue?: string | null; /** * A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. */ - timestampValue?: string; + timestampValue?: string | null; } export class Resource$Projects { diff --git a/src/apis/deploymentmanager/alpha.ts b/src/apis/deploymentmanager/alpha.ts index 86dea763525..b3d491f3383 100644 --- a/src/apis/deploymentmanager/alpha.ts +++ b/src/apis/deploymentmanager/alpha.ts @@ -120,7 +120,7 @@ export namespace deploymentmanager_alpha { /** * Method regex where this policy will apply. */ - methodMatch?: string; + methodMatch?: string | null; /** * Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. */ @@ -134,11 +134,11 @@ export namespace deploymentmanager_alpha { * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ - service?: string; + 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. @@ -147,11 +147,11 @@ export namespace deploymentmanager_alpha { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Authorization-related information used by Cloud Audit Logging. @@ -160,14 +160,14 @@ export namespace deploymentmanager_alpha { /** * The type of the permission that was checked. */ - permissionType?: string; + permissionType?: string | null; } /** * Basic Auth used as a credential. */ export interface Schema$BasicAuth { - password?: string; - user?: string; + password?: string | null; + user?: string | null; } /** * Associates `members` with a `role`. @@ -180,11 +180,11 @@ export namespace deploymentmanager_alpha { /** * 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}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * CollectionOverride allows resource handling overrides for specific resources within a BaseType @@ -193,7 +193,7 @@ export namespace deploymentmanager_alpha { /** * The collection that identifies this resource within its service. */ - collection?: string; + collection?: string | null; /** * Custom verb method mappings to support unordered list API mappings. */ @@ -210,12 +210,12 @@ export namespace deploymentmanager_alpha { /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; - id?: string; + description?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -223,7 +223,7 @@ export namespace deploymentmanager_alpha { /** * Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]{0,61}[a-z0-9])?. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this composite type. */ @@ -231,16 +231,16 @@ export namespace deploymentmanager_alpha { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; - status?: string; + selfLink?: string | null; + status?: string | null; /** * Files for the template type. */ templateContents?: Schema$TemplateContents; } export interface Schema$CompositeTypeLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } /** * A response that returns all Composite Types supported by Deployment Manager @@ -253,7 +253,7 @@ export namespace deploymentmanager_alpha { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A condition to be met. @@ -262,33 +262,33 @@ export namespace deploymentmanager_alpha { /** * Trusted attributes supplied by the IAM system. */ - iam?: string; + iam?: string | null; /** * An operator to apply the subject with. */ - op?: string; + op?: string | null; /** * Trusted attributes discharged by the service. */ - svc?: string; + svc?: string | null; /** * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ - sys?: string; + sys?: string | null; /** * DEPRECATED. Use 'values' instead. */ - value?: string; + value?: string | null; /** * The objects of the condition. This is mutually exclusive with 'value'. */ - values?: string[]; + values?: string[] | null; } export interface Schema$ConfigFile { /** * The contents of the file. */ - content?: string; + content?: string | null; } /** * BaseType that describes a service-backed Type. @@ -305,7 +305,7 @@ export namespace deploymentmanager_alpha { /** * Descriptor Url for the this type. */ - descriptorUrl?: string; + descriptorUrl?: string | null; /** * Options to apply when handling any resources in this service. */ @@ -326,7 +326,7 @@ export namespace deploymentmanager_alpha { /** * Specify to use the project default credential, only supported by Deployment. */ - useProjectDefault?: boolean; + useProjectDefault?: boolean | null; } export interface Schema$Deployment { /** @@ -336,16 +336,16 @@ export namespace deploymentmanager_alpha { /** * An optional user-provided description of the deployment. */ - description?: string; + description?: string | null; /** * Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. */ - fingerprint?: string; - id?: string; + fingerprint?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -353,11 +353,11 @@ export namespace deploymentmanager_alpha { /** * Output only. URL of the manifest representing the last manifest that was successfully deployed. */ - manifest?: string; + manifest?: string | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this deployment. */ @@ -369,7 +369,7 @@ export namespace deploymentmanager_alpha { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. */ @@ -381,21 +381,21 @@ export namespace deploymentmanager_alpha { /** * Output only. Update timestamp in RFC3339 text format. */ - updateTime?: string; + updateTime?: string | null; } export interface Schema$DeploymentLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export interface Schema$DeploymentOutputsEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export interface Schema$DeploymentsCancelPreviewRequest { /** * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ - fingerprint?: string; + fingerprint?: string | null; } /** * A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. @@ -408,13 +408,13 @@ export namespace deploymentmanager_alpha { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$DeploymentsStopRequest { /** * Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ - fingerprint?: string; + fingerprint?: string | null; } export interface Schema$DeploymentUpdate { /** @@ -424,7 +424,7 @@ export namespace deploymentmanager_alpha { /** * Output only. An optional user-provided description of the deployment after the current update has been applied. */ - description?: string; + description?: string | null; /** * Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -432,21 +432,21 @@ export namespace deploymentmanager_alpha { /** * Output only. URL of the manifest representing the update configuration of this deployment. */ - manifest?: string; + manifest?: string | null; } export interface Schema$DeploymentUpdateLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export interface Schema$Diagnostic { /** * JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. */ - field?: string; + field?: string | null; /** * Level to record this diagnostic. */ - level?: string; + level?: 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" @@ -455,19 +455,19 @@ export namespace deploymentmanager_alpha { /** * 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; + 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; + 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; + 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; + title?: string | null; } export interface Schema$GlobalSetPolicyRequest { /** @@ -477,7 +477,7 @@ export namespace deploymentmanager_alpha { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -487,11 +487,11 @@ export namespace deploymentmanager_alpha { /** * The contents of the file. */ - content?: string; + content?: string | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. @@ -500,19 +500,19 @@ export namespace deploymentmanager_alpha { /** * The name of the field that is going to be injected. */ - fieldName?: string; + fieldName?: string | null; /** * The location where this mapping applies. */ - location?: string; + location?: string | null; /** * Regex to evaluate on method to decide if input applies. */ - methodMatch?: string; + methodMatch?: string | null; /** * A jsonPath expression to select an element. */ - value?: string; + value?: string | null; } /** * Specifies what kind of log the caller must write @@ -542,7 +542,7 @@ export namespace deploymentmanager_alpha { /** * The log_name to populate in the Cloud Audit Record. */ - logName?: string; + logName?: string | null; } /** * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). @@ -551,11 +551,11 @@ export namespace deploymentmanager_alpha { /** * The field value to attribute. */ - field?: string; + field?: string | null; /** * The metric to update. */ - metric?: string; + metric?: string | null; } /** * Write a Data Access (Gin) log @@ -564,7 +564,7 @@ export namespace deploymentmanager_alpha { /** * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ - logMode?: string; + logMode?: string | null; } export interface Schema$Manifest { /** @@ -574,8 +574,8 @@ export namespace deploymentmanager_alpha { /** * Output only. The fully-expanded configuration file, including any templates and references. */ - expandedConfig?: string; - id?: string; + expandedConfig?: string | null; + id?: string | null; /** * Output only. The imported files for this manifest. */ @@ -583,19 +583,19 @@ export namespace deploymentmanager_alpha { /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Output only. The YAML layout for this manifest. */ - layout?: string; + layout?: string | null; /** * Output only. The name of the manifest. */ - name?: string; + name?: string | null; /** * Output only. Self link for the manifest. */ - selfLink?: string; + selfLink?: string | null; } /** * A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated. @@ -608,7 +608,7 @@ export namespace deploymentmanager_alpha { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy @@ -617,23 +617,23 @@ export namespace deploymentmanager_alpha { /** * The action identifier for the create method to be used for this collection */ - create?: string; + create?: string | null; /** * The action identifier for the delete method to be used for this collection */ - delete?: string; + delete?: string | null; /** * The action identifier for the get method to be used for this collection */ - get?: string; + get?: string | null; /** * The action identifier for the setIamPolicy method to be used for this collection */ - setIamPolicy?: string; + setIamPolicy?: string | null; /** * The action identifier for the update method to be used for this collection */ - update?: string; + update?: string | null; } /** * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) @@ -642,89 +642,89 @@ export namespace deploymentmanager_alpha { /** * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ - clientOperationId?: string; + clientOperationId?: string | null; /** * [Deprecated] This field is deprecated. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] A textual description of the operation, which is set when the operation is created. */ - description?: string; + description?: string | null; /** * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ - endTime?: string; + endTime?: string | null; /** * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ - httpErrorMessage?: string; + httpErrorMessage?: string | null; /** * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ - httpErrorStatusCode?: number; + httpErrorStatusCode?: number | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ - operationType?: string; + operationType?: string | null; /** * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ - progress?: number; + progress?: number | null; /** * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ - status?: string; + status?: string | null; /** * [Output Only] An optional textual description of the current status of the operation. */ - statusMessage?: string; + statusMessage?: string | null; /** * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ - targetId?: string; + targetId?: string | null; /** * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ - targetLink?: string; + targetLink?: string | null; /** * [Output Only] User who requested the operation, for example: user@example.com. */ - user?: string; + user?: string | null; /** * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ @@ -732,11 +732,11 @@ export namespace deploymentmanager_alpha { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; /** * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } /** * A response containing a partial list of operations and a page token used to build the next request if the request has been truncated. @@ -745,7 +745,7 @@ export namespace deploymentmanager_alpha { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. Operations contained in this list response. */ @@ -766,7 +766,7 @@ export namespace deploymentmanager_alpha { /** * The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. */ - nameProperty?: string; + nameProperty?: string | null; /** * Options for how to validate and process properties on a resource. */ @@ -787,8 +787,8 @@ export namespace deploymentmanager_alpha { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ - etag?: string; - iamOwned?: boolean; + etag?: string | null; + iamOwned?: boolean | null; /** * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ @@ -796,7 +796,7 @@ export namespace deploymentmanager_alpha { /** * Deprecated. */ - version?: number; + version?: number | null; } export interface Schema$PollingOptions { /** @@ -806,19 +806,19 @@ export namespace deploymentmanager_alpha { /** * JsonPath expression that determines if the request failed. */ - failCondition?: string; + failCondition?: string | null; /** * JsonPath expression that determines if the request is completed. */ - finishCondition?: string; + finishCondition?: string | null; /** * JsonPath expression that evaluates to string, it indicates where to poll. */ - pollingLink?: string; + pollingLink?: string | null; /** * JsonPath expression, after polling is completed, indicates where to fetch the resource. */ - targetLink?: string; + targetLink?: string | null; } export interface Schema$Resource { /** @@ -828,12 +828,12 @@ export namespace deploymentmanager_alpha { /** * Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. */ - finalProperties?: string; - id?: string; + finalProperties?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Output only. The last used credential that successfully created/updated the resource. */ @@ -841,23 +841,23 @@ export namespace deploymentmanager_alpha { /** * Output only. URL of the manifest representing the current configuration of this resource. */ - manifest?: string; + manifest?: string | null; /** * Output only. The name of the resource as it appears in the YAML config. */ - name?: string; + name?: string | null; /** * Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. */ - properties?: string; + properties?: string | null; /** * Output only. In case this is an action, it will show the runtimePolicies on which this action will run in the deployment */ - runtimePolicies?: string[]; + runtimePolicies?: string[] | null; /** * Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. */ - type?: string; + type?: string | null; /** * Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. */ @@ -865,11 +865,11 @@ export namespace deploymentmanager_alpha { /** * Output only. Update timestamp in RFC3339 text format. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. The URL of the actual resource. */ - url?: string; + url?: string | null; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ @@ -877,7 +877,7 @@ export namespace deploymentmanager_alpha { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * The access controls set on the resource. @@ -886,7 +886,7 @@ export namespace deploymentmanager_alpha { /** * The GCP IAM Policy to set on the resource. */ - gcpIamPolicy?: string; + gcpIamPolicy?: string | null; } /** * A response containing a partial list of resources and a page token used to build the next request if the request has been truncated. @@ -895,7 +895,7 @@ export namespace deploymentmanager_alpha { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Resources contained in this list response. */ @@ -915,31 +915,31 @@ export namespace deploymentmanager_alpha { */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. */ - finalProperties?: string; + finalProperties?: string | null; /** * Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. */ - intent?: string; + intent?: string | null; /** * Output only. URL of the manifest representing the update configuration of this resource. */ - manifest?: string; + manifest?: string | null; /** * Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. */ - properties?: string; + properties?: string | null; /** * Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment. */ - runtimePolicies?: string[]; + runtimePolicies?: string[] | null; /** * Output only. The state of the resource. */ - state?: string; + state?: string | null; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ @@ -947,7 +947,7 @@ export namespace deploymentmanager_alpha { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * A rule to be applied in a Policy. @@ -956,7 +956,7 @@ export namespace deploymentmanager_alpha { /** * Required */ - action?: string; + action?: string | null; /** * Additional restrictions that must be met. All conditions must pass for the rule to match. */ @@ -964,11 +964,11 @@ export namespace deploymentmanager_alpha { /** * Human-readable description of the rule. */ - description?: string; + description?: string | null; /** * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ - ins?: string[]; + ins?: string[] | null; /** * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ @@ -976,11 +976,11 @@ export namespace deploymentmanager_alpha { /** * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ - notIns?: string[]; + notIns?: string[] | null; /** * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Service Account used as a credential. @@ -989,7 +989,7 @@ export namespace deploymentmanager_alpha { /** * The IAM service account email address like test@myproject.iam.gserviceaccount.com */ - email?: string; + email?: string | null; } export interface Schema$TargetConfiguration { /** @@ -1012,31 +1012,31 @@ export namespace deploymentmanager_alpha { /** * Which interpreter (python or jinja) should be used during expansion. */ - interpreter?: string; + interpreter?: string | null; /** * The filename of the mainTemplate */ - mainTemplate?: string; + mainTemplate?: string | null; /** * The contents of the template schema. */ - schema?: string; + schema?: string | null; /** * The contents of the main template file. */ - template?: string; + template?: string | null; } export interface Schema$TestPermissionsRequest { /** * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export interface Schema$TestPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A resource type supported by Deployment Manager. @@ -1049,12 +1049,12 @@ export namespace deploymentmanager_alpha { /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; - id?: string; + description?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -1062,7 +1062,7 @@ export namespace deploymentmanager_alpha { /** * Name of the type. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this type. */ @@ -1070,7 +1070,7 @@ export namespace deploymentmanager_alpha { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. @@ -1079,19 +1079,19 @@ export namespace deploymentmanager_alpha { /** * The description of the type. */ - description?: string; + description?: string | null; /** * For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. */ - documentationLink?: string; + documentationLink?: string | null; /** * Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. */ - kind?: string; + kind?: string | null; /** * The base type or composite type name. */ - name?: string; + name?: string | null; /** * For base types with a collection, we return a schema and documentation link For template types, we return only a schema */ @@ -1099,25 +1099,25 @@ export namespace deploymentmanager_alpha { /** * Output only. Self link for the type provider. */ - selfLink?: string; + selfLink?: string | null; /** * The title on the API descriptor URL provided. */ - title?: string; + title?: string | null; } export interface Schema$TypeInfoSchemaInfo { /** * The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4 */ - input?: string; + input?: string | null; /** * The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4 */ - output?: string; + output?: string | null; } export interface Schema$TypeLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } /** * A type provider that describes a service-backed Type. @@ -1134,19 +1134,19 @@ export namespace deploymentmanager_alpha { /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; + description?: string | null; /** * Descriptor Url for the this type provider. */ - descriptorUrl?: string; + descriptorUrl?: string | null; /** * Output only. Unique identifier for the resource defined by the server. */ - id?: string; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -1154,7 +1154,7 @@ export namespace deploymentmanager_alpha { /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this type provider. */ @@ -1166,11 +1166,11 @@ export namespace deploymentmanager_alpha { /** * Output only. Self link for the type provider. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$TypeProviderLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } /** * A response that returns all Type Providers supported by Deployment Manager @@ -1179,7 +1179,7 @@ export namespace deploymentmanager_alpha { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. A list of resource type providers supported by Deployment Manager. */ @@ -1189,7 +1189,7 @@ export namespace deploymentmanager_alpha { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. A list of resource type info. */ @@ -1202,7 +1202,7 @@ export namespace deploymentmanager_alpha { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. A list of resource types supported by Deployment Manager. */ @@ -1215,11 +1215,11 @@ export namespace deploymentmanager_alpha { /** * Customize how deployment manager will validate the resource against schema errors. */ - schemaValidation?: string; + schemaValidation?: string | null; /** * Specify what to do with extra properties when executing a request. */ - undeclaredProperties?: string; + undeclaredProperties?: string | null; } export class Resource$Compositetypes { diff --git a/src/apis/deploymentmanager/v2.ts b/src/apis/deploymentmanager/v2.ts index eff277ece12..6580e2cefb7 100644 --- a/src/apis/deploymentmanager/v2.ts +++ b/src/apis/deploymentmanager/v2.ts @@ -117,11 +117,11 @@ export namespace deploymentmanager_v2 { * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ - service?: string; + 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. @@ -130,11 +130,11 @@ export namespace deploymentmanager_v2 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Authorization-related information used by Cloud Audit Logging. @@ -143,7 +143,7 @@ export namespace deploymentmanager_v2 { /** * The type of the permission that was checked. */ - permissionType?: string; + permissionType?: string | null; } /** * Associates `members` with a `role`. @@ -156,11 +156,11 @@ export namespace deploymentmanager_v2 { /** * 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}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A condition to be met. @@ -169,48 +169,48 @@ export namespace deploymentmanager_v2 { /** * Trusted attributes supplied by the IAM system. */ - iam?: string; + iam?: string | null; /** * An operator to apply the subject with. */ - op?: string; + op?: string | null; /** * Trusted attributes discharged by the service. */ - svc?: string; + svc?: string | null; /** * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ - sys?: string; + sys?: string | null; /** * DEPRECATED. Use 'values' instead. */ - value?: string; + value?: string | null; /** * The objects of the condition. This is mutually exclusive with 'value'. */ - values?: string[]; + values?: string[] | null; } export interface Schema$ConfigFile { /** * The contents of the file. */ - content?: string; + content?: string | null; } export interface Schema$Deployment { /** * An optional user-provided description of the deployment. */ - description?: string; + description?: string | null; /** * Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. */ - fingerprint?: string; - id?: string; + fingerprint?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -218,11 +218,11 @@ export namespace deploymentmanager_v2 { /** * Output only. URL of the manifest representing the last manifest that was successfully deployed. */ - manifest?: string; + manifest?: string | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this deployment. */ @@ -230,7 +230,7 @@ export namespace deploymentmanager_v2 { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. */ @@ -242,17 +242,17 @@ export namespace deploymentmanager_v2 { /** * Output only. Update timestamp in RFC3339 text format. */ - updateTime?: string; + updateTime?: string | null; } export interface Schema$DeploymentLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export interface Schema$DeploymentsCancelPreviewRequest { /** * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ - fingerprint?: string; + fingerprint?: string | null; } /** * A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. @@ -265,19 +265,19 @@ export namespace deploymentmanager_v2 { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$DeploymentsStopRequest { /** * Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ - fingerprint?: string; + fingerprint?: string | null; } export interface Schema$DeploymentUpdate { /** * Output only. An optional user-provided description of the deployment after the current update has been applied. */ - description?: string; + description?: string | null; /** * Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -285,11 +285,11 @@ export namespace deploymentmanager_v2 { /** * Output only. URL of the manifest representing the update configuration of this deployment. */ - manifest?: string; + manifest?: string | null; } export interface Schema$DeploymentUpdateLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: 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" @@ -298,19 +298,19 @@ export namespace deploymentmanager_v2 { /** * 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; + 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; + 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; + 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; + title?: string | null; } export interface Schema$GlobalSetPolicyRequest { /** @@ -320,7 +320,7 @@ export namespace deploymentmanager_v2 { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -330,11 +330,11 @@ export namespace deploymentmanager_v2 { /** * The contents of the file. */ - content?: string; + content?: string | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * Specifies what kind of log the caller must write @@ -364,7 +364,7 @@ export namespace deploymentmanager_v2 { /** * The log_name to populate in the Cloud Audit Record. */ - logName?: string; + logName?: string | null; } /** * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). @@ -373,11 +373,11 @@ export namespace deploymentmanager_v2 { /** * The field value to attribute. */ - field?: string; + field?: string | null; /** * The metric to update. */ - metric?: string; + metric?: string | null; } /** * Write a Data Access (Gin) log @@ -386,7 +386,7 @@ export namespace deploymentmanager_v2 { /** * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ - logMode?: string; + logMode?: string | null; } export interface Schema$Manifest { /** @@ -396,8 +396,8 @@ export namespace deploymentmanager_v2 { /** * Output only. The fully-expanded configuration file, including any templates and references. */ - expandedConfig?: string; - id?: string; + expandedConfig?: string | null; + id?: string | null; /** * Output only. The imported files for this manifest. */ @@ -405,19 +405,19 @@ export namespace deploymentmanager_v2 { /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Output only. The YAML layout for this manifest. */ - layout?: string; + layout?: string | null; /** * Output only. The name of the manifest. */ - name?: string; + name?: string | null; /** * Output only. Self link for the manifest. */ - selfLink?: string; + selfLink?: string | null; } /** * A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated. @@ -430,7 +430,7 @@ export namespace deploymentmanager_v2 { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) @@ -439,89 +439,89 @@ export namespace deploymentmanager_v2 { /** * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ - clientOperationId?: string; + clientOperationId?: string | null; /** * [Deprecated] This field is deprecated. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] A textual description of the operation, which is set when the operation is created. */ - description?: string; + description?: string | null; /** * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ - endTime?: string; + endTime?: string | null; /** * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ - httpErrorMessage?: string; + httpErrorMessage?: string | null; /** * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ - httpErrorStatusCode?: number; + httpErrorStatusCode?: number | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ - operationType?: string; + operationType?: string | null; /** * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ - progress?: number; + progress?: number | null; /** * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ - status?: string; + status?: string | null; /** * [Output Only] An optional textual description of the current status of the operation. */ - statusMessage?: string; + statusMessage?: string | null; /** * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ - targetId?: string; + targetId?: string | null; /** * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ - targetLink?: string; + targetLink?: string | null; /** * [Output Only] User who requested the operation, for example: user@example.com. */ - user?: string; + user?: string | null; /** * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ @@ -529,11 +529,11 @@ export namespace deploymentmanager_v2 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; /** * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } /** * A response containing a partial list of operations and a page token used to build the next request if the request has been truncated. @@ -542,7 +542,7 @@ export namespace deploymentmanager_v2 { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. Operations contained in this list response. */ @@ -563,8 +563,8 @@ export namespace deploymentmanager_v2 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ - etag?: string; - iamOwned?: boolean; + etag?: string | null; + iamOwned?: boolean | null; /** * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ @@ -572,7 +572,7 @@ export namespace deploymentmanager_v2 { /** * Deprecated. */ - version?: number; + version?: number | null; } export interface Schema$Resource { /** @@ -582,28 +582,28 @@ export namespace deploymentmanager_v2 { /** * Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. */ - finalProperties?: string; - id?: string; + finalProperties?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Output only. URL of the manifest representing the current configuration of this resource. */ - manifest?: string; + manifest?: string | null; /** * Output only. The name of the resource as it appears in the YAML config. */ - name?: string; + name?: string | null; /** * Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. */ - properties?: string; + properties?: string | null; /** * Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. */ - type?: string; + type?: string | null; /** * Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. */ @@ -611,11 +611,11 @@ export namespace deploymentmanager_v2 { /** * Output only. Update timestamp in RFC3339 text format. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. The URL of the actual resource. */ - url?: string; + url?: string | null; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ @@ -623,7 +623,7 @@ export namespace deploymentmanager_v2 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * The access controls set on the resource. @@ -632,7 +632,7 @@ export namespace deploymentmanager_v2 { /** * The GCP IAM Policy to set on the resource. */ - gcpIamPolicy?: string; + gcpIamPolicy?: string | null; } /** * A response containing a partial list of resources and a page token used to build the next request if the request has been truncated. @@ -641,7 +641,7 @@ export namespace deploymentmanager_v2 { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Resources contained in this list response. */ @@ -657,27 +657,27 @@ export namespace deploymentmanager_v2 { */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. */ - finalProperties?: string; + finalProperties?: string | null; /** * Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. */ - intent?: string; + intent?: string | null; /** * Output only. URL of the manifest representing the update configuration of this resource. */ - manifest?: string; + manifest?: string | null; /** * Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. */ - properties?: string; + properties?: string | null; /** * Output only. The state of the resource. */ - state?: string; + state?: string | null; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ @@ -685,7 +685,7 @@ export namespace deploymentmanager_v2 { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * A rule to be applied in a Policy. @@ -694,7 +694,7 @@ export namespace deploymentmanager_v2 { /** * Required */ - action?: string; + action?: string | null; /** * Additional restrictions that must be met. All conditions must pass for the rule to match. */ @@ -702,11 +702,11 @@ export namespace deploymentmanager_v2 { /** * Human-readable description of the rule. */ - description?: string; + description?: string | null; /** * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ - ins?: string[]; + ins?: string[] | null; /** * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ @@ -714,11 +714,11 @@ export namespace deploymentmanager_v2 { /** * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ - notIns?: string[]; + notIns?: string[] | null; /** * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ - permissions?: string[]; + permissions?: string[] | null; } export interface Schema$TargetConfiguration { /** @@ -734,27 +734,27 @@ export namespace deploymentmanager_v2 { /** * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export interface Schema$TestPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A resource type supported by Deployment Manager. */ export interface Schema$Type { - id?: string; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Name of the type. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this type. */ @@ -762,7 +762,7 @@ export namespace deploymentmanager_v2 { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * A response that returns all Types supported by Deployment Manager @@ -771,7 +771,7 @@ export namespace deploymentmanager_v2 { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. A list of resource types supported by Deployment Manager. */ diff --git a/src/apis/deploymentmanager/v2beta.ts b/src/apis/deploymentmanager/v2beta.ts index a7a4c7b17cb..5f45e61e84f 100644 --- a/src/apis/deploymentmanager/v2beta.ts +++ b/src/apis/deploymentmanager/v2beta.ts @@ -120,7 +120,7 @@ export namespace deploymentmanager_v2beta { /** * Method regex where this policy will apply. */ - methodMatch?: string; + methodMatch?: string | null; /** * Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. */ @@ -134,11 +134,11 @@ export namespace deploymentmanager_v2beta { * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ - service?: string; + 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. @@ -147,11 +147,11 @@ export namespace deploymentmanager_v2beta { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Authorization-related information used by Cloud Audit Logging. @@ -160,7 +160,7 @@ export namespace deploymentmanager_v2beta { /** * The type of the permission that was checked. */ - permissionType?: string; + permissionType?: string | null; } /** * BaseType that describes a service-backed Type. @@ -177,7 +177,7 @@ export namespace deploymentmanager_v2beta { /** * Descriptor Url for the this type. */ - descriptorUrl?: string; + descriptorUrl?: string | null; /** * Options to apply when handling any resources in this service. */ @@ -187,8 +187,8 @@ export namespace deploymentmanager_v2beta { * Basic Auth used as a credential. */ export interface Schema$BasicAuth { - password?: string; - user?: string; + password?: string | null; + user?: string | null; } /** * Associates `members` with a `role`. @@ -201,11 +201,11 @@ export namespace deploymentmanager_v2beta { /** * 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}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * CollectionOverride allows resource handling overrides for specific resources within a BaseType @@ -214,7 +214,7 @@ export namespace deploymentmanager_v2beta { /** * The collection that identifies this resource within its service. */ - collection?: string; + collection?: string | null; /** * The options to apply to this resource-level override */ @@ -227,12 +227,12 @@ export namespace deploymentmanager_v2beta { /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; - id?: string; + description?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -240,7 +240,7 @@ export namespace deploymentmanager_v2beta { /** * Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]{0,61}[a-z0-9])?. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this composite type. */ @@ -248,16 +248,16 @@ export namespace deploymentmanager_v2beta { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; - status?: string; + selfLink?: string | null; + status?: string | null; /** * Files for the template type. */ templateContents?: Schema$TemplateContents; } export interface Schema$CompositeTypeLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } /** * A response that returns all Composite Types supported by Deployment Manager @@ -270,7 +270,7 @@ export namespace deploymentmanager_v2beta { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A condition to be met. @@ -279,33 +279,33 @@ export namespace deploymentmanager_v2beta { /** * Trusted attributes supplied by the IAM system. */ - iam?: string; + iam?: string | null; /** * An operator to apply the subject with. */ - op?: string; + op?: string | null; /** * Trusted attributes discharged by the service. */ - svc?: string; + svc?: string | null; /** * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ - sys?: string; + sys?: string | null; /** * DEPRECATED. Use 'values' instead. */ - value?: string; + value?: string | null; /** * The objects of the condition. This is mutually exclusive with 'value'. */ - values?: string[]; + values?: string[] | null; } export interface Schema$ConfigFile { /** * The contents of the file. */ - content?: string; + content?: string | null; } /** * The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. @@ -322,22 +322,22 @@ export namespace deploymentmanager_v2beta { /** * Specify to use the project default credential, only supported by Deployment. */ - useProjectDefault?: boolean; + useProjectDefault?: boolean | null; } export interface Schema$Deployment { /** * An optional user-provided description of the deployment. */ - description?: string; + description?: string | null; /** * Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. */ - fingerprint?: string; - id?: string; + fingerprint?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -345,11 +345,11 @@ export namespace deploymentmanager_v2beta { /** * Output only. URL of the manifest representing the last manifest that was successfully deployed. */ - manifest?: string; + manifest?: string | null; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this deployment. */ @@ -357,7 +357,7 @@ export namespace deploymentmanager_v2beta { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. */ @@ -369,17 +369,17 @@ export namespace deploymentmanager_v2beta { /** * Output only. Update timestamp in RFC3339 text format. */ - updateTime?: string; + updateTime?: string | null; } export interface Schema$DeploymentLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export interface Schema$DeploymentsCancelPreviewRequest { /** * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ - fingerprint?: string; + fingerprint?: string | null; } /** * A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. @@ -392,19 +392,19 @@ export namespace deploymentmanager_v2beta { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$DeploymentsStopRequest { /** * Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ - fingerprint?: string; + fingerprint?: string | null; } export interface Schema$DeploymentUpdate { /** * Output only. An optional user-provided description of the deployment after the current update has been applied. */ - description?: string; + description?: string | null; /** * Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -412,21 +412,21 @@ export namespace deploymentmanager_v2beta { /** * Output only. URL of the manifest representing the update configuration of this deployment. */ - manifest?: string; + manifest?: string | null; } export interface Schema$DeploymentUpdateLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export interface Schema$Diagnostic { /** * JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. */ - field?: string; + field?: string | null; /** * Level to record this diagnostic. */ - level?: string; + level?: 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" @@ -435,19 +435,19 @@ export namespace deploymentmanager_v2beta { /** * 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; + 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; + 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; + 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; + title?: string | null; } export interface Schema$GlobalSetPolicyRequest { /** @@ -457,7 +457,7 @@ export namespace deploymentmanager_v2beta { /** * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ - etag?: string; + etag?: string | null; /** * 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 in general a valid policy but certain services (like Projects) might reject them. */ @@ -467,11 +467,11 @@ export namespace deploymentmanager_v2beta { /** * The contents of the file. */ - content?: string; + content?: string | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. @@ -480,19 +480,19 @@ export namespace deploymentmanager_v2beta { /** * The name of the field that is going to be injected. */ - fieldName?: string; + fieldName?: string | null; /** * The location where this mapping applies. */ - location?: string; + location?: string | null; /** * Regex to evaluate on method to decide if input applies. */ - methodMatch?: string; + methodMatch?: string | null; /** * A jsonPath expression to select an element. */ - value?: string; + value?: string | null; } /** * Specifies what kind of log the caller must write @@ -522,7 +522,7 @@ export namespace deploymentmanager_v2beta { /** * The log_name to populate in the Cloud Audit Record. */ - logName?: string; + logName?: string | null; } /** * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). @@ -531,11 +531,11 @@ export namespace deploymentmanager_v2beta { /** * The field value to attribute. */ - field?: string; + field?: string | null; /** * The metric to update. */ - metric?: string; + metric?: string | null; } /** * Write a Data Access (Gin) log @@ -544,7 +544,7 @@ export namespace deploymentmanager_v2beta { /** * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ - logMode?: string; + logMode?: string | null; } export interface Schema$Manifest { /** @@ -554,8 +554,8 @@ export namespace deploymentmanager_v2beta { /** * Output only. The fully-expanded configuration file, including any templates and references. */ - expandedConfig?: string; - id?: string; + expandedConfig?: string | null; + id?: string | null; /** * Output only. The imported files for this manifest. */ @@ -563,19 +563,19 @@ export namespace deploymentmanager_v2beta { /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Output only. The YAML layout for this manifest. */ - layout?: string; + layout?: string | null; /** * Output only. The name of the manifest. */ - name?: string; + name?: string | null; /** * Output only. Self link for the manifest. */ - selfLink?: string; + selfLink?: string | null; } /** * A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated. @@ -588,7 +588,7 @@ export namespace deploymentmanager_v2beta { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) @@ -597,89 +597,89 @@ export namespace deploymentmanager_v2beta { /** * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ - clientOperationId?: string; + clientOperationId?: string | null; /** * [Deprecated] This field is deprecated. */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * [Output Only] A textual description of the operation, which is set when the operation is created. */ - description?: string; + description?: string | null; /** * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ - endTime?: string; + endTime?: string | null; /** * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ - httpErrorMessage?: string; + httpErrorMessage?: string | null; /** * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ - httpErrorStatusCode?: number; + httpErrorStatusCode?: number | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - id?: string; + id?: string | null; /** * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ - kind?: string; + kind?: string | null; /** * [Output Only] Name of the resource. */ - name?: string; + name?: string | null; /** * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ - operationType?: string; + operationType?: string | null; /** * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ - progress?: number; + progress?: number | null; /** * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - region?: string; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ - status?: string; + status?: string | null; /** * [Output Only] An optional textual description of the current status of the operation. */ - statusMessage?: string; + statusMessage?: string | null; /** * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ - targetId?: string; + targetId?: string | null; /** * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ - targetLink?: string; + targetLink?: string | null; /** * [Output Only] User who requested the operation, for example: user@example.com. */ - user?: string; + user?: string | null; /** * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ @@ -687,11 +687,11 @@ export namespace deploymentmanager_v2beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; /** * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ - zone?: string; + zone?: string | null; } /** * A response containing a partial list of operations and a page token used to build the next request if the request has been truncated. @@ -700,7 +700,7 @@ export namespace deploymentmanager_v2beta { /** * Output only. A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. Operations contained in this list response. */ @@ -725,7 +725,7 @@ export namespace deploymentmanager_v2beta { /** * Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number */ - virtualProperties?: string; + virtualProperties?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -742,8 +742,8 @@ export namespace deploymentmanager_v2beta { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ - etag?: string; - iamOwned?: boolean; + etag?: string | null; + iamOwned?: boolean | null; /** * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ @@ -751,7 +751,7 @@ export namespace deploymentmanager_v2beta { /** * Deprecated. */ - version?: number; + version?: number | null; } export interface Schema$PollingOptions { /** @@ -761,19 +761,19 @@ export namespace deploymentmanager_v2beta { /** * JsonPath expression that determines if the request failed. */ - failCondition?: string; + failCondition?: string | null; /** * JsonPath expression that determines if the request is completed. */ - finishCondition?: string; + finishCondition?: string | null; /** * JsonPath expression that evaluates to string, it indicates where to poll. */ - pollingLink?: string; + pollingLink?: string | null; /** * JsonPath expression, after polling is completed, indicates where to fetch the resource. */ - targetLink?: string; + targetLink?: string | null; } export interface Schema$Resource { /** @@ -783,28 +783,28 @@ export namespace deploymentmanager_v2beta { /** * Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. */ - finalProperties?: string; - id?: string; + finalProperties?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Output only. URL of the manifest representing the current configuration of this resource. */ - manifest?: string; + manifest?: string | null; /** * Output only. The name of the resource as it appears in the YAML config. */ - name?: string; + name?: string | null; /** * Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. */ - properties?: string; + properties?: string | null; /** * Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. */ - type?: string; + type?: string | null; /** * Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. */ @@ -812,11 +812,11 @@ export namespace deploymentmanager_v2beta { /** * Output only. Update timestamp in RFC3339 text format. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. The URL of the actual resource. */ - url?: string; + url?: string | null; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ @@ -824,7 +824,7 @@ export namespace deploymentmanager_v2beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * The access controls set on the resource. @@ -833,7 +833,7 @@ export namespace deploymentmanager_v2beta { /** * The GCP IAM Policy to set on the resource. */ - gcpIamPolicy?: string; + gcpIamPolicy?: string | null; } /** * A response containing a partial list of resources and a page token used to build the next request if the request has been truncated. @@ -842,7 +842,7 @@ export namespace deploymentmanager_v2beta { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Resources contained in this list response. */ @@ -858,27 +858,27 @@ export namespace deploymentmanager_v2beta { */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; - }; + } | null; /** * Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. */ - finalProperties?: string; + finalProperties?: string | null; /** * Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. */ - intent?: string; + intent?: string | null; /** * Output only. URL of the manifest representing the update configuration of this resource. */ - manifest?: string; + manifest?: string | null; /** * Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. */ - properties?: string; + properties?: string | null; /** * Output only. The state of the resource. */ - state?: string; + state?: string | null; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ @@ -886,7 +886,7 @@ export namespace deploymentmanager_v2beta { code?: string; data?: Array<{key?: string; value?: string}>; message?: string; - }>; + }> | null; } /** * A rule to be applied in a Policy. @@ -895,7 +895,7 @@ export namespace deploymentmanager_v2beta { /** * Required */ - action?: string; + action?: string | null; /** * Additional restrictions that must be met. All conditions must pass for the rule to match. */ @@ -903,11 +903,11 @@ export namespace deploymentmanager_v2beta { /** * Human-readable description of the rule. */ - description?: string; + description?: string | null; /** * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ - ins?: string[]; + ins?: string[] | null; /** * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ @@ -915,11 +915,11 @@ export namespace deploymentmanager_v2beta { /** * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ - notIns?: string[]; + notIns?: string[] | null; /** * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Service Account used as a credential. @@ -928,7 +928,7 @@ export namespace deploymentmanager_v2beta { /** * The IAM service account email address like test@myproject.iam.gserviceaccount.com */ - email?: string; + email?: string | null; } export interface Schema$TargetConfiguration { /** @@ -951,31 +951,31 @@ export namespace deploymentmanager_v2beta { /** * Which interpreter (python or jinja) should be used during expansion. */ - interpreter?: string; + interpreter?: string | null; /** * The filename of the mainTemplate */ - mainTemplate?: string; + mainTemplate?: string | null; /** * The contents of the template schema. */ - schema?: string; + schema?: string | null; /** * The contents of the main template file. */ - template?: string; + template?: string | null; } export interface Schema$TestPermissionsRequest { /** * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export interface Schema$TestPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A resource type supported by Deployment Manager. @@ -988,12 +988,12 @@ export namespace deploymentmanager_v2beta { /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; - id?: string; + description?: string | null; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -1001,7 +1001,7 @@ export namespace deploymentmanager_v2beta { /** * Name of the type. */ - name?: string; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this type. */ @@ -1009,7 +1009,7 @@ export namespace deploymentmanager_v2beta { /** * Output only. Server defined URL for the resource. */ - selfLink?: string; + selfLink?: string | null; } /** * Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. @@ -1018,19 +1018,19 @@ export namespace deploymentmanager_v2beta { /** * The description of the type. */ - description?: string; + description?: string | null; /** * For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. */ - documentationLink?: string; + documentationLink?: string | null; /** * Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. */ - kind?: string; + kind?: string | null; /** * The base type or composite type name. */ - name?: string; + name?: string | null; /** * For base types with a collection, we return a schema and documentation link For template types, we return only a schema */ @@ -1038,25 +1038,25 @@ export namespace deploymentmanager_v2beta { /** * Output only. Self link for the type provider. */ - selfLink?: string; + selfLink?: string | null; /** * The title on the API descriptor URL provided. */ - title?: string; + title?: string | null; } export interface Schema$TypeInfoSchemaInfo { /** * The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4 */ - input?: string; + input?: string | null; /** * The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4 */ - output?: string; + output?: string | null; } export interface Schema$TypeLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } /** * A type provider that describes a service-backed Type. @@ -1073,19 +1073,19 @@ export namespace deploymentmanager_v2beta { /** * An optional textual description of the resource; provided by the client when the resource is created. */ - description?: string; + description?: string | null; /** * Descriptor Url for the this type provider. */ - descriptorUrl?: string; + descriptorUrl?: string | null; /** * Output only. Unique identifier for the resource defined by the server. */ - id?: string; + id?: string | null; /** * Output only. Creation timestamp in RFC3339 text format. */ - insertTime?: string; + insertTime?: string | null; /** * Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)? */ @@ -1093,7 +1093,7 @@ export namespace deploymentmanager_v2beta { /** * 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; + name?: string | null; /** * Output only. The Operation that most recently ran, or is currently running, on this type provider. */ @@ -1105,11 +1105,11 @@ export namespace deploymentmanager_v2beta { /** * Output only. Self link for the type provider. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$TypeProviderLabelEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } /** * A response that returns all Type Providers supported by Deployment Manager @@ -1118,7 +1118,7 @@ export namespace deploymentmanager_v2beta { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. A list of resource type providers supported by Deployment Manager. */ @@ -1128,7 +1128,7 @@ export namespace deploymentmanager_v2beta { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. A list of resource type info. */ @@ -1141,7 +1141,7 @@ export namespace deploymentmanager_v2beta { /** * A token used to continue a truncated list request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Output only. A list of resource types supported by Deployment Manager. */ @@ -1154,11 +1154,11 @@ export namespace deploymentmanager_v2beta { /** * Customize how deployment manager will validate the resource against schema errors. */ - schemaValidation?: string; + schemaValidation?: string | null; /** * Specify what to do with extra properties when executing a request. */ - undeclaredProperties?: string; + undeclaredProperties?: string | null; } export class Resource$Compositetypes { diff --git a/src/apis/dfareporting/v3.1.ts b/src/apis/dfareporting/v3.1.ts index 3434c85acb3..eef485fc923 100644 --- a/src/apis/dfareporting/v3.1.ts +++ b/src/apis/dfareporting/v3.1.ts @@ -250,67 +250,67 @@ export namespace dfareporting_v3_1 { /** * Account permissions assigned to this account. */ - accountPermissionIds?: string[]; + accountPermissionIds?: string[] | null; /** * Profile for this account. This is a read-only field that can be left blank. */ - accountProfile?: string; + accountProfile?: string | null; /** * Whether this account is active. */ - active?: boolean; + active?: boolean | null; /** * Maximum number of active ads allowed for this account. */ - activeAdsLimitTier?: string; + activeAdsLimitTier?: string | null; /** * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. */ - activeViewOptOut?: boolean; + activeViewOptOut?: boolean | null; /** * User role permissions available to the user roles of this account. */ - availablePermissionIds?: string[]; + availablePermissionIds?: string[] | null; /** * ID of the country associated with this account. */ - countryId?: string; + countryId?: string | null; /** * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ - currencyId?: string; + currencyId?: string | null; /** * Default placement dimensions for this account. */ - defaultCreativeSizeId?: string; + defaultCreativeSizeId?: string | null; /** * Description of this account. */ - description?: string; + description?: string | null; /** * ID of this account. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". */ - kind?: string; + 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; + locale?: string | null; /** * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. */ - maximumImageSize?: string; + 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; + name?: string | null; /** * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. */ - nielsenOcrEnabled?: boolean; + nielsenOcrEnabled?: boolean | null; /** * Reporting configuration of this account. */ @@ -318,11 +318,11 @@ export namespace dfareporting_v3_1 { /** * Share Path to Conversion reports with Twitter. */ - shareReportsWithTwitter?: boolean; + shareReportsWithTwitter?: boolean | null; /** * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. */ - teaserSizeLimit?: string; + teaserSizeLimit?: string | null; } /** * Gets a summary of active ads in an account. @@ -331,23 +331,23 @@ export namespace dfareporting_v3_1 { /** * ID of the account. */ - accountId?: string; + accountId?: string | null; /** * Ads that have been activated for the account */ - activeAds?: string; + activeAds?: string | null; /** * Maximum number of active ads allowed for the account. */ - activeAdsLimitTier?: string; + activeAdsLimitTier?: string | null; /** * Ads that can be activated for the account. */ - availableAds?: string; + availableAds?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". */ - kind?: string; + 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. @@ -356,27 +356,27 @@ export namespace dfareporting_v3_1 { /** * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" */ - accountProfiles?: string[]; + accountProfiles?: string[] | null; /** * ID of this account permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". */ - kind?: string; + kind?: string | null; /** * Administrative level required to enable this account permission. */ - level?: string; + level?: string | null; /** * Name of this account permission. */ - name?: string; + name?: string | null; /** * Permission group of this account permission. */ - permissionGroupId?: string; + permissionGroupId?: string | null; } /** * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. @@ -385,15 +385,15 @@ export namespace dfareporting_v3_1 { /** * ID of this account permission group. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". */ - kind?: string; + kind?: string | null; /** * Name of this account permission group. */ - name?: string; + name?: string | null; } /** * Account Permission Group List Response @@ -406,7 +406,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". */ - kind?: string; + kind?: string | null; } /** * Account Permission List Response @@ -419,7 +419,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". */ - kind?: string; + kind?: string | null; } /** * Account List Response @@ -432,11 +432,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + 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. @@ -445,11 +445,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of the user profile. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + active?: boolean | null; /** * Filter that describes which advertisers are visible to the user profile. */ @@ -461,27 +461,27 @@ export namespace dfareporting_v3_1 { /** * Comments for this user profile. */ - comments?: string; + 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; + email?: string | null; /** * ID of the user profile. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". */ - kind?: string; + 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; + 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; + name?: string | null; /** * Filter that describes which sites are visible to the user profile. */ @@ -489,15 +489,15 @@ export namespace dfareporting_v3_1 { /** * Subaccount ID of the user profile. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Trafficker type of this user profile. This is a read-only field. */ - traffickerType?: string; + traffickerType?: string | null; /** * User type of the user profile. This is a read-only field that can be left blank. */ - userAccessType?: string; + userAccessType?: string | null; /** * Filter that describes which user roles are visible to the user profile. */ @@ -505,7 +505,7 @@ export namespace dfareporting_v3_1 { /** * User role ID of the user profile. This is a required field. */ - userRoleId?: string; + userRoleId?: string | null; } /** * Account User Profile List Response @@ -518,11 +518,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Represents an activity group. @@ -535,11 +535,11 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#activities. */ - kind?: string; + kind?: string | null; /** * List of names of floodlight activity metrics. */ - metricNames?: string[]; + metricNames?: string[] | null; } /** * Contains properties of a Campaign Manager ad. @@ -548,15 +548,15 @@ export namespace dfareporting_v3_1 { /** * Account ID of this ad. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Whether this ad is active. When true, archived must be false. */ - active?: boolean; + active?: boolean | null; /** * Advertiser ID of this ad. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -564,15 +564,15 @@ export namespace dfareporting_v3_1 { /** * Whether this ad is archived. When true, active must be false. */ - archived?: boolean; + archived?: boolean | null; /** * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. */ - audienceSegmentId?: string; + audienceSegmentId?: string | null; /** * Campaign ID of this ad. This is a required field on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -588,11 +588,11 @@ export namespace dfareporting_v3_1 { /** * Comments for this ad. */ - comments?: string; + 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; + compatibility?: string | null; /** * Information about the creation of this ad. This is a read-only field. */ @@ -620,11 +620,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + endTime?: string | null; /** * Event tag overrides for this ad. */ @@ -636,7 +636,7 @@ export namespace dfareporting_v3_1 { /** * ID of this ad. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this ad. This is a read-only, auto-generated field. */ @@ -648,7 +648,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". */ - kind?: string; + 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. */ @@ -660,7 +660,7 @@ export namespace dfareporting_v3_1 { /** * Name of this ad. This is a required field and must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * Placement assignments for this ad. */ @@ -676,23 +676,23 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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; + startTime?: string | null; /** * Subaccount ID of this ad. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + 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. */ @@ -700,7 +700,7 @@ export namespace dfareporting_v3_1 { /** * 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; + type?: string | null; } /** * Campaign ad blocking settings. @@ -709,19 +709,19 @@ export namespace dfareporting_v3_1 { /** * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. */ - clickThroughUrl?: string; + 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; + 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; + 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; + overrideClickThroughUrl?: boolean | null; } /** * Ad List Response @@ -734,11 +734,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Ad Slot @@ -747,35 +747,35 @@ export namespace dfareporting_v3_1 { /** * Comment for this ad slot. */ - comment?: string; + 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; + compatibility?: string | null; /** * Height of this ad slot. */ - height?: string; + height?: string | null; /** * ID of the placement from an external platform that is linked to this ad slot. */ - linkedPlacementId?: string; + linkedPlacementId?: string | null; /** * Name of this ad slot. */ - name?: string; + name?: string | null; /** * Payment source type of this ad slot. */ - paymentSourceType?: string; + paymentSourceType?: string | null; /** * Primary ad slot of a roadblock inventory item. */ - primary?: boolean; + primary?: boolean | null; /** * Width of this ad slot. */ - width?: string; + width?: string | null; } /** * Contains properties of a Campaign Manager advertiser. @@ -784,27 +784,27 @@ export namespace dfareporting_v3_1 { /** * Account ID of this advertiser.This is a read-only field that can be left blank. */ - accountId?: string; + 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; + 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; + 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; + defaultClickThroughEventTagId?: string | null; /** * Default email address used in sender field for tag emails. */ - defaultEmail?: string; + 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; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -812,7 +812,7 @@ export namespace dfareporting_v3_1 { /** * ID of this advertiser. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. */ @@ -820,27 +820,27 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". */ - kind?: string; + 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; + 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; + originalFloodlightConfigurationId?: string | null; /** * Status of this advertiser. */ - status?: string; + status?: string | null; /** * Subaccount ID of this advertiser.This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Suspension status of this advertiser. */ - suspended?: boolean; + suspended?: boolean | null; } /** * Groups advertisers together so that reports can be generated for the entire group at once. @@ -849,19 +849,19 @@ export namespace dfareporting_v3_1 { /** * Account ID of this advertiser group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this advertiser group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". */ - kind?: string; + 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; + name?: string | null; } /** * Advertiser Group List Response @@ -874,11 +874,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Landing Page List Response @@ -887,7 +887,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". */ - kind?: string; + kind?: string | null; /** * Landing page collection */ @@ -895,7 +895,7 @@ export namespace dfareporting_v3_1 { /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Advertiser List Response @@ -908,11 +908,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Audience Segment. @@ -921,15 +921,15 @@ export namespace dfareporting_v3_1 { /** * 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; + allocation?: number | null; /** * ID of this audience segment. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this audience segment. This is a required field and must be less than 65 characters long. */ - name?: string; + name?: string | null; } /** * Audience Segment Group. @@ -942,11 +942,11 @@ export namespace dfareporting_v3_1 { /** * ID of this audience segment group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this audience segment group. This is a required field and must be less than 65 characters long. */ - name?: string; + name?: string | null; } /** * Contains information about a browser that can be targeted by ads. @@ -955,27 +955,27 @@ export namespace dfareporting_v3_1 { /** * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. */ - browserVersionId?: string; + browserVersionId?: string | null; /** * DART ID of this browser. This is the ID used when generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". */ - kind?: string; + 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; + 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; + minorVersion?: string | null; /** * Name of this browser. */ - name?: string; + name?: string | null; } /** * Browser List Response @@ -988,7 +988,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains properties of a Campaign Manager campaign. @@ -997,7 +997,7 @@ export namespace dfareporting_v3_1 { /** * Account ID of this campaign. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Ad blocking settings for this campaign. */ @@ -1009,11 +1009,11 @@ export namespace dfareporting_v3_1 { /** * Advertiser group ID of the associated advertiser. */ - advertiserGroupId?: string; + advertiserGroupId?: string | null; /** * Advertiser ID of this campaign. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. */ @@ -1021,7 +1021,7 @@ export namespace dfareporting_v3_1 { /** * Whether this campaign has been archived. */ - archived?: boolean; + archived?: boolean | null; /** * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. */ @@ -1029,7 +1029,7 @@ export namespace dfareporting_v3_1 { /** * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. */ - billingInvoiceCode?: string; + billingInvoiceCode?: string | null; /** * Click-through URL suffix override properties for this campaign. */ @@ -1037,7 +1037,7 @@ export namespace dfareporting_v3_1 { /** * Arbitrary comments about this campaign. Must be less than 256 characters long. */ - comment?: string; + comment?: string | null; /** * Information about the creation of this campaign. This is a read-only field. */ @@ -1045,7 +1045,7 @@ export namespace dfareporting_v3_1 { /** * List of creative group IDs that are assigned to the campaign. */ - creativeGroupIds?: string[]; + creativeGroupIds?: string[] | null; /** * Creative optimization configuration for the campaign. */ @@ -1057,11 +1057,11 @@ export namespace dfareporting_v3_1 { /** * The default landing page ID for this campaign. */ - defaultLandingPageId?: string; + 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; + endDate?: string | null; /** * Overrides that can be used to activate or deactivate advertiser event tags. */ @@ -1069,11 +1069,11 @@ export namespace dfareporting_v3_1 { /** * External ID for this campaign. */ - externalId?: string; + externalId?: string | null; /** * ID of this campaign. This is a read-only auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. */ @@ -1081,7 +1081,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this campaign. This is a read-only field. */ @@ -1089,23 +1089,23 @@ export namespace dfareporting_v3_1 { /** * 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; + name?: string | null; /** * Whether Nielsen reports are enabled for this campaign. */ - nielsenOcrEnabled?: boolean; + 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; + startDate?: string | null; /** * Subaccount ID of this campaign. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Campaign trafficker contact emails. */ - traffickerEmails?: string[]; + traffickerEmails?: string[] | null; } /** * Identifies a creative which has been associated with a given campaign. @@ -1114,11 +1114,11 @@ export namespace dfareporting_v3_1 { /** * ID of the creative associated with the campaign. This is a required field. */ - creativeId?: string; + creativeId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". */ - kind?: string; + kind?: string | null; } /** * Campaign Creative Association List Response @@ -1131,11 +1131,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Campaign List Response @@ -1148,11 +1148,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Describes a change that a user has made to a resource. @@ -1161,59 +1161,59 @@ export namespace dfareporting_v3_1 { /** * Account ID of the modified object. */ - accountId?: string; + accountId?: string | null; /** * Action which caused the change. */ - action?: string; + action?: string | null; /** * Time when the object was modified. */ - changeTime?: string; + changeTime?: string | null; /** * Field name of the object which changed. */ - fieldName?: string; + fieldName?: string | null; /** * ID of this change log. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". */ - kind?: string; + kind?: string | null; /** * New value of the object field. */ - newValue?: string; + newValue?: string | null; /** * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. */ - objectId?: string; + objectId?: string | null; /** * Object type of the change log. */ - objectType?: string; + objectType?: string | null; /** * Old value of the object field. */ - oldValue?: string; + oldValue?: string | null; /** * Subaccount ID of the modified object. */ - subaccountId?: string; + 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; + transactionId?: string | null; /** * ID of the user who modified the object. */ - userProfileId?: string; + userProfileId?: string | null; /** * User profile name of the user who modified the object. */ - userProfileName?: string; + userProfileName?: string | null; } /** * Change Log List Response @@ -1226,11 +1226,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * City List Response @@ -1243,7 +1243,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains information about a city that can be targeted by ads. @@ -1252,39 +1252,39 @@ export namespace dfareporting_v3_1 { /** * Country code of the country to which this city belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this city belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this city. This is the ID used for targeting and generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". */ - kind?: string; + kind?: string | null; /** * Metro region code of the metro region (DMA) to which this city belongs. */ - metroCode?: string; + metroCode?: string | null; /** * ID of the metro region (DMA) to which this city belongs. */ - metroDmaId?: string; + metroDmaId?: string | null; /** * Name of this city. */ - name?: string; + name?: string | null; /** * Region code of the region to which this city belongs. */ - regionCode?: string; + regionCode?: string | null; /** * DART ID of the region to which this city belongs. */ - regionDartId?: string; + regionDartId?: string | null; } /** * Creative Click Tag. @@ -1297,11 +1297,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + name?: string | null; } /** * Click-through URL @@ -1310,19 +1310,19 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + customClickThroughUrl?: string | null; /** * Whether the campaign default landing page is used. */ - defaultLandingPage?: boolean; + defaultLandingPage?: boolean | null; /** * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. */ - landingPageId?: string; + landingPageId?: string | null; } /** * Click Through URL Suffix settings. @@ -1331,11 +1331,11 @@ export namespace dfareporting_v3_1 { /** * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. */ - clickThroughUrlSuffix?: string; + clickThroughUrlSuffix?: string | null; /** * Whether this entity should override the inherited click-through URL suffix with its own defined value. */ - overrideInheritedSuffix?: boolean; + overrideInheritedSuffix?: boolean | null; } /** * Companion Click-through override. @@ -1348,7 +1348,7 @@ export namespace dfareporting_v3_1 { /** * ID of the creative for this companion click-through override. */ - creativeId?: string; + creativeId?: string | null; } /** * Companion Settings @@ -1357,7 +1357,7 @@ export namespace dfareporting_v3_1 { /** * Whether companions are disabled for this placement. */ - companionsDisabled?: boolean; + 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. */ @@ -1365,11 +1365,11 @@ export namespace dfareporting_v3_1 { /** * Whether to serve only static images as companions. */ - imageOnly?: boolean; + imageOnly?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". */ - kind?: string; + kind?: string | null; } /** * Represents a response to the queryCompatibleFields method. @@ -1386,7 +1386,7 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#compatibleFields. */ - kind?: string; + kind?: string | null; /** * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ @@ -1407,15 +1407,15 @@ export namespace dfareporting_v3_1 { /** * ID of this connection type. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". */ - kind?: string; + kind?: string | null; /** * Name of this connection type. */ - name?: string; + name?: string | null; } /** * Connection Type List Response @@ -1428,7 +1428,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". */ - kind?: string; + kind?: string | null; } /** * Content Category List Response @@ -1441,11 +1441,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Organizes placements according to the contents of their associated webpages. @@ -1454,19 +1454,19 @@ export namespace dfareporting_v3_1 { /** * Account ID of this content category. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this content category. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". */ - kind?: string; + 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; + name?: string | null; } /** * A Conversion represents when a user successfully performs a desired action after seeing an ad. @@ -1475,7 +1475,7 @@ export namespace dfareporting_v3_1 { /** * Whether this particular request may come from a user under the age of 13, under COPPA compliance. */ - childDirectedTreatment?: boolean; + childDirectedTreatment?: boolean | null; /** * Custom floodlight variables. */ @@ -1483,59 +1483,59 @@ export namespace dfareporting_v3_1 { /** * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. */ - encryptedUserId?: string; + encryptedUserId?: string | null; /** * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. */ - encryptedUserIdCandidates?: string[]; + encryptedUserIdCandidates?: string[] | null; /** * Floodlight Activity ID of this conversion. This is a required field. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Floodlight Configuration ID of this conversion. This is a required field. */ - floodlightConfigurationId?: string; + floodlightConfigurationId?: string | null; /** * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. */ - gclid?: string; + gclid?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". */ - kind?: string; + 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; + limitAdTracking?: boolean | null; /** * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. */ - mobileDeviceId?: string; + mobileDeviceId?: string | null; /** * Whether the conversion was for a non personalized ad. */ - nonPersonalizedAd?: boolean; + 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; + ordinal?: string | null; /** * The quantity of the conversion. */ - quantity?: string; + quantity?: string | null; /** * The timestamp of conversion, in Unix epoch micros. This is a required field. */ - timestampMicros?: string; + 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; + treatmentForUnderage?: boolean | null; /** * The value of the conversion. */ - value?: number; + value?: number | null; } /** * The error code and description for a conversion that failed to insert or update. @@ -1544,15 +1544,15 @@ export namespace dfareporting_v3_1 { /** * The error code. */ - code?: string; + code?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". */ - kind?: string; + kind?: string | null; /** * A description of the error. */ - message?: string; + message?: string | null; } /** * Insert Conversions Request. @@ -1569,7 +1569,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". */ - kind?: string; + kind?: string | null; } /** * Insert Conversions Response. @@ -1578,11 +1578,11 @@ export namespace dfareporting_v3_1 { /** * Indicates that some or all conversions failed to insert. */ - hasFailures?: boolean; + hasFailures?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". */ - kind?: string; + kind?: string | null; /** * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. */ @@ -1603,7 +1603,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". */ - kind?: string; + kind?: string | null; } /** * Update Conversions Response. @@ -1612,11 +1612,11 @@ export namespace dfareporting_v3_1 { /** * Indicates that some or all conversions failed to update. */ - hasFailures?: boolean; + hasFailures?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". */ - kind?: string; + kind?: string | null; /** * The update status of each conversion. Statuses are returned in the same order that conversions are updated. */ @@ -1637,7 +1637,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". */ - kind?: string; + kind?: string | null; } /** * Country List Response @@ -1650,7 +1650,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains information about a country that can be targeted by ads. @@ -1659,23 +1659,23 @@ export namespace dfareporting_v3_1 { /** * Country code. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of this country. This is the ID used for targeting and generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". */ - kind?: string; + kind?: string | null; /** * Name of this country. */ - name?: string; + name?: string | null; /** * Whether ad serving supports secure servers in this country. */ - sslEnabled?: boolean; + sslEnabled?: boolean | null; } /** * Contains properties of a Creative. @@ -1684,11 +1684,11 @@ export namespace dfareporting_v3_1 { /** * 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; + accountId?: string | null; /** * Whether the creative is active. Applicable to all creative types. */ - active?: boolean; + 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. */ @@ -1696,43 +1696,43 @@ export namespace dfareporting_v3_1 { /** * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. */ - adParameters?: string; + 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[]; + adTagKeys?: string[] | null; /** * Advertiser ID of this creative. This is a required field. Applicable to all creative types. */ - advertiserId?: string; + 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; + allowScriptAccess?: boolean | null; /** * Whether the creative is archived. Applicable to all creative types. */ - archived?: boolean; + 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; + 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; + 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; + authoringTool?: string | null; /** * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. */ - autoAdvanceImages?: boolean; + 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; + backgroundColor?: string | null; /** * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. */ @@ -1740,11 +1740,11 @@ export namespace dfareporting_v3_1 { /** * 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[]; + 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; + 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. */ @@ -1756,19 +1756,19 @@ export namespace dfareporting_v3_1 { /** * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. */ - commercialId?: string; + 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[]; + 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[]; + 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; + 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. */ @@ -1788,11 +1788,11 @@ export namespace dfareporting_v3_1 { /** * 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[]; + 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; + 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. */ @@ -1804,15 +1804,15 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + htmlCodeLocked?: boolean | null; /** * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. */ @@ -1820,7 +1820,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". */ - kind?: string; + kind?: string | null; /** * Creative last modification information. This is a read-only field. Applicable to all creative types. */ @@ -1828,23 +1828,23 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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; + 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; + name?: string | null; /** * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. */ - overrideCss?: string; + overrideCss?: string | null; /** * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. */ @@ -1852,11 +1852,11 @@ export namespace dfareporting_v3_1 { /** * 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; + redirectUrl?: string | null; /** * ID of current rendering version. This is a read-only field. Applicable to all creative types. */ - renderingId?: string; + renderingId?: string | null; /** * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. */ @@ -1864,11 +1864,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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. */ @@ -1880,39 +1880,39 @@ export namespace dfareporting_v3_1 { /** * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. */ - skippable?: boolean; + skippable?: boolean | null; /** * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. */ - sslCompliant?: boolean; + 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; + 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; + 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; + 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; + 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; + subaccountId?: string | null; /** * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. */ - thirdPartyBackupImageImpressionsUrl?: string; + thirdPartyBackupImageImpressionsUrl?: string | null; /** * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. */ - thirdPartyRichMediaImpressionsUrl?: string; + 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. */ @@ -1924,11 +1924,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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. */ @@ -1936,7 +1936,7 @@ export namespace dfareporting_v3_1 { /** * 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; + version?: number | null; } /** * Creative Asset. @@ -1945,11 +1945,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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. */ @@ -1957,11 +1957,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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. */ @@ -1973,11 +1973,11 @@ export namespace dfareporting_v3_1 { /** * 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; + bitRate?: number | null; /** * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. */ - childAssetType?: string; + 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. */ @@ -1985,27 +1985,27 @@ export namespace dfareporting_v3_1 { /** * 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[]; + 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; + 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[]; + 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; + 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; + duration?: number | null; /** * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. */ - durationType?: string; + 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. */ @@ -2013,27 +2013,27 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + flashVersion?: number | null; /** * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ - hideFlashObjects?: boolean; + hideFlashObjects?: boolean | null; /** * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ - hideSelectionBoxes?: boolean; + 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; + 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; + id?: string | null; /** * Dimension value for the ID of the asset. This is a read-only, auto-generated field. */ @@ -2041,11 +2041,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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. */ @@ -2053,11 +2053,11 @@ export namespace dfareporting_v3_1 { /** * Orientation of video asset. This is a read-only, auto-generated field. */ - orientation?: string; + 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; + originalBackup?: boolean | null; /** * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. */ @@ -2065,27 +2065,27 @@ export namespace dfareporting_v3_1 { /** * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ - positionLeftUnit?: string; + 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; + 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; + 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; + 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; + 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; + 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. */ @@ -2093,39 +2093,39 @@ export namespace dfareporting_v3_1 { /** * 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; + sslCompliant?: boolean | null; /** * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. */ - startTimeType?: string; + 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; + 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; + 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; + 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; + 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; + zIndex?: number | null; /** * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ - zipFilename?: string; + zipFilename?: string | null; /** * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ - zipFilesize?: string; + zipFilesize?: string | null; } /** * Creative Asset ID. @@ -2134,11 +2134,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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. @@ -2155,11 +2155,11 @@ export namespace dfareporting_v3_1 { /** * 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[]; + detectedFeatures?: string[] | null; /** * Numeric ID of the asset. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. */ @@ -2167,11 +2167,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". */ - kind?: string; + 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[]; + 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. @@ -2180,7 +2180,7 @@ export namespace dfareporting_v3_1 { /** * 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; + 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. */ @@ -2193,11 +2193,11 @@ export namespace dfareporting_v3_1 { /** * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. */ - active?: boolean; + 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; + applyEventTags?: boolean | null; /** * Click-through URL of the creative assignment. */ @@ -2213,7 +2213,7 @@ export namespace dfareporting_v3_1 { /** * ID of the creative to be assigned. This is a required field. */ - creativeId?: string; + creativeId?: string | null; /** * Dimension value for the ID of the creative. This is a read-only, auto-generated field. */ @@ -2221,7 +2221,7 @@ export namespace dfareporting_v3_1 { /** * Date and time that the assigned creative should stop serving. Must be later than the start time. */ - endTime?: string; + 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 */ @@ -2229,19 +2229,19 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + sslCompliant?: boolean | null; /** * Date and time that the assigned creative should start serving. */ - startTime?: string; + 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; + weight?: number | null; } /** * Click-through URL @@ -2250,15 +2250,15 @@ export namespace dfareporting_v3_1 { /** * 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; + computedClickThroughUrl?: string | null; /** * Custom click-through URL. Applicable if the landingPageId field is left unset. */ - customClickThroughUrl?: string; + customClickThroughUrl?: string | null; /** * ID of the landing page for the click-through URL. */ - landingPageId?: string; + landingPageId?: string | null; } /** * Creative Custom Event. @@ -2267,23 +2267,23 @@ export namespace dfareporting_v3_1 { /** * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. */ - advertiserCustomEventId?: string; + advertiserCustomEventId?: string | null; /** * User-entered name for the event. */ - advertiserCustomEventName?: string; + advertiserCustomEventName?: string | null; /** * Type of the event. This is a read-only field. */ - advertiserCustomEventType?: string; + 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; + artworkLabel?: string | null; /** * Artwork type used by the creative.This is a read-only field. */ - artworkType?: string; + artworkType?: string | null; /** * Exit click-through URL for the event. This field is used only for exit events. */ @@ -2291,7 +2291,7 @@ export namespace dfareporting_v3_1 { /** * ID of this event. This is a required field and should not be modified after insertion. */ - id?: string; + id?: string | null; /** * Properties for rich media popup windows. This field is used only for exit events. */ @@ -2299,11 +2299,11 @@ export namespace dfareporting_v3_1 { /** * Target type used by the event. */ - targetType?: string; + targetType?: string | null; /** * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. */ - videoReportingId?: string; + videoReportingId?: string | null; } /** * Contains properties of a creative field. @@ -2312,11 +2312,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this creative field. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this creative field. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -2324,19 +2324,19 @@ export namespace dfareporting_v3_1 { /** * ID of this creative field. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this creative field. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Creative Field Assignment. @@ -2345,11 +2345,11 @@ export namespace dfareporting_v3_1 { /** * ID of the creative field. */ - creativeFieldId?: string; + creativeFieldId?: string | null; /** * ID of the creative field value. */ - creativeFieldValueId?: string; + creativeFieldValueId?: string | null; } /** * Creative Field List Response @@ -2362,11 +2362,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a creative field value. @@ -2375,15 +2375,15 @@ export namespace dfareporting_v3_1 { /** * ID of this creative field value. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". */ - kind?: string; + 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; + value?: string | null; } /** * Creative Field Value List Response @@ -2396,11 +2396,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a creative group. @@ -2409,11 +2409,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this creative group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this creative group. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -2421,23 +2421,23 @@ export namespace dfareporting_v3_1 { /** * 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; + groupNumber?: number | null; /** * ID of this creative group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this creative group. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Creative Group Assignment. @@ -2446,11 +2446,11 @@ export namespace dfareporting_v3_1 { /** * ID of the creative group to be assigned. */ - creativeGroupId?: string; + creativeGroupId?: string | null; /** * Creative group number of the creative group assignment. */ - creativeGroupNumber?: string; + creativeGroupNumber?: string | null; } /** * Creative Group List Response @@ -2463,11 +2463,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Creative optimization settings. @@ -2476,11 +2476,11 @@ export namespace dfareporting_v3_1 { /** * 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; + id?: string | null; /** * Name of this creative optimization config. This is a required field and must be less than 129 characters long. */ - name?: string; + name?: string | null; /** * List of optimization activities associated with this configuration. */ @@ -2488,7 +2488,7 @@ export namespace dfareporting_v3_1 { /** * Optimization model for this configuration. */ - optimizationModel?: string; + optimizationModel?: string | null; } /** * Creative Rotation. @@ -2501,15 +2501,15 @@ export namespace dfareporting_v3_1 { /** * 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; + creativeOptimizationConfigurationId?: string | null; /** * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. */ - type?: string; + type?: string | null; /** * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */ - weightCalculationStrategy?: string; + weightCalculationStrategy?: string | null; } /** * Creative List Response @@ -2522,11 +2522,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". @@ -2543,7 +2543,7 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -2560,15 +2560,15 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". */ - kind?: string; + 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; + type?: string | null; /** * The value of the custom floodlight variable. The length of string must not exceed 50 characters. */ - value?: string; + value?: string | null; } /** * Represents a Custom Rich Media Events group. @@ -2581,7 +2581,7 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#customRichMediaEvents. */ - kind?: string; + kind?: string | null; } /** * Represents a date range. @@ -2590,19 +2590,19 @@ export namespace dfareporting_v3_1 { /** * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ - endDate?: string; + endDate?: string | null; /** * The kind of resource this is, in this case dfareporting#dateRange. */ - kind?: string; + kind?: string | null; /** * The date range relative to the date of when the report is run. */ - relativeDateRange?: string; + relativeDateRange?: string | null; /** * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ - startDate?: string; + startDate?: string | null; } /** * Day Part Targeting. @@ -2611,15 +2611,15 @@ export namespace dfareporting_v3_1 { /** * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" */ - daysOfWeek?: string[]; + 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[]; + hoursOfDay?: number[] | null; /** * Whether or not to use the user's local time. If false, the America/New York time zone applies. */ - userLocalTime?: boolean; + userLocalTime?: boolean | null; } /** * Contains information about a landing page deep link. @@ -2628,15 +2628,15 @@ export namespace dfareporting_v3_1 { /** * The URL of the mobile app being linked to. */ - appUrl?: string; + appUrl?: string | null; /** * The fallback URL. This URL will be served to users who do not have the mobile app installed. */ - fallbackUrl?: string; + fallbackUrl?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". */ - kind?: string; + kind?: string | null; /** * The mobile app targeted by this deep link. */ @@ -2644,7 +2644,7 @@ export namespace dfareporting_v3_1 { /** * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. */ - remarketingListIds?: string[]; + 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. @@ -2653,11 +2653,11 @@ export namespace dfareporting_v3_1 { /** * ID of the click-through event tag to apply to all ads in this entity's scope. */ - defaultClickThroughEventTagId?: string; + defaultClickThroughEventTagId?: string | null; /** * Whether this entity should override the inherited default click-through event tag with its own defined value. */ - overrideInheritedEventTag?: boolean; + overrideInheritedEventTag?: boolean | null; } /** * Delivery Schedule. @@ -2670,15 +2670,15 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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; + priority?: string | null; } /** * Google Ad Manager Settings @@ -2687,23 +2687,23 @@ export namespace dfareporting_v3_1 { /** * Ad Manager network code for this directory site. */ - dfpNetworkCode?: string; + dfpNetworkCode?: string | null; /** * Ad Manager network name for this directory site. */ - dfpNetworkName?: string; + dfpNetworkName?: string | null; /** * Whether this directory site accepts programmatic placements. */ - programmaticPlacementAccepted?: boolean; + programmaticPlacementAccepted?: boolean | null; /** * Whether this directory site is available only via Publisher Portal. */ - publisherPortalOnly?: boolean; + publisherPortalOnly?: boolean | null; /** * Whether this directory site accepts publisher-paid tags. */ - pubPaidPlacementAccepted?: boolean; + pubPaidPlacementAccepted?: boolean | null; } /** * Represents a dimension. @@ -2712,11 +2712,11 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#dimension. */ - kind?: string; + kind?: string | null; /** * The dimension name, e.g. dfa:advertiser */ - name?: string; + name?: string | null; } /** * Represents a dimension filter. @@ -2725,15 +2725,15 @@ export namespace dfareporting_v3_1 { /** * The name of the dimension to filter. */ - dimensionName?: string; + dimensionName?: string | null; /** * The kind of resource this is, in this case dfareporting#dimensionFilter. */ - kind?: string; + kind?: string | null; /** * The value of the dimension to filter. */ - value?: string; + value?: string | null; } /** * Represents a DimensionValue resource. @@ -2742,27 +2742,27 @@ export namespace dfareporting_v3_1 { /** * The name of the dimension. */ - dimensionName?: string; + dimensionName?: string | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID associated with the value if available. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#dimensionValue. */ - kind?: string; + 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; + matchType?: string | null; /** * The value of the dimension. */ - value?: string; + value?: string | null; } /** * Represents the list of DimensionValue resources. @@ -2771,7 +2771,7 @@ export namespace dfareporting_v3_1 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The dimension values returned in this response. */ @@ -2779,11 +2779,11 @@ export namespace dfareporting_v3_1 { /** * The kind of list this is, in this case dfareporting#dimensionValueList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Represents a DimensionValuesRequest. @@ -2792,11 +2792,11 @@ export namespace dfareporting_v3_1 { /** * The name of the dimension for which values should be requested. */ - dimensionName?: string; + 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; + endDate?: string | null; /** * The list of filters by which to filter values. The filters are ANDed. */ @@ -2804,11 +2804,11 @@ export namespace dfareporting_v3_1 { /** * The kind of request this is, in this case dfareporting#dimensionValueRequest. */ - kind?: string; + 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; + 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. @@ -2817,11 +2817,11 @@ export namespace dfareporting_v3_1 { /** * Whether this directory site is active. */ - active?: boolean; + active?: boolean | null; /** * ID of this directory site. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. */ @@ -2829,19 +2829,19 @@ export namespace dfareporting_v3_1 { /** * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" */ - inpageTagFormats?: string[]; + inpageTagFormats?: string[] | null; /** * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" */ - interstitialTagFormats?: string[]; + interstitialTagFormats?: string[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". */ - kind?: string; + kind?: string | null; /** * Name of this directory site. */ - name?: string; + name?: string | null; /** * Directory site settings. */ @@ -2849,7 +2849,7 @@ export namespace dfareporting_v3_1 { /** * URL of this directory site. */ - url?: string; + url?: string | null; } /** * Directory Site Settings @@ -2858,7 +2858,7 @@ export namespace dfareporting_v3_1 { /** * Whether this directory site has disabled active view creatives. */ - activeViewOptOut?: boolean; + activeViewOptOut?: boolean | null; /** * Directory site Ad Manager settings. */ @@ -2866,11 +2866,11 @@ export namespace dfareporting_v3_1 { /** * Whether this site accepts in-stream video ads. */ - instreamVideoPlacementAccepted?: boolean; + instreamVideoPlacementAccepted?: boolean | null; /** * Whether this site accepts interstitial ads. */ - interstitialPlacementAccepted?: boolean; + interstitialPlacementAccepted?: boolean | null; } /** * Directory Site List Response @@ -2883,11 +2883,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + 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. @@ -2896,19 +2896,19 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". */ - kind?: string; + 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; + name?: string | null; /** * ID of the object of this dynamic targeting key. This is a required field. */ - objectId?: string; + objectId?: string | null; /** * Type of the object of this dynamic targeting key. This is a required field. */ - objectType?: string; + objectType?: string | null; } /** * Dynamic Targeting Key List Response @@ -2921,7 +2921,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". */ - kind?: string; + kind?: string | null; } /** * A description of how user IDs are encrypted. @@ -2930,19 +2930,19 @@ export namespace dfareporting_v3_1 { /** * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. */ - encryptionEntityId?: string; + encryptionEntityId?: string | null; /** * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. */ - encryptionEntityType?: string; + encryptionEntityType?: string | null; /** * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. */ - encryptionSource?: string; + encryptionSource?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */ - kind?: string; + kind?: string | null; } /** * Contains properties of an event tag. @@ -2951,11 +2951,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this event tag. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -2963,7 +2963,7 @@ export namespace dfareporting_v3_1 { /** * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -2971,55 +2971,55 @@ export namespace dfareporting_v3_1 { /** * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. */ - enabledByDefault?: boolean; + 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; + excludeFromAdxRequests?: boolean | null; /** * ID of this event tag. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". */ - kind?: string; + kind?: string | null; /** * Name of this event tag. This is a required field and must be less than 256 characters long. */ - name?: string; + 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; + 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[]; + siteIds?: string[] | null; /** * Whether this tag is SSL-compliant or not. This is a read-only field. */ - sslCompliant?: boolean; + sslCompliant?: boolean | null; /** * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. */ - status?: string; + status?: string | null; /** * Subaccount ID of this event tag. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + 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; + 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; + urlEscapeLevels?: number | null; } /** * Event tag override information. @@ -3028,11 +3028,11 @@ export namespace dfareporting_v3_1 { /** * Whether this override is enabled. */ - enabled?: boolean; + enabled?: boolean | null; /** * ID of this event tag override. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; } /** * Event Tag List Response @@ -3045,7 +3045,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". */ - kind?: string; + 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". @@ -3058,39 +3058,39 @@ export namespace dfareporting_v3_1 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The filename of the file. */ - fileName?: string; + fileName?: string | null; /** * The output format of the report. Only available once the file is available. */ - format?: string; + format?: string | null; /** * The unique ID of this report file. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#file. */ - kind?: string; + kind?: string | null; /** * The timestamp in milliseconds since epoch when this file was last modified. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * The ID of the report this file was generated from. */ - reportId?: string; + reportId?: string | null; /** * The status of the report file. */ - status?: string; + status?: string | null; /** * The URLs where the completed report file can be downloaded. */ - urls?: {apiUrl?: string; browserUrl?: string}; + urls?: {apiUrl?: string; browserUrl?: string} | null; } /** * Represents the list of File resources. @@ -3099,7 +3099,7 @@ export namespace dfareporting_v3_1 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The files returned in this response. */ @@ -3107,11 +3107,11 @@ export namespace dfareporting_v3_1 { /** * The kind of list this is, in this case dfareporting#fileList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Flight @@ -3120,19 +3120,19 @@ export namespace dfareporting_v3_1 { /** * Inventory item flight end date. */ - endDate?: string; + endDate?: string | null; /** * Rate or cost of this flight. */ - rateOrCost?: string; + rateOrCost?: string | null; /** * Inventory item flight start date. */ - startDate?: string; + startDate?: string | null; /** * Units of this flight. */ - units?: string; + units?: string | null; } /** * Floodlight Activity GenerateTag Response @@ -3141,15 +3141,15 @@ export namespace dfareporting_v3_1 { /** * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. */ - floodlightActivityTag?: string; + 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; + globalSiteTagGlobalSnippet?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". */ - kind?: string; + kind?: string | null; } /** * Floodlight Activity List Response @@ -3162,11 +3162,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a Floodlight activity. @@ -3175,11 +3175,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this floodlight activity. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3187,11 +3187,11 @@ export namespace dfareporting_v3_1 { /** * 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; + cacheBustingType?: string | null; /** * Counting method for conversions for this floodlight activity. This is a required field. */ - countingMethod?: string; + countingMethod?: string | null; /** * Dynamic floodlight tags. */ @@ -3199,27 +3199,27 @@ export namespace dfareporting_v3_1 { /** * URL where this tag will be deployed. If specified, must be less than 256 characters long. */ - expectedUrl?: string; + expectedUrl?: string | null; /** * Floodlight activity group ID of this floodlight activity. This is a required field. */ - floodlightActivityGroupId?: string; + floodlightActivityGroupId?: string | null; /** * Name of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupName?: string; + floodlightActivityGroupName?: string | null; /** * Tag string of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupTagString?: string; + floodlightActivityGroupTagString?: string | null; /** * Type of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupType?: string; + 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; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -3227,11 +3227,11 @@ export namespace dfareporting_v3_1 { /** * The type of Floodlight tag this activity will generate. This is a required field. */ - floodlightTagType?: string; + floodlightTagType?: string | null; /** * ID of this floodlight activity. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. */ @@ -3239,15 +3239,15 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". */ - kind?: string; + 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; + name?: string | null; /** * General notes or implementation instructions for the tag. */ - notes?: string; + notes?: string | null; /** * Publisher dynamic floodlight tags. */ @@ -3255,31 +3255,31 @@ export namespace dfareporting_v3_1 { /** * Whether this tag should use SSL. */ - secure?: boolean; + 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; + sslCompliant?: boolean | null; /** * Whether this floodlight activity must be SSL-compliant. */ - sslRequired?: boolean; + sslRequired?: boolean | null; /** * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. */ - tagFormat?: string; + 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; + 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[]; + userDefinedVariableTypes?: string[] | null; } /** * Dynamic Tag @@ -3288,15 +3288,15 @@ export namespace dfareporting_v3_1 { /** * ID of this dynamic tag. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this tag. */ - name?: string; + name?: string | null; /** * Tag code. */ - tag?: string; + tag?: string | null; } /** * Contains properties of a Floodlight activity group. @@ -3305,11 +3305,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this floodlight activity group. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3317,7 +3317,7 @@ export namespace dfareporting_v3_1 { /** * Floodlight configuration ID of this floodlight activity group. This is a required field. */ - floodlightConfigurationId?: string; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -3325,7 +3325,7 @@ export namespace dfareporting_v3_1 { /** * ID of this floodlight activity group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. */ @@ -3333,23 +3333,23 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + tagString?: string | null; /** * Type of the floodlight activity group. This is a required field that is read-only after insertion. */ - type?: string; + type?: string | null; } /** * Floodlight Activity Group List Response @@ -3362,11 +3362,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Publisher Dynamic Tag @@ -3375,11 +3375,11 @@ export namespace dfareporting_v3_1 { /** * Whether this tag is applicable only for click-throughs. */ - clickThrough?: boolean; + 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; + directorySiteId?: string | null; /** * Dynamic floodlight tag. */ @@ -3387,7 +3387,7 @@ export namespace dfareporting_v3_1 { /** * Site ID of this dynamic tag. */ - siteId?: string; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -3395,7 +3395,7 @@ export namespace dfareporting_v3_1 { /** * Whether this tag is applicable only for view-throughs. */ - viewThrough?: boolean; + viewThrough?: boolean | null; } /** * Contains properties of a Floodlight configuration. @@ -3404,11 +3404,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this floodlight configuration. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of the parent advertiser of this floodlight configuration. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3416,19 +3416,19 @@ export namespace dfareporting_v3_1 { /** * Whether advertiser data is shared with Google Analytics. */ - analyticsDataSharingEnabled?: boolean; + analyticsDataSharingEnabled?: boolean | null; /** * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ - exposureToConversionEnabled?: boolean; + exposureToConversionEnabled?: boolean | null; /** * Day that will be counted as the first day of the week in reports. This is a required field. */ - firstDayOfWeek?: string; + firstDayOfWeek?: string | null; /** * ID of this floodlight configuration. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. */ @@ -3436,11 +3436,11 @@ export namespace dfareporting_v3_1 { /** * Whether in-app attribution tracking is enabled. */ - inAppAttributionTrackingEnabled?: boolean; + inAppAttributionTrackingEnabled?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". */ - kind?: string; + kind?: string | null; /** * Lookback window settings for this floodlight configuration. */ @@ -3448,7 +3448,7 @@ export namespace dfareporting_v3_1 { /** * Types of attribution options for natural search conversions. */ - naturalSearchConversionAttributionOption?: string; + naturalSearchConversionAttributionOption?: string | null; /** * Settings for Campaign Manager Omniture integration. */ @@ -3456,7 +3456,7 @@ export namespace dfareporting_v3_1 { /** * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Configuration settings for dynamic and image floodlight tags. */ @@ -3481,7 +3481,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". */ - kind?: string; + kind?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". @@ -3498,7 +3498,7 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -3511,11 +3511,11 @@ export namespace dfareporting_v3_1 { /** * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. */ - duration?: string; + 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; + impressions?: string | null; } /** * FsCommand. @@ -3524,23 +3524,23 @@ export namespace dfareporting_v3_1 { /** * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ - left?: number; + left?: number | null; /** * Position in the browser where the window will open. */ - positionOption?: string; + positionOption?: string | null; /** * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ - top?: number; + top?: number | null; /** * Height of the window. */ - windowHeight?: number; + windowHeight?: number | null; /** * Width of the window. */ - windowWidth?: number; + windowWidth?: number | null; } /** * Geographical Targeting. @@ -3557,7 +3557,7 @@ export namespace dfareporting_v3_1 { /** * 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; + 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. */ @@ -3578,7 +3578,7 @@ export namespace dfareporting_v3_1 { /** * Account ID of this inventory item. */ - accountId?: string; + 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. */ @@ -3586,31 +3586,31 @@ export namespace dfareporting_v3_1 { /** * Advertiser ID of this inventory item. */ - advertiserId?: string; + advertiserId?: string | null; /** * Content category ID of this inventory item. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Estimated click-through rate of this inventory item. */ - estimatedClickThroughRate?: string; + estimatedClickThroughRate?: string | null; /** * Estimated conversion rate of this inventory item. */ - estimatedConversionRate?: string; + estimatedConversionRate?: string | null; /** * ID of this inventory item. */ - id?: string; + id?: string | null; /** * Whether this inventory item is in plan. */ - inPlan?: boolean; + inPlan?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this inventory item. */ @@ -3618,19 +3618,19 @@ export namespace dfareporting_v3_1 { /** * 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; + name?: string | null; /** * Negotiation channel ID of this inventory item. */ - negotiationChannelId?: string; + negotiationChannelId?: string | null; /** * Order ID of this inventory item. */ - orderId?: string; + orderId?: string | null; /** * Placement strategy ID of this inventory item. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing of this inventory item. */ @@ -3638,23 +3638,23 @@ export namespace dfareporting_v3_1 { /** * Project ID of this inventory item. */ - projectId?: string; + projectId?: string | null; /** * RFP ID of this inventory item. */ - rfpId?: string; + rfpId?: string | null; /** * ID of the site this inventory item is associated with. */ - siteId?: string; + siteId?: string | null; /** * Subaccount ID of this inventory item. */ - subaccountId?: string; + subaccountId?: string | null; /** * Type of inventory item. */ - type?: string; + type?: string | null; } /** * Inventory item List Response @@ -3667,11 +3667,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Key Value Targeting Expression. @@ -3680,7 +3680,7 @@ export namespace dfareporting_v3_1 { /** * Keyword expression being targeted by the ad. */ - expression?: string; + expression?: string | null; } /** * Contains information about where a user's browser is taken after the user clicks an ad. @@ -3689,11 +3689,11 @@ export namespace dfareporting_v3_1 { /** * Advertiser ID of this landing page. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Whether this landing page has been archived. */ - archived?: boolean; + archived?: boolean | null; /** * Links that will direct the user to a mobile app, if installed. */ @@ -3701,19 +3701,19 @@ export namespace dfareporting_v3_1 { /** * ID of this landing page. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". */ - kind?: string; + kind?: string | null; /** * Name of this landing page. This is a required field. It must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * URL of this landing page. This is a required field. */ - url?: string; + url?: string | null; } /** * Contains information about a language that can be targeted by ads. @@ -3722,19 +3722,19 @@ export namespace dfareporting_v3_1 { /** * Language ID of this language. This is the ID used for targeting and generating reports. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". */ - kind?: string; + 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; + languageCode?: string | null; /** * Name of this language. */ - name?: string; + name?: string | null; } /** * Language List Response @@ -3743,7 +3743,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". */ - kind?: string; + kind?: string | null; /** * Language collection. */ @@ -3765,7 +3765,7 @@ export namespace dfareporting_v3_1 { /** * Timestamp of the last change in milliseconds since epoch. */ - time?: string; + time?: string | null; } /** * A group clause made up of list population terms representing constraints joined by ORs. @@ -3783,11 +3783,11 @@ export namespace dfareporting_v3_1 { /** * Floodlight activity ID associated with this rule. This field can be left blank. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. */ - floodlightActivityName?: string; + 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. */ @@ -3800,35 +3800,35 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + 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; + operator?: string | null; /** * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. */ - remarketingListId?: string; + 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; + 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; + 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; + 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; + variableName?: string | null; } /** * Remarketing List Targeting Expression. @@ -3837,7 +3837,7 @@ export namespace dfareporting_v3_1 { /** * Expression describing which lists are being targeted by the ad. */ - expression?: string; + expression?: string | null; } /** * Lookback configuration settings. @@ -3846,11 +3846,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + postImpressionActivitiesDuration?: number | null; } /** * Represents a metric. @@ -3859,11 +3859,11 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#metric. */ - kind?: string; + kind?: string | null; /** * The metric name, e.g. dfa:impressions */ - name?: string; + name?: string | null; } /** * Contains information about a metro region that can be targeted by ads. @@ -3872,31 +3872,31 @@ export namespace dfareporting_v3_1 { /** * Country code of the country to which this metro region belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this metro region belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this metro region. */ - dartId?: string; + 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; + dmaId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". */ - kind?: string; + kind?: string | null; /** * Metro code of this metro region. This is equivalent to dma_id. */ - metroCode?: string; + metroCode?: string | null; /** * Name of this metro region. */ - name?: string; + name?: string | null; } /** * Metro List Response @@ -3905,7 +3905,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". */ - kind?: string; + kind?: string | null; /** * Metro collection. */ @@ -3918,23 +3918,23 @@ export namespace dfareporting_v3_1 { /** * Mobile app directory. */ - directory?: string; + directory?: string | null; /** * ID of this mobile app. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". */ - kind?: string; + kind?: string | null; /** * Publisher name. */ - publisherName?: string; + publisherName?: string | null; /** * Title of this mobile app. */ - title?: string; + title?: string | null; } /** * Mobile app List Response @@ -3943,7 +3943,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". */ - kind?: string; + kind?: string | null; /** * Mobile apps collection. */ @@ -3951,7 +3951,7 @@ export namespace dfareporting_v3_1 { /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains information about a mobile carrier that can be targeted by ads. @@ -3960,23 +3960,23 @@ export namespace dfareporting_v3_1 { /** * Country code of the country to which this mobile carrier belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this mobile carrier belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * ID of this mobile carrier. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". */ - kind?: string; + kind?: string | null; /** * Name of this mobile carrier. */ - name?: string; + name?: string | null; } /** * Mobile Carrier List Response @@ -3985,7 +3985,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". */ - kind?: string; + kind?: string | null; /** * Mobile carrier collection. */ @@ -3998,15 +3998,15 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". */ - kind?: string; + kind?: string | null; /** * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. */ - objectIds?: string[]; + 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; + status?: string | null; } /** * Offset Position. @@ -4015,11 +4015,11 @@ export namespace dfareporting_v3_1 { /** * Offset distance from left side of an asset or a window. */ - left?: number; + left?: number | null; /** * Offset distance from top side of an asset or a window. */ - top?: number; + top?: number | null; } /** * Omniture Integration Settings. @@ -4028,11 +4028,11 @@ export namespace dfareporting_v3_1 { /** * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. */ - omnitureCostDataEnabled?: boolean; + 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; + omnitureIntegrationEnabled?: boolean | null; } /** * Contains information about an operating system that can be targeted by ads. @@ -4041,23 +4041,23 @@ export namespace dfareporting_v3_1 { /** * DART ID of this operating system. This is the ID used for targeting. */ - dartId?: string; + dartId?: string | null; /** * Whether this operating system is for desktop. */ - desktop?: boolean; + desktop?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". */ - kind?: string; + kind?: string | null; /** * Whether this operating system is for mobile. */ - mobile?: boolean; + mobile?: boolean | null; /** * Name of this operating system. */ - name?: string; + name?: string | null; } /** * Operating System List Response @@ -4066,7 +4066,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". */ - kind?: string; + kind?: string | null; /** * Operating system collection. */ @@ -4079,23 +4079,23 @@ export namespace dfareporting_v3_1 { /** * ID of this operating system version. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". */ - kind?: string; + kind?: string | null; /** * Major version (leftmost number) of this operating system version. */ - majorVersion?: string; + majorVersion?: string | null; /** * Minor version (number after the first dot) of this operating system version. */ - minorVersion?: string; + minorVersion?: string | null; /** * Name of this operating system version. */ - name?: string; + name?: string | null; /** * Operating system of this operating system version. */ @@ -4108,7 +4108,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". */ - kind?: string; + kind?: string | null; /** * Operating system version collection. */ @@ -4121,7 +4121,7 @@ export namespace dfareporting_v3_1 { /** * Floodlight activity ID of this optimization activity. This is a required field. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. */ @@ -4129,7 +4129,7 @@ export namespace dfareporting_v3_1 { /** * 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; + weight?: number | null; } /** * Describes properties of a Planning order. @@ -4138,27 +4138,27 @@ export namespace dfareporting_v3_1 { /** * Account ID of this order. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this order. */ - advertiserId?: string; + advertiserId?: string | null; /** * IDs for users that have to approve documents created for this order. */ - approverUserProfileIds?: string[]; + approverUserProfileIds?: string[] | null; /** * Buyer invoice ID associated with this order. */ - buyerInvoiceId?: string; + buyerInvoiceId?: string | null; /** * Name of the buyer organization. */ - buyerOrganizationName?: string; + buyerOrganizationName?: string | null; /** * Comments in this order. */ - comments?: string; + comments?: string | null; /** * Contacts for this order. */ @@ -4166,11 +4166,11 @@ export namespace dfareporting_v3_1 { /** * ID of this order. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this order. */ @@ -4178,43 +4178,43 @@ export namespace dfareporting_v3_1 { /** * Name of this order. */ - name?: string; + name?: string | null; /** * Notes of this order. */ - notes?: string; + notes?: string | null; /** * ID of the terms and conditions template used in this order. */ - planningTermId?: string; + planningTermId?: string | null; /** * Project ID of this order. */ - projectId?: string; + projectId?: string | null; /** * Seller order ID associated with this order. */ - sellerOrderId?: string; + sellerOrderId?: string | null; /** * Name of the seller organization. */ - sellerOrganizationName?: string; + sellerOrganizationName?: string | null; /** * Site IDs this order is associated with. */ - siteId?: string[]; + siteId?: string[] | null; /** * Free-form site names this order is associated with. */ - siteNames?: string[]; + siteNames?: string[] | null; /** * Subaccount ID of this order. */ - subaccountId?: string; + subaccountId?: string | null; /** * Terms and conditions of this order. */ - termsAndConditions?: string; + termsAndConditions?: string | null; } /** * Contact of an order. @@ -4223,23 +4223,23 @@ export namespace dfareporting_v3_1 { /** * 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; + contactInfo?: string | null; /** * Name of this contact. */ - contactName?: string; + contactName?: string | null; /** * Title of this contact. */ - contactTitle?: string; + contactTitle?: string | null; /** * Type of this contact. */ - contactType?: string; + contactType?: string | null; /** * ID of the user profile containing the signature that will be embedded into order documents. */ - signatureUserProfileId?: string; + signatureUserProfileId?: string | null; } /** * Contains properties of a Planning order document. @@ -4248,23 +4248,23 @@ export namespace dfareporting_v3_1 { /** * Account ID of this order document. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this order document. */ - advertiserId?: string; + 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; + amendedOrderDocumentId?: string | null; /** * IDs of users who have approved this order document. */ - approvedByUserProfileIds?: string[]; + approvedByUserProfileIds?: string[] | null; /** * Whether this order document is cancelled. */ - cancelled?: boolean; + cancelled?: boolean | null; /** * Information about the creation of this order document. */ @@ -4272,47 +4272,47 @@ export namespace dfareporting_v3_1 { /** * Effective date of this order document. */ - effectiveDate?: string; + effectiveDate?: string | null; /** * ID of this order document. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". */ - kind?: string; + kind?: string | null; /** * List of email addresses that received the last sent document. */ - lastSentRecipients?: string[]; + lastSentRecipients?: string[] | null; /** * Timestamp of the last email sent with this order document. */ - lastSentTime?: string; + lastSentTime?: string | null; /** * ID of the order from which this order document is created. */ - orderId?: string; + orderId?: string | null; /** * Project ID of this order document. */ - projectId?: string; + projectId?: string | null; /** * Whether this order document has been signed. */ - signed?: boolean; + signed?: boolean | null; /** * Subaccount ID of this order document. */ - subaccountId?: string; + subaccountId?: string | null; /** * Title of this order document. */ - title?: string; + title?: string | null; /** * Type of this order document */ - type?: string; + type?: string | null; } /** * Order document List Response @@ -4321,11 +4321,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Order document collection */ @@ -4338,11 +4338,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Order collection. */ @@ -4363,7 +4363,7 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -4380,11 +4380,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this placement. This field can be left blank. */ - accountId?: string; + 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; + adBlockingOptOut?: boolean | null; /** * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. */ @@ -4392,7 +4392,7 @@ export namespace dfareporting_v3_1 { /** * Advertiser ID of this placement. This field can be left blank. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -4400,11 +4400,11 @@ export namespace dfareporting_v3_1 { /** * Whether this placement is archived. */ - archived?: boolean; + archived?: boolean | null; /** * Campaign ID of this placement. This field is a required field on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -4412,15 +4412,15 @@ export namespace dfareporting_v3_1 { /** * Comments for this placement. */ - comment?: string; + 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; + compatibility?: string | null; /** * ID of the content category assigned to this placement. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Information about the creation of this placement. This is a read-only field. */ @@ -4428,7 +4428,7 @@ export namespace dfareporting_v3_1 { /** * 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; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -4436,11 +4436,11 @@ export namespace dfareporting_v3_1 { /** * External ID for this placement. */ - externalId?: string; + externalId?: string | null; /** * ID of this placement. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this placement. This is a read-only, auto-generated field. */ @@ -4448,11 +4448,11 @@ export namespace dfareporting_v3_1 { /** * Key name of this placement. This is a read-only, auto-generated field. */ - keyName?: string; + keyName?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this placement. This is a read-only field. */ @@ -4464,19 +4464,19 @@ export namespace dfareporting_v3_1 { /** * Name of this placement.This is a required field and must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. */ - paymentApproved?: boolean; + paymentApproved?: boolean | null; /** * Payment source for this placement. This is a required field that is read-only after insertion. */ - paymentSource?: string; + paymentSource?: string | null; /** * ID of this placement's group, if applicable. */ - placementGroupId?: string; + placementGroupId?: string | null; /** * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. */ @@ -4484,7 +4484,7 @@ export namespace dfareporting_v3_1 { /** * ID of the placement strategy assigned to this placement. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. */ @@ -4492,7 +4492,7 @@ export namespace dfareporting_v3_1 { /** * 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; + primary?: boolean | null; /** * Information about the last publisher update. This is a read-only field. */ @@ -4500,7 +4500,7 @@ export namespace dfareporting_v3_1 { /** * 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; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -4512,19 +4512,19 @@ export namespace dfareporting_v3_1 { /** * Whether creatives assigned to this placement must be SSL-compliant. */ - sslRequired?: boolean; + sslRequired?: boolean | null; /** * Third-party placement status. */ - status?: string; + status?: string | null; /** * Subaccount ID of this placement. This field can be left blank. */ - subaccountId?: string; + 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[]; + tagFormats?: string[] | null; /** * Tag settings for this placement. */ @@ -4532,7 +4532,7 @@ export namespace dfareporting_v3_1 { /** * 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; + videoActiveViewOptOut?: boolean | null; /** * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. */ @@ -4540,7 +4540,7 @@ export namespace dfareporting_v3_1 { /** * 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; + vpaidAdapterChoice?: string | null; } /** * Placement Assignment. @@ -4549,11 +4549,11 @@ export namespace dfareporting_v3_1 { /** * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. */ - active?: boolean; + active?: boolean | null; /** * ID of the placement to be assigned. This is a required field. */ - placementId?: string; + placementId?: string | null; /** * Dimension value for the ID of the placement. This is a read-only, auto-generated field. */ @@ -4561,7 +4561,7 @@ export namespace dfareporting_v3_1 { /** * 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; + sslRequired?: boolean | null; } /** * Contains properties of a package or roadblock. @@ -4570,11 +4570,11 @@ export namespace dfareporting_v3_1 { /** * Account ID of this placement group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this placement group. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -4582,11 +4582,11 @@ export namespace dfareporting_v3_1 { /** * Whether this placement group is archived. */ - archived?: boolean; + archived?: boolean | null; /** * Campaign ID of this placement group. This field is required on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -4594,15 +4594,15 @@ export namespace dfareporting_v3_1 { /** * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. */ - childPlacementIds?: string[]; + childPlacementIds?: string[] | null; /** * Comments for this placement group. */ - comment?: string; + comment?: string | null; /** * ID of the content category assigned to this placement group. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Information about the creation of this placement group. This is a read-only field. */ @@ -4610,7 +4610,7 @@ export namespace dfareporting_v3_1 { /** * 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; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -4618,11 +4618,11 @@ export namespace dfareporting_v3_1 { /** * External ID for this placement. */ - externalId?: string; + externalId?: string | null; /** * ID of this placement group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. */ @@ -4630,7 +4630,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this placement group. This is a read-only field. */ @@ -4638,15 +4638,15 @@ export namespace dfareporting_v3_1 { /** * Name of this placement group. This is a required field and must be less than 256 characters long. */ - name?: string; + 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; + placementGroupType?: string | null; /** * ID of the placement strategy assigned to this placement group. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing schedule of this placement group. This field is required on insertion. */ @@ -4654,7 +4654,7 @@ export namespace dfareporting_v3_1 { /** * 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; + primaryPlacementId?: string | null; /** * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. */ @@ -4662,7 +4662,7 @@ export namespace dfareporting_v3_1 { /** * 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; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -4670,7 +4670,7 @@ export namespace dfareporting_v3_1 { /** * Subaccount ID of this placement group. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Placement Group List Response @@ -4679,11 +4679,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement group collection. */ @@ -4696,7 +4696,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". */ - kind?: string; + kind?: string | null; /** * Set of generated tags for the specified placements. */ @@ -4709,11 +4709,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement collection. */ @@ -4726,11 +4726,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement strategy collection. */ @@ -4743,19 +4743,19 @@ export namespace dfareporting_v3_1 { /** * Account ID of this placement strategy.This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this placement strategy. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". */ - kind?: string; + 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; + name?: string | null; } /** * Placement Tag @@ -4764,7 +4764,7 @@ export namespace dfareporting_v3_1 { /** * Placement ID */ - placementId?: string; + placementId?: string | null; /** * Tags generated for this placement. */ @@ -4777,15 +4777,15 @@ export namespace dfareporting_v3_1 { /** * ID of this platform type. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". */ - kind?: string; + kind?: string | null; /** * Name of this platform type. */ - name?: string; + name?: string | null; } /** * Platform Type List Response @@ -4794,7 +4794,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". */ - kind?: string; + kind?: string | null; /** * Platform type collection. */ @@ -4815,31 +4815,31 @@ export namespace dfareporting_v3_1 { /** * Popup window position either centered or at specific coordinate. */ - positionType?: string; + positionType?: string | null; /** * Whether to display the browser address bar. */ - showAddressBar?: boolean; + showAddressBar?: boolean | null; /** * Whether to display the browser menu bar. */ - showMenuBar?: boolean; + showMenuBar?: boolean | null; /** * Whether to display the browser scroll bar. */ - showScrollBar?: boolean; + showScrollBar?: boolean | null; /** * Whether to display the browser status bar. */ - showStatusBar?: boolean; + showStatusBar?: boolean | null; /** * Whether to display the browser tool bar. */ - showToolBar?: boolean; + showToolBar?: boolean | null; /** * Title of popup window. */ - title?: string; + title?: string | null; } /** * Contains information about a postal code that can be targeted by ads. @@ -4848,23 +4848,23 @@ export namespace dfareporting_v3_1 { /** * Postal code. This is equivalent to the id field. */ - code?: string; + code?: string | null; /** * Country code of the country to which this postal code belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this postal code belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * ID of this postal code. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". */ - kind?: string; + kind?: string | null; } /** * Postal Code List Response @@ -4873,7 +4873,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". */ - kind?: string; + kind?: string | null; /** * Postal code collection. */ @@ -4886,11 +4886,11 @@ export namespace dfareporting_v3_1 { /** * Cap cost type of this inventory item. */ - capCostType?: string; + capCostType?: string | null; /** * End date of this inventory item. */ - endDate?: string; + 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. */ @@ -4898,15 +4898,15 @@ export namespace dfareporting_v3_1 { /** * 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; + groupType?: string | null; /** * Pricing type of this inventory item. */ - pricingType?: string; + pricingType?: string | null; /** * Start date of this inventory item. */ - startDate?: string; + startDate?: string | null; } /** * Pricing Schedule @@ -4915,19 +4915,19 @@ export namespace dfareporting_v3_1 { /** * Placement cap cost option. */ - capCostOption?: string; + capCostOption?: string | null; /** * Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion. */ - endDate?: string; + endDate?: string | null; /** * Whether this placement is flighted. If true, pricing periods will be computed automatically. */ - flighted?: boolean; + 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; + floodlightActivityId?: string | null; /** * Pricing periods for this placement. */ @@ -4935,15 +4935,15 @@ export namespace dfareporting_v3_1 { /** * Placement pricing type. This field is required on insertion. */ - pricingType?: string; + 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; + 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; + testingStartDate?: string | null; } /** * Pricing Period @@ -4952,23 +4952,23 @@ export namespace dfareporting_v3_1 { /** * 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; + endDate?: string | null; /** * Comments for this pricing period. */ - pricingComment?: string; + 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; + 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; + startDate?: string | null; /** * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. */ - units?: string; + units?: string | null; } /** * Contains properties of a Planning project. @@ -4977,43 +4977,43 @@ export namespace dfareporting_v3_1 { /** * Account ID of this project. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this project. */ - advertiserId?: string; + advertiserId?: string | null; /** * Audience age group of this project. */ - audienceAgeGroup?: string; + audienceAgeGroup?: string | null; /** * Audience gender of this project. */ - audienceGender?: string; + 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; + budget?: string | null; /** * Client billing code of this project. */ - clientBillingCode?: string; + clientBillingCode?: string | null; /** * Name of the project client. */ - clientName?: string; + clientName?: string | null; /** * End date of the project. */ - endDate?: string; + endDate?: string | null; /** * ID of this project. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this project. */ @@ -5021,47 +5021,47 @@ export namespace dfareporting_v3_1 { /** * Name of this project. */ - name?: string; + name?: string | null; /** * Overview of this project. */ - overview?: string; + overview?: string | null; /** * Start date of the project. */ - startDate?: string; + startDate?: string | null; /** * Subaccount ID of this project. */ - subaccountId?: string; + subaccountId?: string | null; /** * Number of clicks that the advertiser is targeting. */ - targetClicks?: string; + targetClicks?: string | null; /** * Number of conversions that the advertiser is targeting. */ - targetConversions?: string; + targetConversions?: string | null; /** * CPA that the advertiser is targeting. */ - targetCpaNanos?: string; + targetCpaNanos?: string | null; /** * CPC that the advertiser is targeting. */ - targetCpcNanos?: string; + targetCpcNanos?: string | null; /** * vCPM from Active View that the advertiser is targeting. */ - targetCpmActiveViewNanos?: string; + targetCpmActiveViewNanos?: string | null; /** * CPM that the advertiser is targeting. */ - targetCpmNanos?: string; + targetCpmNanos?: string | null; /** * Number of impressions that the advertiser is targeting. */ - targetImpressions?: string; + targetImpressions?: string | null; } /** * Project List Response @@ -5070,11 +5070,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Project collection. */ @@ -5095,7 +5095,7 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -5116,15 +5116,15 @@ export namespace dfareporting_v3_1 { /** * The delivery type for the recipient. */ - deliveryType?: string; + deliveryType?: string | null; /** * The email address of the recipient. */ - email?: string; + email?: string | null; /** * The kind of resource this is, in this case dfareporting#recipient. */ - kind?: string; + kind?: string | null; } /** * Contains information about a region that can be targeted by ads. @@ -5133,27 +5133,27 @@ export namespace dfareporting_v3_1 { /** * Country code of the country to which this region belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this region belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this region. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". */ - kind?: string; + kind?: string | null; /** * Name of this region. */ - name?: string; + name?: string | null; /** * Region code. */ - regionCode?: string; + regionCode?: string | null; } /** * Region List Response @@ -5162,7 +5162,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". */ - kind?: string; + kind?: string | null; /** * Region collection. */ @@ -5175,15 +5175,15 @@ export namespace dfareporting_v3_1 { /** * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ - accountId?: string; + accountId?: string | null; /** * Whether this remarketing list is active. */ - active?: boolean; + active?: boolean | null; /** * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -5191,19 +5191,19 @@ export namespace dfareporting_v3_1 { /** * Remarketing list description. */ - description?: string; + description?: string | null; /** * Remarketing list ID. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". */ - kind?: string; + 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; + lifeSpan?: string | null; /** * Rule used to populate the remarketing list with users. */ @@ -5211,19 +5211,19 @@ export namespace dfareporting_v3_1 { /** * Number of users currently in the list. This is a read-only field. */ - listSize?: string; + listSize?: string | null; /** * Product from which this remarketing list was originated. */ - listSource?: string; + listSource?: string | null; /** * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. */ - name?: string; + 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; + 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. @@ -5232,19 +5232,19 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". */ - kind?: string; + kind?: string | null; /** * Remarketing list ID. This is a read-only, auto-generated field. */ - remarketingListId?: string; + remarketingListId?: string | null; /** * Accounts that the remarketing list is shared with. */ - sharedAccountIds?: string[]; + sharedAccountIds?: string[] | null; /** * Advertisers that the remarketing list is shared with. */ - sharedAdvertiserIds?: string[]; + sharedAdvertiserIds?: string[] | null; } /** * Remarketing list response @@ -5253,11 +5253,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Remarketing list collection. */ @@ -5270,7 +5270,7 @@ export namespace dfareporting_v3_1 { /** * The account ID to which this report belongs. */ - accountId?: string; + accountId?: string | null; /** * The report criteria for a report of type "STANDARD". */ @@ -5281,7 +5281,7 @@ export namespace dfareporting_v3_1 { dimensionFilters?: Schema$DimensionValue[]; dimensions?: Schema$SortedDimension[]; metricNames?: string[]; - }; + } | null; /** * The report criteria for a report of type "CROSS_DIMENSION_REACH". */ @@ -5293,7 +5293,7 @@ export namespace dfareporting_v3_1 { metricNames?: string[]; overlapMetricNames?: string[]; pivoted?: boolean; - }; + } | null; /** * The report's email delivery settings. */ @@ -5302,15 +5302,15 @@ export namespace dfareporting_v3_1 { emailOwnerDeliveryType?: string; message?: string; recipients?: Schema$Recipient[]; - }; + } | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The filename used when generating report files for this report. */ - fileName?: string; + fileName?: string | null; /** * The report criteria for a report of type "FLOODLIGHT". */ @@ -5326,31 +5326,31 @@ export namespace dfareporting_v3_1 { 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; + format?: string | null; /** * The unique ID identifying this report resource. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#report. */ - kind?: string; + kind?: string | null; /** * The timestamp (in milliseconds since epoch) of when this report was last modified. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * The name of the report. */ - name?: string; + name?: string | null; /** * The user profile id of the owner of this report. */ - ownerProfileId?: string; + ownerProfileId?: string | null; /** * The report criteria for a report of type "PATH_TO_CONVERSION". */ @@ -5374,7 +5374,7 @@ export namespace dfareporting_v3_1 { maximumInteractionGap?: number; pivotOnInteractionPath?: boolean; }; - }; + } | null; /** * The report criteria for a report of type "REACH". */ @@ -5387,7 +5387,7 @@ export namespace dfareporting_v3_1 { 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". */ @@ -5399,15 +5399,15 @@ export namespace dfareporting_v3_1 { repeatsOnWeekDays?: string[]; runsOnDayOfMonth?: string; startDate?: string; - }; + } | null; /** * The subaccount ID to which this report belongs if applicable. */ - subAccountId?: string; + subAccountId?: string | null; /** * The type of the report. */ - type?: string; + type?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "STANDARD". @@ -5424,7 +5424,7 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#reportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -5441,7 +5441,7 @@ export namespace dfareporting_v3_1 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The reports returned in this response. */ @@ -5449,11 +5449,11 @@ export namespace dfareporting_v3_1 { /** * The kind of list this is, in this case dfareporting#reportList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Reporting Configuration @@ -5462,7 +5462,7 @@ export namespace dfareporting_v3_1 { /** * 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; + exposureToConversionEnabled?: boolean | null; /** * Default lookback windows for new advertisers in this account. */ @@ -5470,7 +5470,7 @@ export namespace dfareporting_v3_1 { /** * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" */ - reportGenerationTimeZoneId?: string; + reportGenerationTimeZoneId?: string | null; } /** * Rich Media Exit Override. @@ -5483,11 +5483,11 @@ export namespace dfareporting_v3_1 { /** * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. */ - enabled?: boolean; + enabled?: boolean | null; /** * ID for the override to refer to a specific exit in the creative. */ - exitId?: string; + exitId?: string | null; } /** * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. @@ -5496,15 +5496,15 @@ export namespace dfareporting_v3_1 { /** * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. */ - assetId?: string; + assetId?: string | null; /** * A user-friendly name for this rule. This is a required field. */ - name?: string; + 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; + targetingTemplateId?: string | null; } /** * Contains properties of a site. @@ -5513,15 +5513,15 @@ export namespace dfareporting_v3_1 { /** * Account ID of this site. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Whether this site is approved. */ - approved?: boolean; + approved?: boolean | null; /** * Directory site associated with this site. This is a required field that is read-only after insertion. */ - directorySiteId?: string; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -5529,7 +5529,7 @@ export namespace dfareporting_v3_1 { /** * ID of this site. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this site. This is a read-only, auto-generated field. */ @@ -5537,15 +5537,15 @@ export namespace dfareporting_v3_1 { /** * Key name of this site. This is a read-only, auto-generated field. */ - keyName?: string; + keyName?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". */ - kind?: string; + 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; + name?: string | null; /** * Site contacts. */ @@ -5557,7 +5557,7 @@ export namespace dfareporting_v3_1 { /** * Subaccount ID of this site. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Site Contact @@ -5566,35 +5566,35 @@ export namespace dfareporting_v3_1 { /** * Address of this site contact. */ - address?: string; + address?: string | null; /** * Site contact type. */ - contactType?: string; + contactType?: string | null; /** * Email address of this site contact. This is a required field. */ - email?: string; + email?: string | null; /** * First name of this site contact. */ - firstName?: string; + firstName?: string | null; /** * ID of this site contact. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Last name of this site contact. */ - lastName?: string; + lastName?: string | null; /** * Primary phone number of this site contact. */ - phone?: string; + phone?: string | null; /** * Title or designation of this site contact. */ - title?: string; + title?: string | null; } /** * Site Settings @@ -5603,15 +5603,15 @@ export namespace dfareporting_v3_1 { /** * Whether active view creatives are disabled for this site. */ - activeViewOptOut?: boolean; + 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; + adBlockingOptOut?: boolean | null; /** * Whether new cookies are disabled for this site. */ - disableNewCookie?: boolean; + disableNewCookie?: boolean | null; /** * Configuration settings for dynamic and image floodlight tags. */ @@ -5619,11 +5619,11 @@ export namespace dfareporting_v3_1 { /** * 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; + 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; + vpaidAdapterChoiceTemplate?: string | null; } /** * Site List Response @@ -5632,11 +5632,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Site collection. */ @@ -5649,23 +5649,23 @@ export namespace dfareporting_v3_1 { /** * Height of this size. Acceptable values are 0 to 32767, inclusive. */ - height?: number; + height?: number | null; /** * IAB standard size. This is a read-only, auto-generated field. */ - iab?: boolean; + iab?: boolean | null; /** * ID of this size. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". */ - kind?: string; + kind?: string | null; /** * Width of this size. Acceptable values are 0 to 32767, inclusive. */ - width?: number; + width?: number | null; } /** * Size List Response @@ -5674,7 +5674,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". */ - kind?: string; + kind?: string | null; /** * Size collection. */ @@ -5687,7 +5687,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". */ - kind?: string; + kind?: string | null; /** * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. */ @@ -5699,7 +5699,7 @@ export namespace dfareporting_v3_1 { /** * Whether the user can skip creatives served to this placement. */ - skippable?: boolean; + skippable?: boolean | null; } /** * Represents a sorted dimension. @@ -5708,15 +5708,15 @@ export namespace dfareporting_v3_1 { /** * The kind of resource this is, in this case dfareporting#sortedDimension. */ - kind?: string; + kind?: string | null; /** * The name of the dimension. */ - name?: string; + name?: string | null; /** * An optional sort order for the dimension column. */ - sortOrder?: string; + sortOrder?: string | null; } /** * Contains properties of a Campaign Manager subaccount. @@ -5725,23 +5725,23 @@ export namespace dfareporting_v3_1 { /** * ID of the account that contains this subaccount. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * IDs of the available user role permissions for this subaccount. */ - availablePermissionIds?: string[]; + availablePermissionIds?: string[] | null; /** * ID of this subaccount. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". */ - kind?: string; + 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; + name?: string | null; } /** * Subaccount List Response @@ -5750,11 +5750,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Subaccount collection. */ @@ -5767,23 +5767,23 @@ export namespace dfareporting_v3_1 { /** * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ - adId?: string; + adId?: string | null; /** * Tag string to record a click. */ - clickTag?: string; + clickTag?: string | null; /** * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ - creativeId?: string; + creativeId?: string | null; /** * TagData tag format of this tag. */ - format?: string; + format?: string | null; /** * Tag string for serving an ad. */ - impressionTag?: string; + impressionTag?: string | null; } /** * Tag Settings @@ -5792,19 +5792,19 @@ export namespace dfareporting_v3_1 { /** * 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; + additionalKeyValues?: string | null; /** * Whether static landing page URLs should be included in the tags. This setting applies only to placements. */ - includeClickThroughUrls?: boolean; + includeClickThroughUrls?: boolean | null; /** * Whether click-tracking string should be included in the tags. */ - includeClickTracking?: boolean; + 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; + keywordOption?: string | null; } /** * Dynamic and Image Tag Settings. @@ -5813,11 +5813,11 @@ export namespace dfareporting_v3_1 { /** * Whether dynamic floodlight tags are enabled. */ - dynamicTagEnabled?: boolean; + dynamicTagEnabled?: boolean | null; /** * Whether image tags are enabled. */ - imageTagEnabled?: boolean; + 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. @@ -5826,15 +5826,15 @@ export namespace dfareporting_v3_1 { /** * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ - accountId?: string; + accountId?: string | null; /** * Whether this targetable remarketing list is active. */ - active?: boolean; + active?: boolean | null; /** * Dimension value for the advertiser ID that owns this targetable remarketing list. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. */ @@ -5842,35 +5842,35 @@ export namespace dfareporting_v3_1 { /** * Targetable remarketing list description. */ - description?: string; + description?: string | null; /** * Targetable remarketing list ID. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". */ - kind?: string; + kind?: string | null; /** * Number of days that a user should remain in the targetable remarketing list without an impression. */ - lifeSpan?: string; + lifeSpan?: string | null; /** * Number of users currently in the list. This is a read-only field. */ - listSize?: string; + listSize?: string | null; /** * Product from which this targetable remarketing list was originated. */ - listSource?: string; + listSource?: string | null; /** * Name of the targetable remarketing list. Is no greater than 128 characters long. */ - name?: string; + 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; + subaccountId?: string | null; } /** * Targetable remarketing list response @@ -5879,11 +5879,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Targetable remarketing list collection. */ @@ -5896,11 +5896,11 @@ export namespace dfareporting_v3_1 { /** * 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; + accountId?: string | null; /** * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -5916,7 +5916,7 @@ export namespace dfareporting_v3_1 { /** * ID of this targeting template. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Key-value targeting criteria. */ @@ -5924,7 +5924,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". */ - kind?: string; + kind?: string | null; /** * Language targeting criteria. */ @@ -5936,11 +5936,11 @@ export namespace dfareporting_v3_1 { /** * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. */ - name?: string; + 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; + subaccountId?: string | null; /** * Technology platform targeting criteria. */ @@ -5953,11 +5953,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Targeting template collection. */ @@ -5970,11 +5970,11 @@ export namespace dfareporting_v3_1 { /** * User-entered value. */ - customHtml?: string; + customHtml?: string | null; /** * Type of browser window for which the backup image of the flash creative can be displayed. */ - targetWindowOption?: string; + targetWindowOption?: string | null; } /** * Technology Targeting. @@ -6012,11 +6012,11 @@ export namespace dfareporting_v3_1 { /** * Name of the third-party authentication token. */ - name?: string; + name?: string | null; /** * Value of the third-party authentication token. This is a read-only, auto-generated field. */ - value?: string; + value?: string | null; } /** * Third-party Tracking URL. @@ -6025,11 +6025,11 @@ export namespace dfareporting_v3_1 { /** * Third-party URL type for in-stream video and in-stream audio creatives. */ - thirdPartyUrlType?: string; + thirdPartyUrlType?: string | null; /** * URL for the specified third-party URL type. */ - url?: string; + url?: string | null; } /** * Transcode Settings @@ -6038,11 +6038,11 @@ export namespace dfareporting_v3_1 { /** * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. */ - enabledVideoFormats?: number[]; + enabledVideoFormats?: number[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". */ - kind?: string; + 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. @@ -6051,11 +6051,11 @@ export namespace dfareporting_v3_1 { /** * Registry used for the Ad ID value. */ - registry?: string; + 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; + value?: string | null; } /** * User Defined Variable configuration. @@ -6064,15 +6064,15 @@ export namespace dfareporting_v3_1 { /** * Data type for the variable. This is a required field. */ - dataType?: string; + 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; + reportName?: string | null; /** * Variable name in the tag. This is a required field. */ - variableType?: string; + variableType?: string | null; } /** * Represents a UserProfile resource. @@ -6081,35 +6081,35 @@ export namespace dfareporting_v3_1 { /** * The account ID to which this profile belongs. */ - accountId?: string; + accountId?: string | null; /** * The account name this profile belongs to. */ - accountName?: string; + accountName?: string | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The kind of resource this is, in this case dfareporting#userProfile. */ - kind?: string; + kind?: string | null; /** * The unique ID of the user profile. */ - profileId?: string; + profileId?: string | null; /** * The sub account ID this profile belongs to if applicable. */ - subAccountId?: string; + subAccountId?: string | null; /** * The sub account name this profile belongs to if applicable. */ - subAccountName?: string; + subAccountName?: string | null; /** * The user name. */ - userName?: string; + userName?: string | null; } /** * Represents the list of user profiles. @@ -6118,7 +6118,7 @@ export namespace dfareporting_v3_1 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The user profiles returned in this response. */ @@ -6126,7 +6126,7 @@ export namespace dfareporting_v3_1 { /** * The kind of list this is, in this case dfareporting#userProfileList. */ - kind?: string; + kind?: string | null; } /** * Contains properties of auser role, which is used to manage user access. @@ -6135,27 +6135,27 @@ export namespace dfareporting_v3_1 { /** * Account ID of this user role. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + defaultUserRole?: boolean | null; /** * ID of this user role. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". */ - kind?: string; + 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; + 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; + parentUserRoleId?: string | null; /** * List of permissions associated with this user role. */ @@ -6163,7 +6163,7 @@ export namespace dfareporting_v3_1 { /** * Subaccount ID of this user role. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Contains properties of a user role permission. @@ -6172,23 +6172,23 @@ export namespace dfareporting_v3_1 { /** * Levels of availability for a user role permission. */ - availability?: string; + availability?: string | null; /** * ID of this user role permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". */ - kind?: string; + kind?: string | null; /** * Name of this user role permission. */ - name?: string; + name?: string | null; /** * ID of the permission group that this user role permission belongs to. */ - permissionGroupId?: string; + permissionGroupId?: string | null; } /** * Represents a grouping of related user role permissions. @@ -6197,15 +6197,15 @@ export namespace dfareporting_v3_1 { /** * ID of this user role permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". */ - kind?: string; + kind?: string | null; /** * Name of this user role permission group. */ - name?: string; + name?: string | null; } /** * User Role Permission Group List Response @@ -6214,7 +6214,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * User role permission group collection. */ @@ -6227,7 +6227,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". */ - kind?: string; + kind?: string | null; /** * User role permission collection. */ @@ -6240,11 +6240,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * User role collection. */ @@ -6257,15 +6257,15 @@ export namespace dfareporting_v3_1 { /** * File type of the video format. */ - fileType?: string; + fileType?: string | null; /** * ID of the video format. */ - id?: number; + id?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". */ - kind?: string; + kind?: string | null; /** * The resolution of this video format. */ @@ -6273,7 +6273,7 @@ export namespace dfareporting_v3_1 { /** * The target bit rate of this video format. */ - targetBitRate?: number; + targetBitRate?: number | null; } /** * Video Format List Response @@ -6282,7 +6282,7 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". */ - kind?: string; + kind?: string | null; /** * Video format collection. */ @@ -6295,11 +6295,11 @@ export namespace dfareporting_v3_1 { /** * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. */ - offsetPercentage?: number; + offsetPercentage?: number | null; /** * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. */ - offsetSeconds?: number; + offsetSeconds?: number | null; } /** * Video Settings @@ -6312,11 +6312,11 @@ export namespace dfareporting_v3_1 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". */ - kind?: string; + kind?: string | null; /** * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. */ - orientation?: string; + 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. */ diff --git a/src/apis/dfareporting/v3.2.ts b/src/apis/dfareporting/v3.2.ts index 5be24c9aef1..f0d8e0c3a48 100644 --- a/src/apis/dfareporting/v3.2.ts +++ b/src/apis/dfareporting/v3.2.ts @@ -254,67 +254,67 @@ export namespace dfareporting_v3_2 { /** * Account permissions assigned to this account. */ - accountPermissionIds?: string[]; + accountPermissionIds?: string[] | null; /** * Profile for this account. This is a read-only field that can be left blank. */ - accountProfile?: string; + accountProfile?: string | null; /** * Whether this account is active. */ - active?: boolean; + active?: boolean | null; /** * Maximum number of active ads allowed for this account. */ - activeAdsLimitTier?: string; + activeAdsLimitTier?: string | null; /** * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. */ - activeViewOptOut?: boolean; + activeViewOptOut?: boolean | null; /** * User role permissions available to the user roles of this account. */ - availablePermissionIds?: string[]; + availablePermissionIds?: string[] | null; /** * ID of the country associated with this account. */ - countryId?: string; + countryId?: string | null; /** * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ - currencyId?: string; + currencyId?: string | null; /** * Default placement dimensions for this account. */ - defaultCreativeSizeId?: string; + defaultCreativeSizeId?: string | null; /** * Description of this account. */ - description?: string; + description?: string | null; /** * ID of this account. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". */ - kind?: string; + 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; + locale?: string | null; /** * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. */ - maximumImageSize?: string; + 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; + name?: string | null; /** * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. */ - nielsenOcrEnabled?: boolean; + nielsenOcrEnabled?: boolean | null; /** * Reporting configuration of this account. */ @@ -322,11 +322,11 @@ export namespace dfareporting_v3_2 { /** * Share Path to Conversion reports with Twitter. */ - shareReportsWithTwitter?: boolean; + shareReportsWithTwitter?: boolean | null; /** * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. */ - teaserSizeLimit?: string; + teaserSizeLimit?: string | null; } /** * Gets a summary of active ads in an account. @@ -335,23 +335,23 @@ export namespace dfareporting_v3_2 { /** * ID of the account. */ - accountId?: string; + accountId?: string | null; /** * Ads that have been activated for the account */ - activeAds?: string; + activeAds?: string | null; /** * Maximum number of active ads allowed for the account. */ - activeAdsLimitTier?: string; + activeAdsLimitTier?: string | null; /** * Ads that can be activated for the account. */ - availableAds?: string; + availableAds?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". */ - kind?: string; + 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. @@ -360,27 +360,27 @@ export namespace dfareporting_v3_2 { /** * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" */ - accountProfiles?: string[]; + accountProfiles?: string[] | null; /** * ID of this account permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". */ - kind?: string; + kind?: string | null; /** * Administrative level required to enable this account permission. */ - level?: string; + level?: string | null; /** * Name of this account permission. */ - name?: string; + name?: string | null; /** * Permission group of this account permission. */ - permissionGroupId?: string; + permissionGroupId?: string | null; } /** * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. @@ -389,15 +389,15 @@ export namespace dfareporting_v3_2 { /** * ID of this account permission group. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". */ - kind?: string; + kind?: string | null; /** * Name of this account permission group. */ - name?: string; + name?: string | null; } /** * Account Permission Group List Response @@ -410,7 +410,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". */ - kind?: string; + kind?: string | null; } /** * Account Permission List Response @@ -423,7 +423,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". */ - kind?: string; + kind?: string | null; } /** * Account List Response @@ -436,11 +436,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + 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. @@ -449,11 +449,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of the user profile. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + active?: boolean | null; /** * Filter that describes which advertisers are visible to the user profile. */ @@ -465,27 +465,27 @@ export namespace dfareporting_v3_2 { /** * Comments for this user profile. */ - comments?: string; + 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; + email?: string | null; /** * ID of the user profile. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". */ - kind?: string; + 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; + 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; + name?: string | null; /** * Filter that describes which sites are visible to the user profile. */ @@ -493,15 +493,15 @@ export namespace dfareporting_v3_2 { /** * Subaccount ID of the user profile. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Trafficker type of this user profile. This is a read-only field. */ - traffickerType?: string; + traffickerType?: string | null; /** * User type of the user profile. This is a read-only field that can be left blank. */ - userAccessType?: string; + userAccessType?: string | null; /** * Filter that describes which user roles are visible to the user profile. */ @@ -509,7 +509,7 @@ export namespace dfareporting_v3_2 { /** * User role ID of the user profile. This is a required field. */ - userRoleId?: string; + userRoleId?: string | null; } /** * Account User Profile List Response @@ -522,11 +522,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Represents an activity group. @@ -539,11 +539,11 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#activities. */ - kind?: string; + kind?: string | null; /** * List of names of floodlight activity metrics. */ - metricNames?: string[]; + metricNames?: string[] | null; } /** * Contains properties of a Campaign Manager ad. @@ -552,15 +552,15 @@ export namespace dfareporting_v3_2 { /** * Account ID of this ad. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Whether this ad is active. When true, archived must be false. */ - active?: boolean; + active?: boolean | null; /** * Advertiser ID of this ad. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -568,15 +568,15 @@ export namespace dfareporting_v3_2 { /** * Whether this ad is archived. When true, active must be false. */ - archived?: boolean; + archived?: boolean | null; /** * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. */ - audienceSegmentId?: string; + audienceSegmentId?: string | null; /** * Campaign ID of this ad. This is a required field on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -592,11 +592,11 @@ export namespace dfareporting_v3_2 { /** * Comments for this ad. */ - comments?: string; + 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; + compatibility?: string | null; /** * Information about the creation of this ad. This is a read-only field. */ @@ -624,11 +624,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + endTime?: string | null; /** * Event tag overrides for this ad. */ @@ -640,7 +640,7 @@ export namespace dfareporting_v3_2 { /** * ID of this ad. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this ad. This is a read-only, auto-generated field. */ @@ -652,7 +652,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". */ - kind?: string; + 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. */ @@ -664,7 +664,7 @@ export namespace dfareporting_v3_2 { /** * Name of this ad. This is a required field and must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * Placement assignments for this ad. */ @@ -680,23 +680,23 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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; + startTime?: string | null; /** * Subaccount ID of this ad. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + 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. */ @@ -704,7 +704,7 @@ export namespace dfareporting_v3_2 { /** * 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; + type?: string | null; } /** * Campaign ad blocking settings. @@ -713,19 +713,19 @@ export namespace dfareporting_v3_2 { /** * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. */ - clickThroughUrl?: string; + 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; + 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; + 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; + overrideClickThroughUrl?: boolean | null; } /** * Ad List Response @@ -738,11 +738,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Ad Slot @@ -751,35 +751,35 @@ export namespace dfareporting_v3_2 { /** * Comment for this ad slot. */ - comment?: string; + 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; + compatibility?: string | null; /** * Height of this ad slot. */ - height?: string; + height?: string | null; /** * ID of the placement from an external platform that is linked to this ad slot. */ - linkedPlacementId?: string; + linkedPlacementId?: string | null; /** * Name of this ad slot. */ - name?: string; + name?: string | null; /** * Payment source type of this ad slot. */ - paymentSourceType?: string; + paymentSourceType?: string | null; /** * Primary ad slot of a roadblock inventory item. */ - primary?: boolean; + primary?: boolean | null; /** * Width of this ad slot. */ - width?: string; + width?: string | null; } /** * Contains properties of a Campaign Manager advertiser. @@ -788,27 +788,27 @@ export namespace dfareporting_v3_2 { /** * Account ID of this advertiser.This is a read-only field that can be left blank. */ - accountId?: string; + 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; + 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; + 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; + defaultClickThroughEventTagId?: string | null; /** * Default email address used in sender field for tag emails. */ - defaultEmail?: string; + 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; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -816,7 +816,7 @@ export namespace dfareporting_v3_2 { /** * ID of this advertiser. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. */ @@ -824,27 +824,27 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". */ - kind?: string; + 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; + 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; + originalFloodlightConfigurationId?: string | null; /** * Status of this advertiser. */ - status?: string; + status?: string | null; /** * Subaccount ID of this advertiser.This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Suspension status of this advertiser. */ - suspended?: boolean; + suspended?: boolean | null; } /** * Groups advertisers together so that reports can be generated for the entire group at once. @@ -853,19 +853,19 @@ export namespace dfareporting_v3_2 { /** * Account ID of this advertiser group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this advertiser group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". */ - kind?: string; + 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; + name?: string | null; } /** * Advertiser Group List Response @@ -878,11 +878,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Landing Page List Response @@ -891,7 +891,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". */ - kind?: string; + kind?: string | null; /** * Landing page collection */ @@ -899,7 +899,7 @@ export namespace dfareporting_v3_2 { /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Advertiser List Response @@ -912,11 +912,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Audience Segment. @@ -925,15 +925,15 @@ export namespace dfareporting_v3_2 { /** * 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; + allocation?: number | null; /** * ID of this audience segment. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this audience segment. This is a required field and must be less than 65 characters long. */ - name?: string; + name?: string | null; } /** * Audience Segment Group. @@ -946,11 +946,11 @@ export namespace dfareporting_v3_2 { /** * ID of this audience segment group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this audience segment group. This is a required field and must be less than 65 characters long. */ - name?: string; + name?: string | null; } /** * Contains information about a browser that can be targeted by ads. @@ -959,27 +959,27 @@ export namespace dfareporting_v3_2 { /** * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. */ - browserVersionId?: string; + browserVersionId?: string | null; /** * DART ID of this browser. This is the ID used when generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". */ - kind?: string; + 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; + 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; + minorVersion?: string | null; /** * Name of this browser. */ - name?: string; + name?: string | null; } /** * Browser List Response @@ -992,7 +992,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains properties of a Campaign Manager campaign. @@ -1001,7 +1001,7 @@ export namespace dfareporting_v3_2 { /** * Account ID of this campaign. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Ad blocking settings for this campaign. */ @@ -1013,11 +1013,11 @@ export namespace dfareporting_v3_2 { /** * Advertiser group ID of the associated advertiser. */ - advertiserGroupId?: string; + advertiserGroupId?: string | null; /** * Advertiser ID of this campaign. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. */ @@ -1025,7 +1025,7 @@ export namespace dfareporting_v3_2 { /** * Whether this campaign has been archived. */ - archived?: boolean; + archived?: boolean | null; /** * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. */ @@ -1033,7 +1033,7 @@ export namespace dfareporting_v3_2 { /** * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. */ - billingInvoiceCode?: string; + billingInvoiceCode?: string | null; /** * Click-through URL suffix override properties for this campaign. */ @@ -1041,7 +1041,7 @@ export namespace dfareporting_v3_2 { /** * Arbitrary comments about this campaign. Must be less than 256 characters long. */ - comment?: string; + comment?: string | null; /** * Information about the creation of this campaign. This is a read-only field. */ @@ -1049,7 +1049,7 @@ export namespace dfareporting_v3_2 { /** * List of creative group IDs that are assigned to the campaign. */ - creativeGroupIds?: string[]; + creativeGroupIds?: string[] | null; /** * Creative optimization configuration for the campaign. */ @@ -1061,11 +1061,11 @@ export namespace dfareporting_v3_2 { /** * The default landing page ID for this campaign. */ - defaultLandingPageId?: string; + 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; + endDate?: string | null; /** * Overrides that can be used to activate or deactivate advertiser event tags. */ @@ -1073,11 +1073,11 @@ export namespace dfareporting_v3_2 { /** * External ID for this campaign. */ - externalId?: string; + externalId?: string | null; /** * ID of this campaign. This is a read-only auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. */ @@ -1085,7 +1085,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this campaign. This is a read-only field. */ @@ -1097,23 +1097,23 @@ export namespace dfareporting_v3_2 { /** * 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; + name?: string | null; /** * Whether Nielsen reports are enabled for this campaign. */ - nielsenOcrEnabled?: boolean; + 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; + startDate?: string | null; /** * Subaccount ID of this campaign. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Campaign trafficker contact emails. */ - traffickerEmails?: string[]; + traffickerEmails?: string[] | null; } /** * Identifies a creative which has been associated with a given campaign. @@ -1122,11 +1122,11 @@ export namespace dfareporting_v3_2 { /** * ID of the creative associated with the campaign. This is a required field. */ - creativeId?: string; + creativeId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". */ - kind?: string; + kind?: string | null; } /** * Campaign Creative Association List Response @@ -1139,11 +1139,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Campaign List Response @@ -1156,11 +1156,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Describes a change that a user has made to a resource. @@ -1169,59 +1169,59 @@ export namespace dfareporting_v3_2 { /** * Account ID of the modified object. */ - accountId?: string; + accountId?: string | null; /** * Action which caused the change. */ - action?: string; + action?: string | null; /** * Time when the object was modified. */ - changeTime?: string; + changeTime?: string | null; /** * Field name of the object which changed. */ - fieldName?: string; + fieldName?: string | null; /** * ID of this change log. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". */ - kind?: string; + kind?: string | null; /** * New value of the object field. */ - newValue?: string; + newValue?: string | null; /** * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. */ - objectId?: string; + objectId?: string | null; /** * Object type of the change log. */ - objectType?: string; + objectType?: string | null; /** * Old value of the object field. */ - oldValue?: string; + oldValue?: string | null; /** * Subaccount ID of the modified object. */ - subaccountId?: string; + 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; + transactionId?: string | null; /** * ID of the user who modified the object. */ - userProfileId?: string; + userProfileId?: string | null; /** * User profile name of the user who modified the object. */ - userProfileName?: string; + userProfileName?: string | null; } /** * Change Log List Response @@ -1234,11 +1234,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * City List Response @@ -1251,7 +1251,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains information about a city that can be targeted by ads. @@ -1260,39 +1260,39 @@ export namespace dfareporting_v3_2 { /** * Country code of the country to which this city belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this city belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this city. This is the ID used for targeting and generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". */ - kind?: string; + kind?: string | null; /** * Metro region code of the metro region (DMA) to which this city belongs. */ - metroCode?: string; + metroCode?: string | null; /** * ID of the metro region (DMA) to which this city belongs. */ - metroDmaId?: string; + metroDmaId?: string | null; /** * Name of this city. */ - name?: string; + name?: string | null; /** * Region code of the region to which this city belongs. */ - regionCode?: string; + regionCode?: string | null; /** * DART ID of the region to which this city belongs. */ - regionDartId?: string; + regionDartId?: string | null; } /** * Creative Click Tag. @@ -1305,11 +1305,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + name?: string | null; } /** * Click-through URL @@ -1318,19 +1318,19 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + customClickThroughUrl?: string | null; /** * Whether the campaign default landing page is used. */ - defaultLandingPage?: boolean; + defaultLandingPage?: boolean | null; /** * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. */ - landingPageId?: string; + landingPageId?: string | null; } /** * Click Through URL Suffix settings. @@ -1339,11 +1339,11 @@ export namespace dfareporting_v3_2 { /** * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. */ - clickThroughUrlSuffix?: string; + clickThroughUrlSuffix?: string | null; /** * Whether this entity should override the inherited click-through URL suffix with its own defined value. */ - overrideInheritedSuffix?: boolean; + overrideInheritedSuffix?: boolean | null; } /** * Companion Click-through override. @@ -1356,7 +1356,7 @@ export namespace dfareporting_v3_2 { /** * ID of the creative for this companion click-through override. */ - creativeId?: string; + creativeId?: string | null; } /** * Companion Settings @@ -1365,7 +1365,7 @@ export namespace dfareporting_v3_2 { /** * Whether companions are disabled for this placement. */ - companionsDisabled?: boolean; + 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. */ @@ -1373,11 +1373,11 @@ export namespace dfareporting_v3_2 { /** * Whether to serve only static images as companions. */ - imageOnly?: boolean; + imageOnly?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". */ - kind?: string; + kind?: string | null; } /** * Represents a response to the queryCompatibleFields method. @@ -1394,7 +1394,7 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#compatibleFields. */ - kind?: string; + kind?: string | null; /** * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ @@ -1415,15 +1415,15 @@ export namespace dfareporting_v3_2 { /** * ID of this connection type. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". */ - kind?: string; + kind?: string | null; /** * Name of this connection type. */ - name?: string; + name?: string | null; } /** * Connection Type List Response @@ -1436,7 +1436,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". */ - kind?: string; + kind?: string | null; } /** * Content Category List Response @@ -1449,11 +1449,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Organizes placements according to the contents of their associated webpages. @@ -1462,19 +1462,19 @@ export namespace dfareporting_v3_2 { /** * Account ID of this content category. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this content category. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". */ - kind?: string; + 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; + name?: string | null; } /** * A Conversion represents when a user successfully performs a desired action after seeing an ad. @@ -1483,7 +1483,7 @@ export namespace dfareporting_v3_2 { /** * Whether this particular request may come from a user under the age of 13, under COPPA compliance. */ - childDirectedTreatment?: boolean; + childDirectedTreatment?: boolean | null; /** * Custom floodlight variables. */ @@ -1491,59 +1491,59 @@ export namespace dfareporting_v3_2 { /** * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. */ - encryptedUserId?: string; + encryptedUserId?: string | null; /** * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. */ - encryptedUserIdCandidates?: string[]; + encryptedUserIdCandidates?: string[] | null; /** * Floodlight Activity ID of this conversion. This is a required field. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Floodlight Configuration ID of this conversion. This is a required field. */ - floodlightConfigurationId?: string; + floodlightConfigurationId?: string | null; /** * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. */ - gclid?: string; + gclid?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". */ - kind?: string; + 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; + limitAdTracking?: boolean | null; /** * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. */ - mobileDeviceId?: string; + mobileDeviceId?: string | null; /** * Whether the conversion was for a non personalized ad. */ - nonPersonalizedAd?: boolean; + 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; + ordinal?: string | null; /** * The quantity of the conversion. */ - quantity?: string; + quantity?: string | null; /** * The timestamp of conversion, in Unix epoch micros. This is a required field. */ - timestampMicros?: string; + 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; + treatmentForUnderage?: boolean | null; /** * The value of the conversion. */ - value?: number; + value?: number | null; } /** * The error code and description for a conversion that failed to insert or update. @@ -1552,15 +1552,15 @@ export namespace dfareporting_v3_2 { /** * The error code. */ - code?: string; + code?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". */ - kind?: string; + kind?: string | null; /** * A description of the error. */ - message?: string; + message?: string | null; } /** * Insert Conversions Request. @@ -1577,7 +1577,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". */ - kind?: string; + kind?: string | null; } /** * Insert Conversions Response. @@ -1586,11 +1586,11 @@ export namespace dfareporting_v3_2 { /** * Indicates that some or all conversions failed to insert. */ - hasFailures?: boolean; + hasFailures?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". */ - kind?: string; + kind?: string | null; /** * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. */ @@ -1611,7 +1611,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". */ - kind?: string; + kind?: string | null; } /** * Update Conversions Response. @@ -1620,11 +1620,11 @@ export namespace dfareporting_v3_2 { /** * Indicates that some or all conversions failed to update. */ - hasFailures?: boolean; + hasFailures?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". */ - kind?: string; + kind?: string | null; /** * The update status of each conversion. Statuses are returned in the same order that conversions are updated. */ @@ -1645,7 +1645,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". */ - kind?: string; + kind?: string | null; } /** * Country List Response @@ -1658,7 +1658,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains information about a country that can be targeted by ads. @@ -1667,23 +1667,23 @@ export namespace dfareporting_v3_2 { /** * Country code. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of this country. This is the ID used for targeting and generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". */ - kind?: string; + kind?: string | null; /** * Name of this country. */ - name?: string; + name?: string | null; /** * Whether ad serving supports secure servers in this country. */ - sslEnabled?: boolean; + sslEnabled?: boolean | null; } /** * Contains properties of a Creative. @@ -1692,11 +1692,11 @@ export namespace dfareporting_v3_2 { /** * 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; + accountId?: string | null; /** * Whether the creative is active. Applicable to all creative types. */ - active?: boolean; + 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. */ @@ -1704,43 +1704,43 @@ export namespace dfareporting_v3_2 { /** * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. */ - adParameters?: string; + 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[]; + adTagKeys?: string[] | null; /** * Advertiser ID of this creative. This is a required field. Applicable to all creative types. */ - advertiserId?: string; + 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; + allowScriptAccess?: boolean | null; /** * Whether the creative is archived. Applicable to all creative types. */ - archived?: boolean; + 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; + 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; + 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; + authoringTool?: string | null; /** * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. */ - autoAdvanceImages?: boolean; + 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; + backgroundColor?: string | null; /** * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. */ @@ -1748,11 +1748,11 @@ export namespace dfareporting_v3_2 { /** * 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[]; + 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; + 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. */ @@ -1764,19 +1764,19 @@ export namespace dfareporting_v3_2 { /** * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. */ - commercialId?: string; + 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[]; + 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[]; + 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; + 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. */ @@ -1796,11 +1796,11 @@ export namespace dfareporting_v3_2 { /** * 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[]; + 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; + 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. */ @@ -1812,15 +1812,15 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + htmlCodeLocked?: boolean | null; /** * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. */ @@ -1828,7 +1828,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". */ - kind?: string; + kind?: string | null; /** * Creative last modification information. This is a read-only field. Applicable to all creative types. */ @@ -1836,27 +1836,27 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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; + 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; + name?: string | null; /** * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. */ - overrideCss?: string; + overrideCss?: string | null; /** * The asset ID of the polite load image asset. Applicable to the creative type: DISPLAY. */ - politeLoadAssetId?: string; + politeLoadAssetId?: string | null; /** * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. */ @@ -1864,11 +1864,11 @@ export namespace dfareporting_v3_2 { /** * 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; + redirectUrl?: string | null; /** * ID of current rendering version. This is a read-only field. Applicable to all creative types. */ - renderingId?: string; + renderingId?: string | null; /** * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. */ @@ -1876,11 +1876,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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. */ @@ -1892,39 +1892,39 @@ export namespace dfareporting_v3_2 { /** * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. */ - skippable?: boolean; + skippable?: boolean | null; /** * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. */ - sslCompliant?: boolean; + 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; + 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; + 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; + 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; + 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; + subaccountId?: string | null; /** * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. */ - thirdPartyBackupImageImpressionsUrl?: string; + thirdPartyBackupImageImpressionsUrl?: string | null; /** * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. */ - thirdPartyRichMediaImpressionsUrl?: string; + 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. */ @@ -1936,11 +1936,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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. */ @@ -1948,7 +1948,7 @@ export namespace dfareporting_v3_2 { /** * 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; + version?: number | null; } /** * Creative Asset. @@ -1957,11 +1957,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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. */ @@ -1969,11 +1969,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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. */ @@ -1985,11 +1985,11 @@ export namespace dfareporting_v3_2 { /** * 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; + bitRate?: number | null; /** * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. */ - childAssetType?: string; + 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. */ @@ -1997,27 +1997,27 @@ export namespace dfareporting_v3_2 { /** * 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[]; + 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; + 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[]; + 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; + 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; + duration?: number | null; /** * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. */ - durationType?: string; + 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. */ @@ -2025,27 +2025,27 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + flashVersion?: number | null; /** * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ - hideFlashObjects?: boolean; + hideFlashObjects?: boolean | null; /** * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ - hideSelectionBoxes?: boolean; + 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; + 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; + id?: string | null; /** * Dimension value for the ID of the asset. This is a read-only, auto-generated field. */ @@ -2053,11 +2053,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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. */ @@ -2065,11 +2065,11 @@ export namespace dfareporting_v3_2 { /** * Orientation of video asset. This is a read-only, auto-generated field. */ - orientation?: string; + 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; + originalBackup?: boolean | null; /** * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. */ @@ -2077,27 +2077,27 @@ export namespace dfareporting_v3_2 { /** * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ - positionLeftUnit?: string; + 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; + 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; + 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; + 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; + 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; + 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. */ @@ -2105,39 +2105,39 @@ export namespace dfareporting_v3_2 { /** * 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; + sslCompliant?: boolean | null; /** * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. */ - startTimeType?: string; + 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; + 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; + 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; + 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; + 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; + zIndex?: number | null; /** * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ - zipFilename?: string; + zipFilename?: string | null; /** * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ - zipFilesize?: string; + zipFilesize?: string | null; } /** * Creative Asset ID. @@ -2146,11 +2146,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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. @@ -2167,11 +2167,11 @@ export namespace dfareporting_v3_2 { /** * 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[]; + detectedFeatures?: string[] | null; /** * Numeric ID of the asset. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. */ @@ -2179,11 +2179,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". */ - kind?: string; + 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[]; + 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. @@ -2192,7 +2192,7 @@ export namespace dfareporting_v3_2 { /** * 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; + 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. */ @@ -2205,11 +2205,11 @@ export namespace dfareporting_v3_2 { /** * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. */ - active?: boolean; + 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; + applyEventTags?: boolean | null; /** * Click-through URL of the creative assignment. */ @@ -2225,7 +2225,7 @@ export namespace dfareporting_v3_2 { /** * ID of the creative to be assigned. This is a required field. */ - creativeId?: string; + creativeId?: string | null; /** * Dimension value for the ID of the creative. This is a read-only, auto-generated field. */ @@ -2233,7 +2233,7 @@ export namespace dfareporting_v3_2 { /** * Date and time that the assigned creative should stop serving. Must be later than the start time. */ - endTime?: string; + 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 */ @@ -2241,19 +2241,19 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + sslCompliant?: boolean | null; /** * Date and time that the assigned creative should start serving. */ - startTime?: string; + 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; + weight?: number | null; } /** * Click-through URL @@ -2262,15 +2262,15 @@ export namespace dfareporting_v3_2 { /** * 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; + computedClickThroughUrl?: string | null; /** * Custom click-through URL. Applicable if the landingPageId field is left unset. */ - customClickThroughUrl?: string; + customClickThroughUrl?: string | null; /** * ID of the landing page for the click-through URL. */ - landingPageId?: string; + landingPageId?: string | null; } /** * Creative Custom Event. @@ -2279,23 +2279,23 @@ export namespace dfareporting_v3_2 { /** * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. */ - advertiserCustomEventId?: string; + advertiserCustomEventId?: string | null; /** * User-entered name for the event. */ - advertiserCustomEventName?: string; + advertiserCustomEventName?: string | null; /** * Type of the event. This is a read-only field. */ - advertiserCustomEventType?: string; + 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; + artworkLabel?: string | null; /** * Artwork type used by the creative.This is a read-only field. */ - artworkType?: string; + artworkType?: string | null; /** * Exit click-through URL for the event. This field is used only for exit events. */ @@ -2303,7 +2303,7 @@ export namespace dfareporting_v3_2 { /** * ID of this event. This is a required field and should not be modified after insertion. */ - id?: string; + id?: string | null; /** * Properties for rich media popup windows. This field is used only for exit events. */ @@ -2311,11 +2311,11 @@ export namespace dfareporting_v3_2 { /** * Target type used by the event. */ - targetType?: string; + targetType?: string | null; /** * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. */ - videoReportingId?: string; + videoReportingId?: string | null; } /** * Contains properties of a creative field. @@ -2324,11 +2324,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this creative field. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this creative field. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -2336,19 +2336,19 @@ export namespace dfareporting_v3_2 { /** * ID of this creative field. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this creative field. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Creative Field Assignment. @@ -2357,11 +2357,11 @@ export namespace dfareporting_v3_2 { /** * ID of the creative field. */ - creativeFieldId?: string; + creativeFieldId?: string | null; /** * ID of the creative field value. */ - creativeFieldValueId?: string; + creativeFieldValueId?: string | null; } /** * Creative Field List Response @@ -2374,11 +2374,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a creative field value. @@ -2387,15 +2387,15 @@ export namespace dfareporting_v3_2 { /** * ID of this creative field value. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". */ - kind?: string; + 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; + value?: string | null; } /** * Creative Field Value List Response @@ -2408,11 +2408,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a creative group. @@ -2421,11 +2421,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this creative group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this creative group. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -2433,23 +2433,23 @@ export namespace dfareporting_v3_2 { /** * 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; + groupNumber?: number | null; /** * ID of this creative group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this creative group. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Creative Group Assignment. @@ -2458,11 +2458,11 @@ export namespace dfareporting_v3_2 { /** * ID of the creative group to be assigned. */ - creativeGroupId?: string; + creativeGroupId?: string | null; /** * Creative group number of the creative group assignment. */ - creativeGroupNumber?: string; + creativeGroupNumber?: string | null; } /** * Creative Group List Response @@ -2475,11 +2475,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Creative optimization settings. @@ -2488,11 +2488,11 @@ export namespace dfareporting_v3_2 { /** * 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; + id?: string | null; /** * Name of this creative optimization config. This is a required field and must be less than 129 characters long. */ - name?: string; + name?: string | null; /** * List of optimization activities associated with this configuration. */ @@ -2500,7 +2500,7 @@ export namespace dfareporting_v3_2 { /** * Optimization model for this configuration. */ - optimizationModel?: string; + optimizationModel?: string | null; } /** * Creative Rotation. @@ -2513,15 +2513,15 @@ export namespace dfareporting_v3_2 { /** * 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; + creativeOptimizationConfigurationId?: string | null; /** * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. */ - type?: string; + type?: string | null; /** * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */ - weightCalculationStrategy?: string; + weightCalculationStrategy?: string | null; } /** * Creative Settings @@ -2530,11 +2530,11 @@ export namespace dfareporting_v3_2 { /** * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. */ - iFrameFooter?: string; + iFrameFooter?: string | null; /** * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. */ - iFrameHeader?: string; + iFrameHeader?: string | null; } /** * Creative List Response @@ -2547,11 +2547,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". @@ -2568,7 +2568,7 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -2585,15 +2585,15 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". */ - kind?: string; + 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; + type?: string | null; /** * The value of the custom floodlight variable. The length of string must not exceed 50 characters. */ - value?: string; + value?: string | null; } /** * Represents a Custom Rich Media Events group. @@ -2606,7 +2606,7 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#customRichMediaEvents. */ - kind?: string; + kind?: string | null; } /** * Represents a date range. @@ -2615,19 +2615,19 @@ export namespace dfareporting_v3_2 { /** * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ - endDate?: string; + endDate?: string | null; /** * The kind of resource this is, in this case dfareporting#dateRange. */ - kind?: string; + kind?: string | null; /** * The date range relative to the date of when the report is run. */ - relativeDateRange?: string; + relativeDateRange?: string | null; /** * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ - startDate?: string; + startDate?: string | null; } /** * Day Part Targeting. @@ -2636,15 +2636,15 @@ export namespace dfareporting_v3_2 { /** * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" */ - daysOfWeek?: string[]; + 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[]; + hoursOfDay?: number[] | null; /** * Whether or not to use the user's local time. If false, the America/New York time zone applies. */ - userLocalTime?: boolean; + userLocalTime?: boolean | null; } /** * Contains information about a landing page deep link. @@ -2653,15 +2653,15 @@ export namespace dfareporting_v3_2 { /** * The URL of the mobile app being linked to. */ - appUrl?: string; + appUrl?: string | null; /** * The fallback URL. This URL will be served to users who do not have the mobile app installed. */ - fallbackUrl?: string; + fallbackUrl?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". */ - kind?: string; + kind?: string | null; /** * The mobile app targeted by this deep link. */ @@ -2669,7 +2669,7 @@ export namespace dfareporting_v3_2 { /** * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. */ - remarketingListIds?: string[]; + 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. @@ -2678,11 +2678,11 @@ export namespace dfareporting_v3_2 { /** * ID of the click-through event tag to apply to all ads in this entity's scope. */ - defaultClickThroughEventTagId?: string; + defaultClickThroughEventTagId?: string | null; /** * Whether this entity should override the inherited default click-through event tag with its own defined value. */ - overrideInheritedEventTag?: boolean; + overrideInheritedEventTag?: boolean | null; } /** * Delivery Schedule. @@ -2695,15 +2695,15 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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; + priority?: string | null; } /** * Google Ad Manager Settings @@ -2712,23 +2712,23 @@ export namespace dfareporting_v3_2 { /** * Ad Manager network code for this directory site. */ - dfpNetworkCode?: string; + dfpNetworkCode?: string | null; /** * Ad Manager network name for this directory site. */ - dfpNetworkName?: string; + dfpNetworkName?: string | null; /** * Whether this directory site accepts programmatic placements. */ - programmaticPlacementAccepted?: boolean; + programmaticPlacementAccepted?: boolean | null; /** * Whether this directory site is available only via Publisher Portal. */ - publisherPortalOnly?: boolean; + publisherPortalOnly?: boolean | null; /** * Whether this directory site accepts publisher-paid tags. */ - pubPaidPlacementAccepted?: boolean; + pubPaidPlacementAccepted?: boolean | null; } /** * Represents a dimension. @@ -2737,11 +2737,11 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#dimension. */ - kind?: string; + kind?: string | null; /** * The dimension name, e.g. dfa:advertiser */ - name?: string; + name?: string | null; } /** * Represents a dimension filter. @@ -2750,15 +2750,15 @@ export namespace dfareporting_v3_2 { /** * The name of the dimension to filter. */ - dimensionName?: string; + dimensionName?: string | null; /** * The kind of resource this is, in this case dfareporting#dimensionFilter. */ - kind?: string; + kind?: string | null; /** * The value of the dimension to filter. */ - value?: string; + value?: string | null; } /** * Represents a DimensionValue resource. @@ -2767,27 +2767,27 @@ export namespace dfareporting_v3_2 { /** * The name of the dimension. */ - dimensionName?: string; + dimensionName?: string | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID associated with the value if available. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#dimensionValue. */ - kind?: string; + 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; + matchType?: string | null; /** * The value of the dimension. */ - value?: string; + value?: string | null; } /** * Represents the list of DimensionValue resources. @@ -2796,7 +2796,7 @@ export namespace dfareporting_v3_2 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The dimension values returned in this response. */ @@ -2804,11 +2804,11 @@ export namespace dfareporting_v3_2 { /** * The kind of list this is, in this case dfareporting#dimensionValueList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Represents a DimensionValuesRequest. @@ -2817,11 +2817,11 @@ export namespace dfareporting_v3_2 { /** * The name of the dimension for which values should be requested. */ - dimensionName?: string; + 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; + endDate?: string | null; /** * The list of filters by which to filter values. The filters are ANDed. */ @@ -2829,11 +2829,11 @@ export namespace dfareporting_v3_2 { /** * The kind of request this is, in this case dfareporting#dimensionValueRequest. */ - kind?: string; + 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; + 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. @@ -2842,7 +2842,7 @@ export namespace dfareporting_v3_2 { /** * Whether this directory site is active. */ - active?: boolean; + active?: boolean | null; /** * Directory site contacts. */ @@ -2850,19 +2850,19 @@ export namespace dfareporting_v3_2 { /** * Country ID of this directory site. This is a read-only field. */ - countryId?: string; + countryId?: string | null; /** * Currency ID of this directory site. This is a read-only field. Possible values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ - currencyId?: string; + currencyId?: string | null; /** * Description of this directory site. This is a read-only field. */ - description?: string; + description?: string | null; /** * ID of this directory site. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. */ @@ -2870,23 +2870,23 @@ export namespace dfareporting_v3_2 { /** * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" */ - inpageTagFormats?: string[]; + inpageTagFormats?: string[] | null; /** * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" */ - interstitialTagFormats?: string[]; + interstitialTagFormats?: string[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". */ - kind?: string; + kind?: string | null; /** * Name of this directory site. */ - name?: string; + name?: string | null; /** * Parent directory site ID. */ - parentId?: string; + parentId?: string | null; /** * Directory site settings. */ @@ -2894,7 +2894,7 @@ export namespace dfareporting_v3_2 { /** * URL of this directory site. */ - url?: string; + url?: string | null; } /** * Contains properties of a Site Directory contact. @@ -2903,43 +2903,43 @@ export namespace dfareporting_v3_2 { /** * Address of this directory site contact. */ - address?: string; + address?: string | null; /** * Email address of this directory site contact. */ - email?: string; + email?: string | null; /** * First name of this directory site contact. */ - firstName?: string; + firstName?: string | null; /** * ID of this directory site contact. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact". */ - kind?: string; + kind?: string | null; /** * Last name of this directory site contact. */ - lastName?: string; + lastName?: string | null; /** * Phone number of this directory site contact. */ - phone?: string; + phone?: string | null; /** * Directory site contact role. */ - role?: string; + role?: string | null; /** * Title or designation of this directory site contact. */ - title?: string; + title?: string | null; /** * Directory site contact type. */ - type?: string; + type?: string | null; } /** * Directory Site Contact Assignment @@ -2948,11 +2948,11 @@ export namespace dfareporting_v3_2 { /** * ID of this directory site contact. This is a read-only, auto-generated field. */ - contactId?: string; + contactId?: string | null; /** * Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site. */ - visibility?: string; + visibility?: string | null; } /** * Directory Site Contact List Response @@ -2965,11 +2965,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Directory Site Settings @@ -2978,7 +2978,7 @@ export namespace dfareporting_v3_2 { /** * Whether this directory site has disabled active view creatives. */ - activeViewOptOut?: boolean; + activeViewOptOut?: boolean | null; /** * Directory site Ad Manager settings. */ @@ -2986,23 +2986,23 @@ export namespace dfareporting_v3_2 { /** * Whether this site accepts in-stream video ads. */ - instreamVideoPlacementAccepted?: boolean; + instreamVideoPlacementAccepted?: boolean | null; /** * Whether this site accepts interstitial ads. */ - interstitialPlacementAccepted?: boolean; + interstitialPlacementAccepted?: boolean | null; /** * Whether this directory site has disabled Nielsen OCR reach ratings. */ - nielsenOcrOptOut?: boolean; + nielsenOcrOptOut?: boolean | null; /** * Whether this directory site has disabled generation of Verification ins tags. */ - verificationTagOptOut?: boolean; + verificationTagOptOut?: boolean | null; /** * Whether this directory site has disabled active view for in-stream video creatives. This is a read-only field. */ - videoActiveViewOptOut?: boolean; + videoActiveViewOptOut?: boolean | null; } /** * Directory Site List Response @@ -3015,11 +3015,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + 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. @@ -3028,19 +3028,19 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". */ - kind?: string; + 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; + name?: string | null; /** * ID of the object of this dynamic targeting key. This is a required field. */ - objectId?: string; + objectId?: string | null; /** * Type of the object of this dynamic targeting key. This is a required field. */ - objectType?: string; + objectType?: string | null; } /** * Dynamic Targeting Key List Response @@ -3053,7 +3053,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". */ - kind?: string; + kind?: string | null; } /** * A description of how user IDs are encrypted. @@ -3062,19 +3062,19 @@ export namespace dfareporting_v3_2 { /** * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. */ - encryptionEntityId?: string; + encryptionEntityId?: string | null; /** * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. */ - encryptionEntityType?: string; + encryptionEntityType?: string | null; /** * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. */ - encryptionSource?: string; + encryptionSource?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */ - kind?: string; + kind?: string | null; } /** * Contains properties of an event tag. @@ -3083,11 +3083,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this event tag. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3095,7 +3095,7 @@ export namespace dfareporting_v3_2 { /** * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -3103,55 +3103,55 @@ export namespace dfareporting_v3_2 { /** * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. */ - enabledByDefault?: boolean; + 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; + excludeFromAdxRequests?: boolean | null; /** * ID of this event tag. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". */ - kind?: string; + kind?: string | null; /** * Name of this event tag. This is a required field and must be less than 256 characters long. */ - name?: string; + 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; + 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[]; + siteIds?: string[] | null; /** * Whether this tag is SSL-compliant or not. This is a read-only field. */ - sslCompliant?: boolean; + sslCompliant?: boolean | null; /** * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. */ - status?: string; + status?: string | null; /** * Subaccount ID of this event tag. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + 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; + 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; + urlEscapeLevels?: number | null; } /** * Event tag override information. @@ -3160,11 +3160,11 @@ export namespace dfareporting_v3_2 { /** * Whether this override is enabled. */ - enabled?: boolean; + enabled?: boolean | null; /** * ID of this event tag override. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; } /** * Event Tag List Response @@ -3177,7 +3177,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". */ - kind?: string; + 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". @@ -3190,39 +3190,39 @@ export namespace dfareporting_v3_2 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The filename of the file. */ - fileName?: string; + fileName?: string | null; /** * The output format of the report. Only available once the file is available. */ - format?: string; + format?: string | null; /** * The unique ID of this report file. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#file. */ - kind?: string; + kind?: string | null; /** * The timestamp in milliseconds since epoch when this file was last modified. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * The ID of the report this file was generated from. */ - reportId?: string; + reportId?: string | null; /** * The status of the report file. */ - status?: string; + status?: string | null; /** * The URLs where the completed report file can be downloaded. */ - urls?: {apiUrl?: string; browserUrl?: string}; + urls?: {apiUrl?: string; browserUrl?: string} | null; } /** * Represents the list of File resources. @@ -3231,7 +3231,7 @@ export namespace dfareporting_v3_2 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The files returned in this response. */ @@ -3239,11 +3239,11 @@ export namespace dfareporting_v3_2 { /** * The kind of list this is, in this case dfareporting#fileList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Flight @@ -3252,19 +3252,19 @@ export namespace dfareporting_v3_2 { /** * Inventory item flight end date. */ - endDate?: string; + endDate?: string | null; /** * Rate or cost of this flight. */ - rateOrCost?: string; + rateOrCost?: string | null; /** * Inventory item flight start date. */ - startDate?: string; + startDate?: string | null; /** * Units of this flight. */ - units?: string; + units?: string | null; } /** * Floodlight Activity GenerateTag Response @@ -3273,15 +3273,15 @@ export namespace dfareporting_v3_2 { /** * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. */ - floodlightActivityTag?: string; + 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; + globalSiteTagGlobalSnippet?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". */ - kind?: string; + kind?: string | null; } /** * Floodlight Activity List Response @@ -3294,11 +3294,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a Floodlight activity. @@ -3307,11 +3307,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this floodlight activity. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3319,11 +3319,11 @@ export namespace dfareporting_v3_2 { /** * 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; + cacheBustingType?: string | null; /** * Counting method for conversions for this floodlight activity. This is a required field. */ - countingMethod?: string; + countingMethod?: string | null; /** * Dynamic floodlight tags. */ @@ -3331,27 +3331,27 @@ export namespace dfareporting_v3_2 { /** * URL where this tag will be deployed. If specified, must be less than 256 characters long. */ - expectedUrl?: string; + expectedUrl?: string | null; /** * Floodlight activity group ID of this floodlight activity. This is a required field. */ - floodlightActivityGroupId?: string; + floodlightActivityGroupId?: string | null; /** * Name of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupName?: string; + floodlightActivityGroupName?: string | null; /** * Tag string of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupTagString?: string; + floodlightActivityGroupTagString?: string | null; /** * Type of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupType?: string; + 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; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -3359,15 +3359,15 @@ export namespace dfareporting_v3_2 { /** * The type of Floodlight tag this activity will generate. This is a required field. */ - floodlightTagType?: string; + floodlightTagType?: string | null; /** * Whether this activity is archived. */ - hidden?: boolean; + hidden?: boolean | null; /** * ID of this floodlight activity. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. */ @@ -3375,15 +3375,15 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". */ - kind?: string; + 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; + name?: string | null; /** * General notes or implementation instructions for the tag. */ - notes?: string; + notes?: string | null; /** * Publisher dynamic floodlight tags. */ @@ -3391,31 +3391,31 @@ export namespace dfareporting_v3_2 { /** * Whether this tag should use SSL. */ - secure?: boolean; + 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; + sslCompliant?: boolean | null; /** * Whether this floodlight activity must be SSL-compliant. */ - sslRequired?: boolean; + sslRequired?: boolean | null; /** * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. */ - tagFormat?: string; + 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; + 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[]; + userDefinedVariableTypes?: string[] | null; } /** * Dynamic Tag @@ -3424,15 +3424,15 @@ export namespace dfareporting_v3_2 { /** * ID of this dynamic tag. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this tag. */ - name?: string; + name?: string | null; /** * Tag code. */ - tag?: string; + tag?: string | null; } /** * Contains properties of a Floodlight activity group. @@ -3441,11 +3441,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this floodlight activity group. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3453,7 +3453,7 @@ export namespace dfareporting_v3_2 { /** * Floodlight configuration ID of this floodlight activity group. This is a required field. */ - floodlightConfigurationId?: string; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -3461,7 +3461,7 @@ export namespace dfareporting_v3_2 { /** * ID of this floodlight activity group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. */ @@ -3469,23 +3469,23 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + tagString?: string | null; /** * Type of the floodlight activity group. This is a required field that is read-only after insertion. */ - type?: string; + type?: string | null; } /** * Floodlight Activity Group List Response @@ -3498,11 +3498,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Publisher Dynamic Tag @@ -3511,11 +3511,11 @@ export namespace dfareporting_v3_2 { /** * Whether this tag is applicable only for click-throughs. */ - clickThrough?: boolean; + 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; + directorySiteId?: string | null; /** * Dynamic floodlight tag. */ @@ -3523,7 +3523,7 @@ export namespace dfareporting_v3_2 { /** * Site ID of this dynamic tag. */ - siteId?: string; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -3531,7 +3531,7 @@ export namespace dfareporting_v3_2 { /** * Whether this tag is applicable only for view-throughs. */ - viewThrough?: boolean; + viewThrough?: boolean | null; } /** * Contains properties of a Floodlight configuration. @@ -3540,11 +3540,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this floodlight configuration. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of the parent advertiser of this floodlight configuration. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3552,19 +3552,19 @@ export namespace dfareporting_v3_2 { /** * Whether advertiser data is shared with Google Analytics. */ - analyticsDataSharingEnabled?: boolean; + analyticsDataSharingEnabled?: boolean | null; /** * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ - exposureToConversionEnabled?: boolean; + exposureToConversionEnabled?: boolean | null; /** * Day that will be counted as the first day of the week in reports. This is a required field. */ - firstDayOfWeek?: string; + firstDayOfWeek?: string | null; /** * ID of this floodlight configuration. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. */ @@ -3572,11 +3572,11 @@ export namespace dfareporting_v3_2 { /** * Whether in-app attribution tracking is enabled. */ - inAppAttributionTrackingEnabled?: boolean; + inAppAttributionTrackingEnabled?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". */ - kind?: string; + kind?: string | null; /** * Lookback window settings for this floodlight configuration. */ @@ -3584,7 +3584,7 @@ export namespace dfareporting_v3_2 { /** * Types of attribution options for natural search conversions. */ - naturalSearchConversionAttributionOption?: string; + naturalSearchConversionAttributionOption?: string | null; /** * Settings for Campaign Manager Omniture integration. */ @@ -3592,7 +3592,7 @@ export namespace dfareporting_v3_2 { /** * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Configuration settings for dynamic and image floodlight tags. */ @@ -3617,7 +3617,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". */ - kind?: string; + kind?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". @@ -3634,7 +3634,7 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -3647,11 +3647,11 @@ export namespace dfareporting_v3_2 { /** * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. */ - duration?: string; + 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; + impressions?: string | null; } /** * FsCommand. @@ -3660,23 +3660,23 @@ export namespace dfareporting_v3_2 { /** * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ - left?: number; + left?: number | null; /** * Position in the browser where the window will open. */ - positionOption?: string; + positionOption?: string | null; /** * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ - top?: number; + top?: number | null; /** * Height of the window. */ - windowHeight?: number; + windowHeight?: number | null; /** * Width of the window. */ - windowWidth?: number; + windowWidth?: number | null; } /** * Geographical Targeting. @@ -3693,7 +3693,7 @@ export namespace dfareporting_v3_2 { /** * 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; + 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. */ @@ -3714,7 +3714,7 @@ export namespace dfareporting_v3_2 { /** * Account ID of this inventory item. */ - accountId?: string; + 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. */ @@ -3722,31 +3722,31 @@ export namespace dfareporting_v3_2 { /** * Advertiser ID of this inventory item. */ - advertiserId?: string; + advertiserId?: string | null; /** * Content category ID of this inventory item. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Estimated click-through rate of this inventory item. */ - estimatedClickThroughRate?: string; + estimatedClickThroughRate?: string | null; /** * Estimated conversion rate of this inventory item. */ - estimatedConversionRate?: string; + estimatedConversionRate?: string | null; /** * ID of this inventory item. */ - id?: string; + id?: string | null; /** * Whether this inventory item is in plan. */ - inPlan?: boolean; + inPlan?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this inventory item. */ @@ -3754,19 +3754,19 @@ export namespace dfareporting_v3_2 { /** * 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; + name?: string | null; /** * Negotiation channel ID of this inventory item. */ - negotiationChannelId?: string; + negotiationChannelId?: string | null; /** * Order ID of this inventory item. */ - orderId?: string; + orderId?: string | null; /** * Placement strategy ID of this inventory item. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing of this inventory item. */ @@ -3774,23 +3774,23 @@ export namespace dfareporting_v3_2 { /** * Project ID of this inventory item. */ - projectId?: string; + projectId?: string | null; /** * RFP ID of this inventory item. */ - rfpId?: string; + rfpId?: string | null; /** * ID of the site this inventory item is associated with. */ - siteId?: string; + siteId?: string | null; /** * Subaccount ID of this inventory item. */ - subaccountId?: string; + subaccountId?: string | null; /** * Type of inventory item. */ - type?: string; + type?: string | null; } /** * Inventory item List Response @@ -3803,11 +3803,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Key Value Targeting Expression. @@ -3816,7 +3816,7 @@ export namespace dfareporting_v3_2 { /** * Keyword expression being targeted by the ad. */ - expression?: string; + expression?: string | null; } /** * Contains information about where a user's browser is taken after the user clicks an ad. @@ -3825,11 +3825,11 @@ export namespace dfareporting_v3_2 { /** * Advertiser ID of this landing page. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Whether this landing page has been archived. */ - archived?: boolean; + archived?: boolean | null; /** * Links that will direct the user to a mobile app, if installed. */ @@ -3837,19 +3837,19 @@ export namespace dfareporting_v3_2 { /** * ID of this landing page. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". */ - kind?: string; + kind?: string | null; /** * Name of this landing page. This is a required field. It must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * URL of this landing page. This is a required field. */ - url?: string; + url?: string | null; } /** * Contains information about a language that can be targeted by ads. @@ -3858,19 +3858,19 @@ export namespace dfareporting_v3_2 { /** * Language ID of this language. This is the ID used for targeting and generating reports. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". */ - kind?: string; + 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; + languageCode?: string | null; /** * Name of this language. */ - name?: string; + name?: string | null; } /** * Language List Response @@ -3879,7 +3879,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". */ - kind?: string; + kind?: string | null; /** * Language collection. */ @@ -3901,7 +3901,7 @@ export namespace dfareporting_v3_2 { /** * Timestamp of the last change in milliseconds since epoch. */ - time?: string; + time?: string | null; } /** * A group clause made up of list population terms representing constraints joined by ORs. @@ -3919,11 +3919,11 @@ export namespace dfareporting_v3_2 { /** * Floodlight activity ID associated with this rule. This field can be left blank. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. */ - floodlightActivityName?: string; + 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. */ @@ -3936,35 +3936,35 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + 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; + operator?: string | null; /** * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. */ - remarketingListId?: string; + 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; + 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; + 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; + 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; + variableName?: string | null; } /** * Remarketing List Targeting Expression. @@ -3973,7 +3973,7 @@ export namespace dfareporting_v3_2 { /** * Expression describing which lists are being targeted by the ad. */ - expression?: string; + expression?: string | null; } /** * Lookback configuration settings. @@ -3982,11 +3982,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + postImpressionActivitiesDuration?: number | null; } /** * Represents a metric. @@ -3995,11 +3995,11 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#metric. */ - kind?: string; + kind?: string | null; /** * The metric name, e.g. dfa:impressions */ - name?: string; + name?: string | null; } /** * Contains information about a metro region that can be targeted by ads. @@ -4008,31 +4008,31 @@ export namespace dfareporting_v3_2 { /** * Country code of the country to which this metro region belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this metro region belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this metro region. */ - dartId?: string; + 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; + dmaId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". */ - kind?: string; + kind?: string | null; /** * Metro code of this metro region. This is equivalent to dma_id. */ - metroCode?: string; + metroCode?: string | null; /** * Name of this metro region. */ - name?: string; + name?: string | null; } /** * Metro List Response @@ -4041,7 +4041,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". */ - kind?: string; + kind?: string | null; /** * Metro collection. */ @@ -4054,23 +4054,23 @@ export namespace dfareporting_v3_2 { /** * Mobile app directory. */ - directory?: string; + directory?: string | null; /** * ID of this mobile app. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". */ - kind?: string; + kind?: string | null; /** * Publisher name. */ - publisherName?: string; + publisherName?: string | null; /** * Title of this mobile app. */ - title?: string; + title?: string | null; } /** * Mobile app List Response @@ -4079,7 +4079,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". */ - kind?: string; + kind?: string | null; /** * Mobile apps collection. */ @@ -4087,7 +4087,7 @@ export namespace dfareporting_v3_2 { /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains information about a mobile carrier that can be targeted by ads. @@ -4096,23 +4096,23 @@ export namespace dfareporting_v3_2 { /** * Country code of the country to which this mobile carrier belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this mobile carrier belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * ID of this mobile carrier. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". */ - kind?: string; + kind?: string | null; /** * Name of this mobile carrier. */ - name?: string; + name?: string | null; } /** * Mobile Carrier List Response @@ -4121,7 +4121,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". */ - kind?: string; + kind?: string | null; /** * Mobile carrier collection. */ @@ -4134,15 +4134,15 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". */ - kind?: string; + kind?: string | null; /** * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. */ - objectIds?: string[]; + 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; + status?: string | null; } /** * Offset Position. @@ -4151,11 +4151,11 @@ export namespace dfareporting_v3_2 { /** * Offset distance from left side of an asset or a window. */ - left?: number; + left?: number | null; /** * Offset distance from top side of an asset or a window. */ - top?: number; + top?: number | null; } /** * Omniture Integration Settings. @@ -4164,11 +4164,11 @@ export namespace dfareporting_v3_2 { /** * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. */ - omnitureCostDataEnabled?: boolean; + 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; + omnitureIntegrationEnabled?: boolean | null; } /** * Contains information about an operating system that can be targeted by ads. @@ -4177,23 +4177,23 @@ export namespace dfareporting_v3_2 { /** * DART ID of this operating system. This is the ID used for targeting. */ - dartId?: string; + dartId?: string | null; /** * Whether this operating system is for desktop. */ - desktop?: boolean; + desktop?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". */ - kind?: string; + kind?: string | null; /** * Whether this operating system is for mobile. */ - mobile?: boolean; + mobile?: boolean | null; /** * Name of this operating system. */ - name?: string; + name?: string | null; } /** * Operating System List Response @@ -4202,7 +4202,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". */ - kind?: string; + kind?: string | null; /** * Operating system collection. */ @@ -4215,23 +4215,23 @@ export namespace dfareporting_v3_2 { /** * ID of this operating system version. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". */ - kind?: string; + kind?: string | null; /** * Major version (leftmost number) of this operating system version. */ - majorVersion?: string; + majorVersion?: string | null; /** * Minor version (number after the first dot) of this operating system version. */ - minorVersion?: string; + minorVersion?: string | null; /** * Name of this operating system version. */ - name?: string; + name?: string | null; /** * Operating system of this operating system version. */ @@ -4244,7 +4244,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". */ - kind?: string; + kind?: string | null; /** * Operating system version collection. */ @@ -4257,7 +4257,7 @@ export namespace dfareporting_v3_2 { /** * Floodlight activity ID of this optimization activity. This is a required field. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. */ @@ -4265,7 +4265,7 @@ export namespace dfareporting_v3_2 { /** * 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; + weight?: number | null; } /** * Describes properties of a Planning order. @@ -4274,27 +4274,27 @@ export namespace dfareporting_v3_2 { /** * Account ID of this order. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this order. */ - advertiserId?: string; + advertiserId?: string | null; /** * IDs for users that have to approve documents created for this order. */ - approverUserProfileIds?: string[]; + approverUserProfileIds?: string[] | null; /** * Buyer invoice ID associated with this order. */ - buyerInvoiceId?: string; + buyerInvoiceId?: string | null; /** * Name of the buyer organization. */ - buyerOrganizationName?: string; + buyerOrganizationName?: string | null; /** * Comments in this order. */ - comments?: string; + comments?: string | null; /** * Contacts for this order. */ @@ -4302,11 +4302,11 @@ export namespace dfareporting_v3_2 { /** * ID of this order. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this order. */ @@ -4314,43 +4314,43 @@ export namespace dfareporting_v3_2 { /** * Name of this order. */ - name?: string; + name?: string | null; /** * Notes of this order. */ - notes?: string; + notes?: string | null; /** * ID of the terms and conditions template used in this order. */ - planningTermId?: string; + planningTermId?: string | null; /** * Project ID of this order. */ - projectId?: string; + projectId?: string | null; /** * Seller order ID associated with this order. */ - sellerOrderId?: string; + sellerOrderId?: string | null; /** * Name of the seller organization. */ - sellerOrganizationName?: string; + sellerOrganizationName?: string | null; /** * Site IDs this order is associated with. */ - siteId?: string[]; + siteId?: string[] | null; /** * Free-form site names this order is associated with. */ - siteNames?: string[]; + siteNames?: string[] | null; /** * Subaccount ID of this order. */ - subaccountId?: string; + subaccountId?: string | null; /** * Terms and conditions of this order. */ - termsAndConditions?: string; + termsAndConditions?: string | null; } /** * Contact of an order. @@ -4359,23 +4359,23 @@ export namespace dfareporting_v3_2 { /** * 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; + contactInfo?: string | null; /** * Name of this contact. */ - contactName?: string; + contactName?: string | null; /** * Title of this contact. */ - contactTitle?: string; + contactTitle?: string | null; /** * Type of this contact. */ - contactType?: string; + contactType?: string | null; /** * ID of the user profile containing the signature that will be embedded into order documents. */ - signatureUserProfileId?: string; + signatureUserProfileId?: string | null; } /** * Contains properties of a Planning order document. @@ -4384,23 +4384,23 @@ export namespace dfareporting_v3_2 { /** * Account ID of this order document. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this order document. */ - advertiserId?: string; + 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; + amendedOrderDocumentId?: string | null; /** * IDs of users who have approved this order document. */ - approvedByUserProfileIds?: string[]; + approvedByUserProfileIds?: string[] | null; /** * Whether this order document is cancelled. */ - cancelled?: boolean; + cancelled?: boolean | null; /** * Information about the creation of this order document. */ @@ -4408,47 +4408,47 @@ export namespace dfareporting_v3_2 { /** * Effective date of this order document. */ - effectiveDate?: string; + effectiveDate?: string | null; /** * ID of this order document. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". */ - kind?: string; + kind?: string | null; /** * List of email addresses that received the last sent document. */ - lastSentRecipients?: string[]; + lastSentRecipients?: string[] | null; /** * Timestamp of the last email sent with this order document. */ - lastSentTime?: string; + lastSentTime?: string | null; /** * ID of the order from which this order document is created. */ - orderId?: string; + orderId?: string | null; /** * Project ID of this order document. */ - projectId?: string; + projectId?: string | null; /** * Whether this order document has been signed. */ - signed?: boolean; + signed?: boolean | null; /** * Subaccount ID of this order document. */ - subaccountId?: string; + subaccountId?: string | null; /** * Title of this order document. */ - title?: string; + title?: string | null; /** * Type of this order document */ - type?: string; + type?: string | null; } /** * Order document List Response @@ -4457,11 +4457,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Order document collection */ @@ -4474,11 +4474,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Order collection. */ @@ -4499,7 +4499,7 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -4516,11 +4516,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this placement. This field can be left blank. */ - accountId?: string; + 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; + adBlockingOptOut?: boolean | null; /** * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. */ @@ -4528,7 +4528,7 @@ export namespace dfareporting_v3_2 { /** * Advertiser ID of this placement. This field can be left blank. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -4536,11 +4536,11 @@ export namespace dfareporting_v3_2 { /** * Whether this placement is archived. */ - archived?: boolean; + archived?: boolean | null; /** * Campaign ID of this placement. This field is a required field on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -4548,15 +4548,15 @@ export namespace dfareporting_v3_2 { /** * Comments for this placement. */ - comment?: string; + 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; + compatibility?: string | null; /** * ID of the content category assigned to this placement. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Information about the creation of this placement. This is a read-only field. */ @@ -4564,7 +4564,7 @@ export namespace dfareporting_v3_2 { /** * 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; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -4572,11 +4572,11 @@ export namespace dfareporting_v3_2 { /** * External ID for this placement. */ - externalId?: string; + externalId?: string | null; /** * ID of this placement. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this placement. This is a read-only, auto-generated field. */ @@ -4584,11 +4584,11 @@ export namespace dfareporting_v3_2 { /** * Key name of this placement. This is a read-only, auto-generated field. */ - keyName?: string; + keyName?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this placement. This is a read-only field. */ @@ -4600,19 +4600,19 @@ export namespace dfareporting_v3_2 { /** * Name of this placement.This is a required field and must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. */ - paymentApproved?: boolean; + paymentApproved?: boolean | null; /** * Payment source for this placement. This is a required field that is read-only after insertion. */ - paymentSource?: string; + paymentSource?: string | null; /** * ID of this placement's group, if applicable. */ - placementGroupId?: string; + placementGroupId?: string | null; /** * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. */ @@ -4620,7 +4620,7 @@ export namespace dfareporting_v3_2 { /** * ID of the placement strategy assigned to this placement. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. */ @@ -4628,7 +4628,7 @@ export namespace dfareporting_v3_2 { /** * 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; + primary?: boolean | null; /** * Information about the last publisher update. This is a read-only field. */ @@ -4636,7 +4636,7 @@ export namespace dfareporting_v3_2 { /** * 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; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -4648,19 +4648,19 @@ export namespace dfareporting_v3_2 { /** * Whether creatives assigned to this placement must be SSL-compliant. */ - sslRequired?: boolean; + sslRequired?: boolean | null; /** * Third-party placement status. */ - status?: string; + status?: string | null; /** * Subaccount ID of this placement. This field can be left blank. */ - subaccountId?: string; + 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[]; + tagFormats?: string[] | null; /** * Tag settings for this placement. */ @@ -4668,7 +4668,7 @@ export namespace dfareporting_v3_2 { /** * 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; + videoActiveViewOptOut?: boolean | null; /** * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. */ @@ -4676,7 +4676,7 @@ export namespace dfareporting_v3_2 { /** * 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; + vpaidAdapterChoice?: string | null; } /** * Placement Assignment. @@ -4685,11 +4685,11 @@ export namespace dfareporting_v3_2 { /** * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. */ - active?: boolean; + active?: boolean | null; /** * ID of the placement to be assigned. This is a required field. */ - placementId?: string; + placementId?: string | null; /** * Dimension value for the ID of the placement. This is a read-only, auto-generated field. */ @@ -4697,7 +4697,7 @@ export namespace dfareporting_v3_2 { /** * 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; + sslRequired?: boolean | null; } /** * Contains properties of a package or roadblock. @@ -4706,11 +4706,11 @@ export namespace dfareporting_v3_2 { /** * Account ID of this placement group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this placement group. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -4718,11 +4718,11 @@ export namespace dfareporting_v3_2 { /** * Whether this placement group is archived. */ - archived?: boolean; + archived?: boolean | null; /** * Campaign ID of this placement group. This field is required on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -4730,15 +4730,15 @@ export namespace dfareporting_v3_2 { /** * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. */ - childPlacementIds?: string[]; + childPlacementIds?: string[] | null; /** * Comments for this placement group. */ - comment?: string; + comment?: string | null; /** * ID of the content category assigned to this placement group. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Information about the creation of this placement group. This is a read-only field. */ @@ -4746,7 +4746,7 @@ export namespace dfareporting_v3_2 { /** * 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; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -4754,11 +4754,11 @@ export namespace dfareporting_v3_2 { /** * External ID for this placement. */ - externalId?: string; + externalId?: string | null; /** * ID of this placement group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. */ @@ -4766,7 +4766,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this placement group. This is a read-only field. */ @@ -4774,15 +4774,15 @@ export namespace dfareporting_v3_2 { /** * Name of this placement group. This is a required field and must be less than 256 characters long. */ - name?: string; + 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; + placementGroupType?: string | null; /** * ID of the placement strategy assigned to this placement group. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing schedule of this placement group. This field is required on insertion. */ @@ -4790,7 +4790,7 @@ export namespace dfareporting_v3_2 { /** * 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; + primaryPlacementId?: string | null; /** * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. */ @@ -4798,7 +4798,7 @@ export namespace dfareporting_v3_2 { /** * 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; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -4806,7 +4806,7 @@ export namespace dfareporting_v3_2 { /** * Subaccount ID of this placement group. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Placement Group List Response @@ -4815,11 +4815,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement group collection. */ @@ -4832,7 +4832,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". */ - kind?: string; + kind?: string | null; /** * Set of generated tags for the specified placements. */ @@ -4845,11 +4845,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement collection. */ @@ -4862,11 +4862,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement strategy collection. */ @@ -4879,19 +4879,19 @@ export namespace dfareporting_v3_2 { /** * Account ID of this placement strategy.This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this placement strategy. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". */ - kind?: string; + 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; + name?: string | null; } /** * Placement Tag @@ -4900,7 +4900,7 @@ export namespace dfareporting_v3_2 { /** * Placement ID */ - placementId?: string; + placementId?: string | null; /** * Tags generated for this placement. */ @@ -4913,15 +4913,15 @@ export namespace dfareporting_v3_2 { /** * ID of this platform type. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". */ - kind?: string; + kind?: string | null; /** * Name of this platform type. */ - name?: string; + name?: string | null; } /** * Platform Type List Response @@ -4930,7 +4930,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". */ - kind?: string; + kind?: string | null; /** * Platform type collection. */ @@ -4951,31 +4951,31 @@ export namespace dfareporting_v3_2 { /** * Popup window position either centered or at specific coordinate. */ - positionType?: string; + positionType?: string | null; /** * Whether to display the browser address bar. */ - showAddressBar?: boolean; + showAddressBar?: boolean | null; /** * Whether to display the browser menu bar. */ - showMenuBar?: boolean; + showMenuBar?: boolean | null; /** * Whether to display the browser scroll bar. */ - showScrollBar?: boolean; + showScrollBar?: boolean | null; /** * Whether to display the browser status bar. */ - showStatusBar?: boolean; + showStatusBar?: boolean | null; /** * Whether to display the browser tool bar. */ - showToolBar?: boolean; + showToolBar?: boolean | null; /** * Title of popup window. */ - title?: string; + title?: string | null; } /** * Contains information about a postal code that can be targeted by ads. @@ -4984,23 +4984,23 @@ export namespace dfareporting_v3_2 { /** * Postal code. This is equivalent to the id field. */ - code?: string; + code?: string | null; /** * Country code of the country to which this postal code belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this postal code belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * ID of this postal code. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". */ - kind?: string; + kind?: string | null; } /** * Postal Code List Response @@ -5009,7 +5009,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". */ - kind?: string; + kind?: string | null; /** * Postal code collection. */ @@ -5022,11 +5022,11 @@ export namespace dfareporting_v3_2 { /** * Cap cost type of this inventory item. */ - capCostType?: string; + capCostType?: string | null; /** * End date of this inventory item. */ - endDate?: string; + 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. */ @@ -5034,15 +5034,15 @@ export namespace dfareporting_v3_2 { /** * 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; + groupType?: string | null; /** * Pricing type of this inventory item. */ - pricingType?: string; + pricingType?: string | null; /** * Start date of this inventory item. */ - startDate?: string; + startDate?: string | null; } /** * Pricing Schedule @@ -5051,23 +5051,23 @@ export namespace dfareporting_v3_2 { /** * Placement cap cost option. */ - capCostOption?: string; + capCostOption?: string | null; /** * Whether cap costs are ignored by ad serving. */ - disregardOverdelivery?: boolean; + 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; + endDate?: string | null; /** * Whether this placement is flighted. If true, pricing periods will be computed automatically. */ - flighted?: boolean; + 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; + floodlightActivityId?: string | null; /** * Pricing periods for this placement. */ @@ -5075,15 +5075,15 @@ export namespace dfareporting_v3_2 { /** * Placement pricing type. This field is required on insertion. */ - pricingType?: string; + 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; + 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; + testingStartDate?: string | null; } /** * Pricing Period @@ -5092,23 +5092,23 @@ export namespace dfareporting_v3_2 { /** * 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; + endDate?: string | null; /** * Comments for this pricing period. */ - pricingComment?: string; + 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; + 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; + startDate?: string | null; /** * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. */ - units?: string; + units?: string | null; } /** * Contains properties of a Planning project. @@ -5117,43 +5117,43 @@ export namespace dfareporting_v3_2 { /** * Account ID of this project. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this project. */ - advertiserId?: string; + advertiserId?: string | null; /** * Audience age group of this project. */ - audienceAgeGroup?: string; + audienceAgeGroup?: string | null; /** * Audience gender of this project. */ - audienceGender?: string; + 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; + budget?: string | null; /** * Client billing code of this project. */ - clientBillingCode?: string; + clientBillingCode?: string | null; /** * Name of the project client. */ - clientName?: string; + clientName?: string | null; /** * End date of the project. */ - endDate?: string; + endDate?: string | null; /** * ID of this project. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this project. */ @@ -5161,47 +5161,47 @@ export namespace dfareporting_v3_2 { /** * Name of this project. */ - name?: string; + name?: string | null; /** * Overview of this project. */ - overview?: string; + overview?: string | null; /** * Start date of the project. */ - startDate?: string; + startDate?: string | null; /** * Subaccount ID of this project. */ - subaccountId?: string; + subaccountId?: string | null; /** * Number of clicks that the advertiser is targeting. */ - targetClicks?: string; + targetClicks?: string | null; /** * Number of conversions that the advertiser is targeting. */ - targetConversions?: string; + targetConversions?: string | null; /** * CPA that the advertiser is targeting. */ - targetCpaNanos?: string; + targetCpaNanos?: string | null; /** * CPC that the advertiser is targeting. */ - targetCpcNanos?: string; + targetCpcNanos?: string | null; /** * vCPM from Active View that the advertiser is targeting. */ - targetCpmActiveViewNanos?: string; + targetCpmActiveViewNanos?: string | null; /** * CPM that the advertiser is targeting. */ - targetCpmNanos?: string; + targetCpmNanos?: string | null; /** * Number of impressions that the advertiser is targeting. */ - targetImpressions?: string; + targetImpressions?: string | null; } /** * Project List Response @@ -5210,11 +5210,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Project collection. */ @@ -5235,7 +5235,7 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -5256,15 +5256,15 @@ export namespace dfareporting_v3_2 { /** * The delivery type for the recipient. */ - deliveryType?: string; + deliveryType?: string | null; /** * The email address of the recipient. */ - email?: string; + email?: string | null; /** * The kind of resource this is, in this case dfareporting#recipient. */ - kind?: string; + kind?: string | null; } /** * Contains information about a region that can be targeted by ads. @@ -5273,27 +5273,27 @@ export namespace dfareporting_v3_2 { /** * Country code of the country to which this region belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this region belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this region. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". */ - kind?: string; + kind?: string | null; /** * Name of this region. */ - name?: string; + name?: string | null; /** * Region code. */ - regionCode?: string; + regionCode?: string | null; } /** * Region List Response @@ -5302,7 +5302,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". */ - kind?: string; + kind?: string | null; /** * Region collection. */ @@ -5315,15 +5315,15 @@ export namespace dfareporting_v3_2 { /** * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ - accountId?: string; + accountId?: string | null; /** * Whether this remarketing list is active. */ - active?: boolean; + active?: boolean | null; /** * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -5331,19 +5331,19 @@ export namespace dfareporting_v3_2 { /** * Remarketing list description. */ - description?: string; + description?: string | null; /** * Remarketing list ID. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". */ - kind?: string; + 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; + lifeSpan?: string | null; /** * Rule used to populate the remarketing list with users. */ @@ -5351,19 +5351,19 @@ export namespace dfareporting_v3_2 { /** * Number of users currently in the list. This is a read-only field. */ - listSize?: string; + listSize?: string | null; /** * Product from which this remarketing list was originated. */ - listSource?: string; + listSource?: string | null; /** * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. */ - name?: string; + 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; + 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. @@ -5372,19 +5372,19 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". */ - kind?: string; + kind?: string | null; /** * Remarketing list ID. This is a read-only, auto-generated field. */ - remarketingListId?: string; + remarketingListId?: string | null; /** * Accounts that the remarketing list is shared with. */ - sharedAccountIds?: string[]; + sharedAccountIds?: string[] | null; /** * Advertisers that the remarketing list is shared with. */ - sharedAdvertiserIds?: string[]; + sharedAdvertiserIds?: string[] | null; } /** * Remarketing list response @@ -5393,11 +5393,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Remarketing list collection. */ @@ -5410,7 +5410,7 @@ export namespace dfareporting_v3_2 { /** * The account ID to which this report belongs. */ - accountId?: string; + accountId?: string | null; /** * The report criteria for a report of type "STANDARD". */ @@ -5421,7 +5421,7 @@ export namespace dfareporting_v3_2 { dimensionFilters?: Schema$DimensionValue[]; dimensions?: Schema$SortedDimension[]; metricNames?: string[]; - }; + } | null; /** * The report criteria for a report of type "CROSS_DIMENSION_REACH". */ @@ -5433,7 +5433,7 @@ export namespace dfareporting_v3_2 { metricNames?: string[]; overlapMetricNames?: string[]; pivoted?: boolean; - }; + } | null; /** * The report's email delivery settings. */ @@ -5442,15 +5442,15 @@ export namespace dfareporting_v3_2 { emailOwnerDeliveryType?: string; message?: string; recipients?: Schema$Recipient[]; - }; + } | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The filename used when generating report files for this report. */ - fileName?: string; + fileName?: string | null; /** * The report criteria for a report of type "FLOODLIGHT". */ @@ -5466,31 +5466,31 @@ export namespace dfareporting_v3_2 { 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; + format?: string | null; /** * The unique ID identifying this report resource. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#report. */ - kind?: string; + kind?: string | null; /** * The timestamp (in milliseconds since epoch) of when this report was last modified. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * The name of the report. */ - name?: string; + name?: string | null; /** * The user profile id of the owner of this report. */ - ownerProfileId?: string; + ownerProfileId?: string | null; /** * The report criteria for a report of type "PATH_TO_CONVERSION". */ @@ -5514,7 +5514,7 @@ export namespace dfareporting_v3_2 { maximumInteractionGap?: number; pivotOnInteractionPath?: boolean; }; - }; + } | null; /** * The report criteria for a report of type "REACH". */ @@ -5527,7 +5527,7 @@ export namespace dfareporting_v3_2 { 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". */ @@ -5539,15 +5539,15 @@ export namespace dfareporting_v3_2 { repeatsOnWeekDays?: string[]; runsOnDayOfMonth?: string; startDate?: string; - }; + } | null; /** * The subaccount ID to which this report belongs if applicable. */ - subAccountId?: string; + subAccountId?: string | null; /** * The type of the report. */ - type?: string; + type?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "STANDARD". @@ -5564,7 +5564,7 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#reportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -5581,7 +5581,7 @@ export namespace dfareporting_v3_2 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The reports returned in this response. */ @@ -5589,11 +5589,11 @@ export namespace dfareporting_v3_2 { /** * The kind of list this is, in this case dfareporting#reportList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Reporting Configuration @@ -5602,7 +5602,7 @@ export namespace dfareporting_v3_2 { /** * 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; + exposureToConversionEnabled?: boolean | null; /** * Default lookback windows for new advertisers in this account. */ @@ -5610,7 +5610,7 @@ export namespace dfareporting_v3_2 { /** * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" */ - reportGenerationTimeZoneId?: string; + reportGenerationTimeZoneId?: string | null; } /** * Rich Media Exit Override. @@ -5623,11 +5623,11 @@ export namespace dfareporting_v3_2 { /** * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. */ - enabled?: boolean; + enabled?: boolean | null; /** * ID for the override to refer to a specific exit in the creative. */ - exitId?: string; + exitId?: string | null; } /** * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. @@ -5636,15 +5636,15 @@ export namespace dfareporting_v3_2 { /** * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. */ - assetId?: string; + assetId?: string | null; /** * A user-friendly name for this rule. This is a required field. */ - name?: string; + 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; + targetingTemplateId?: string | null; } /** * Contains properties of a site. @@ -5653,15 +5653,15 @@ export namespace dfareporting_v3_2 { /** * Account ID of this site. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Whether this site is approved. */ - approved?: boolean; + approved?: boolean | null; /** * Directory site associated with this site. This is a required field that is read-only after insertion. */ - directorySiteId?: string; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -5669,7 +5669,7 @@ export namespace dfareporting_v3_2 { /** * ID of this site. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this site. This is a read-only, auto-generated field. */ @@ -5677,15 +5677,15 @@ export namespace dfareporting_v3_2 { /** * Key name of this site. This is a read-only, auto-generated field. */ - keyName?: string; + keyName?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". */ - kind?: string; + 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; + name?: string | null; /** * Site contacts. */ @@ -5697,7 +5697,7 @@ export namespace dfareporting_v3_2 { /** * Subaccount ID of this site. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Site Contact @@ -5706,35 +5706,35 @@ export namespace dfareporting_v3_2 { /** * Address of this site contact. */ - address?: string; + address?: string | null; /** * Site contact type. */ - contactType?: string; + contactType?: string | null; /** * Email address of this site contact. This is a required field. */ - email?: string; + email?: string | null; /** * First name of this site contact. */ - firstName?: string; + firstName?: string | null; /** * ID of this site contact. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Last name of this site contact. */ - lastName?: string; + lastName?: string | null; /** * Primary phone number of this site contact. */ - phone?: string; + phone?: string | null; /** * Title or designation of this site contact. */ - title?: string; + title?: string | null; } /** * Site Settings @@ -5743,11 +5743,11 @@ export namespace dfareporting_v3_2 { /** * Whether active view creatives are disabled for this site. */ - activeViewOptOut?: boolean; + 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; + adBlockingOptOut?: boolean | null; /** * Site-wide creative settings. */ @@ -5755,7 +5755,7 @@ export namespace dfareporting_v3_2 { /** * Whether new cookies are disabled for this site. */ - disableNewCookie?: boolean; + disableNewCookie?: boolean | null; /** * Lookback window settings for this site. */ @@ -5767,11 +5767,11 @@ export namespace dfareporting_v3_2 { /** * 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; + 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; + vpaidAdapterChoiceTemplate?: string | null; } /** * Site List Response @@ -5780,11 +5780,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Site collection. */ @@ -5797,23 +5797,23 @@ export namespace dfareporting_v3_2 { /** * Height of this size. Acceptable values are 0 to 32767, inclusive. */ - height?: number; + height?: number | null; /** * IAB standard size. This is a read-only, auto-generated field. */ - iab?: boolean; + iab?: boolean | null; /** * ID of this size. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". */ - kind?: string; + kind?: string | null; /** * Width of this size. Acceptable values are 0 to 32767, inclusive. */ - width?: number; + width?: number | null; } /** * Size List Response @@ -5822,7 +5822,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". */ - kind?: string; + kind?: string | null; /** * Size collection. */ @@ -5835,7 +5835,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". */ - kind?: string; + kind?: string | null; /** * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. */ @@ -5847,7 +5847,7 @@ export namespace dfareporting_v3_2 { /** * Whether the user can skip creatives served to this placement. */ - skippable?: boolean; + skippable?: boolean | null; } /** * Represents a sorted dimension. @@ -5856,15 +5856,15 @@ export namespace dfareporting_v3_2 { /** * The kind of resource this is, in this case dfareporting#sortedDimension. */ - kind?: string; + kind?: string | null; /** * The name of the dimension. */ - name?: string; + name?: string | null; /** * An optional sort order for the dimension column. */ - sortOrder?: string; + sortOrder?: string | null; } /** * Contains properties of a Campaign Manager subaccount. @@ -5873,23 +5873,23 @@ export namespace dfareporting_v3_2 { /** * ID of the account that contains this subaccount. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * IDs of the available user role permissions for this subaccount. */ - availablePermissionIds?: string[]; + availablePermissionIds?: string[] | null; /** * ID of this subaccount. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". */ - kind?: string; + 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; + name?: string | null; } /** * Subaccount List Response @@ -5898,11 +5898,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Subaccount collection. */ @@ -5915,23 +5915,23 @@ export namespace dfareporting_v3_2 { /** * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ - adId?: string; + adId?: string | null; /** * Tag string to record a click. */ - clickTag?: string; + clickTag?: string | null; /** * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ - creativeId?: string; + creativeId?: string | null; /** * TagData tag format of this tag. */ - format?: string; + format?: string | null; /** * Tag string for serving an ad. */ - impressionTag?: string; + impressionTag?: string | null; } /** * Tag Settings @@ -5940,19 +5940,19 @@ export namespace dfareporting_v3_2 { /** * 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; + additionalKeyValues?: string | null; /** * Whether static landing page URLs should be included in the tags. This setting applies only to placements. */ - includeClickThroughUrls?: boolean; + includeClickThroughUrls?: boolean | null; /** * Whether click-tracking string should be included in the tags. */ - includeClickTracking?: boolean; + 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; + keywordOption?: string | null; } /** * Dynamic and Image Tag Settings. @@ -5961,11 +5961,11 @@ export namespace dfareporting_v3_2 { /** * Whether dynamic floodlight tags are enabled. */ - dynamicTagEnabled?: boolean; + dynamicTagEnabled?: boolean | null; /** * Whether image tags are enabled. */ - imageTagEnabled?: boolean; + 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. @@ -5974,15 +5974,15 @@ export namespace dfareporting_v3_2 { /** * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ - accountId?: string; + accountId?: string | null; /** * Whether this targetable remarketing list is active. */ - active?: boolean; + active?: boolean | null; /** * Dimension value for the advertiser ID that owns this targetable remarketing list. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. */ @@ -5990,35 +5990,35 @@ export namespace dfareporting_v3_2 { /** * Targetable remarketing list description. */ - description?: string; + description?: string | null; /** * Targetable remarketing list ID. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". */ - kind?: string; + kind?: string | null; /** * Number of days that a user should remain in the targetable remarketing list without an impression. */ - lifeSpan?: string; + lifeSpan?: string | null; /** * Number of users currently in the list. This is a read-only field. */ - listSize?: string; + listSize?: string | null; /** * Product from which this targetable remarketing list was originated. */ - listSource?: string; + listSource?: string | null; /** * Name of the targetable remarketing list. Is no greater than 128 characters long. */ - name?: string; + 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; + subaccountId?: string | null; } /** * Targetable remarketing list response @@ -6027,11 +6027,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Targetable remarketing list collection. */ @@ -6044,11 +6044,11 @@ export namespace dfareporting_v3_2 { /** * 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; + accountId?: string | null; /** * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -6064,7 +6064,7 @@ export namespace dfareporting_v3_2 { /** * ID of this targeting template. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Key-value targeting criteria. */ @@ -6072,7 +6072,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". */ - kind?: string; + kind?: string | null; /** * Language targeting criteria. */ @@ -6084,11 +6084,11 @@ export namespace dfareporting_v3_2 { /** * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. */ - name?: string; + 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; + subaccountId?: string | null; /** * Technology platform targeting criteria. */ @@ -6101,11 +6101,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Targeting template collection. */ @@ -6118,11 +6118,11 @@ export namespace dfareporting_v3_2 { /** * User-entered value. */ - customHtml?: string; + customHtml?: string | null; /** * Type of browser window for which the backup image of the flash creative can be displayed. */ - targetWindowOption?: string; + targetWindowOption?: string | null; } /** * Technology Targeting. @@ -6160,11 +6160,11 @@ export namespace dfareporting_v3_2 { /** * Name of the third-party authentication token. */ - name?: string; + name?: string | null; /** * Value of the third-party authentication token. This is a read-only, auto-generated field. */ - value?: string; + value?: string | null; } /** * Third-party Tracking URL. @@ -6173,11 +6173,11 @@ export namespace dfareporting_v3_2 { /** * Third-party URL type for in-stream video and in-stream audio creatives. */ - thirdPartyUrlType?: string; + thirdPartyUrlType?: string | null; /** * URL for the specified third-party URL type. */ - url?: string; + url?: string | null; } /** * Transcode Settings @@ -6186,11 +6186,11 @@ export namespace dfareporting_v3_2 { /** * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. */ - enabledVideoFormats?: number[]; + enabledVideoFormats?: number[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". */ - kind?: string; + 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. @@ -6199,11 +6199,11 @@ export namespace dfareporting_v3_2 { /** * Registry used for the Ad ID value. */ - registry?: string; + 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; + value?: string | null; } /** * User Defined Variable configuration. @@ -6212,15 +6212,15 @@ export namespace dfareporting_v3_2 { /** * Data type for the variable. This is a required field. */ - dataType?: string; + 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; + reportName?: string | null; /** * Variable name in the tag. This is a required field. */ - variableType?: string; + variableType?: string | null; } /** * Represents a UserProfile resource. @@ -6229,35 +6229,35 @@ export namespace dfareporting_v3_2 { /** * The account ID to which this profile belongs. */ - accountId?: string; + accountId?: string | null; /** * The account name this profile belongs to. */ - accountName?: string; + accountName?: string | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The kind of resource this is, in this case dfareporting#userProfile. */ - kind?: string; + kind?: string | null; /** * The unique ID of the user profile. */ - profileId?: string; + profileId?: string | null; /** * The sub account ID this profile belongs to if applicable. */ - subAccountId?: string; + subAccountId?: string | null; /** * The sub account name this profile belongs to if applicable. */ - subAccountName?: string; + subAccountName?: string | null; /** * The user name. */ - userName?: string; + userName?: string | null; } /** * Represents the list of user profiles. @@ -6266,7 +6266,7 @@ export namespace dfareporting_v3_2 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The user profiles returned in this response. */ @@ -6274,7 +6274,7 @@ export namespace dfareporting_v3_2 { /** * The kind of list this is, in this case dfareporting#userProfileList. */ - kind?: string; + kind?: string | null; } /** * Contains properties of auser role, which is used to manage user access. @@ -6283,27 +6283,27 @@ export namespace dfareporting_v3_2 { /** * Account ID of this user role. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + defaultUserRole?: boolean | null; /** * ID of this user role. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". */ - kind?: string; + 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; + 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; + parentUserRoleId?: string | null; /** * List of permissions associated with this user role. */ @@ -6311,7 +6311,7 @@ export namespace dfareporting_v3_2 { /** * Subaccount ID of this user role. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Contains properties of a user role permission. @@ -6320,23 +6320,23 @@ export namespace dfareporting_v3_2 { /** * Levels of availability for a user role permission. */ - availability?: string; + availability?: string | null; /** * ID of this user role permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". */ - kind?: string; + kind?: string | null; /** * Name of this user role permission. */ - name?: string; + name?: string | null; /** * ID of the permission group that this user role permission belongs to. */ - permissionGroupId?: string; + permissionGroupId?: string | null; } /** * Represents a grouping of related user role permissions. @@ -6345,15 +6345,15 @@ export namespace dfareporting_v3_2 { /** * ID of this user role permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". */ - kind?: string; + kind?: string | null; /** * Name of this user role permission group. */ - name?: string; + name?: string | null; } /** * User Role Permission Group List Response @@ -6362,7 +6362,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * User role permission group collection. */ @@ -6375,7 +6375,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". */ - kind?: string; + kind?: string | null; /** * User role permission collection. */ @@ -6388,11 +6388,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * User role collection. */ @@ -6405,15 +6405,15 @@ export namespace dfareporting_v3_2 { /** * File type of the video format. */ - fileType?: string; + fileType?: string | null; /** * ID of the video format. */ - id?: number; + id?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". */ - kind?: string; + kind?: string | null; /** * The resolution of this video format. */ @@ -6421,7 +6421,7 @@ export namespace dfareporting_v3_2 { /** * The target bit rate of this video format. */ - targetBitRate?: number; + targetBitRate?: number | null; } /** * Video Format List Response @@ -6430,7 +6430,7 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". */ - kind?: string; + kind?: string | null; /** * Video format collection. */ @@ -6443,11 +6443,11 @@ export namespace dfareporting_v3_2 { /** * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. */ - offsetPercentage?: number; + offsetPercentage?: number | null; /** * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. */ - offsetSeconds?: number; + offsetSeconds?: number | null; } /** * Video Settings @@ -6460,11 +6460,11 @@ export namespace dfareporting_v3_2 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". */ - kind?: string; + kind?: string | null; /** * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. */ - orientation?: string; + 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. */ diff --git a/src/apis/dfareporting/v3.3.ts b/src/apis/dfareporting/v3.3.ts index 1960ec32ad8..2c2a2bcd26d 100644 --- a/src/apis/dfareporting/v3.3.ts +++ b/src/apis/dfareporting/v3.3.ts @@ -250,67 +250,67 @@ export namespace dfareporting_v3_3 { /** * Account permissions assigned to this account. */ - accountPermissionIds?: string[]; + accountPermissionIds?: string[] | null; /** * Profile for this account. This is a read-only field that can be left blank. */ - accountProfile?: string; + accountProfile?: string | null; /** * Whether this account is active. */ - active?: boolean; + active?: boolean | null; /** * Maximum number of active ads allowed for this account. */ - activeAdsLimitTier?: string; + activeAdsLimitTier?: string | null; /** * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. */ - activeViewOptOut?: boolean; + activeViewOptOut?: boolean | null; /** * User role permissions available to the user roles of this account. */ - availablePermissionIds?: string[]; + availablePermissionIds?: string[] | null; /** * ID of the country associated with this account. */ - countryId?: string; + countryId?: string | null; /** * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ - currencyId?: string; + currencyId?: string | null; /** * Default placement dimensions for this account. */ - defaultCreativeSizeId?: string; + defaultCreativeSizeId?: string | null; /** * Description of this account. */ - description?: string; + description?: string | null; /** * ID of this account. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". */ - kind?: string; + 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; + locale?: string | null; /** * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. */ - maximumImageSize?: string; + 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; + name?: string | null; /** * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. */ - nielsenOcrEnabled?: boolean; + nielsenOcrEnabled?: boolean | null; /** * Reporting configuration of this account. */ @@ -318,11 +318,11 @@ export namespace dfareporting_v3_3 { /** * Share Path to Conversion reports with Twitter. */ - shareReportsWithTwitter?: boolean; + shareReportsWithTwitter?: boolean | null; /** * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. */ - teaserSizeLimit?: string; + teaserSizeLimit?: string | null; } /** * Gets a summary of active ads in an account. @@ -331,23 +331,23 @@ export namespace dfareporting_v3_3 { /** * ID of the account. */ - accountId?: string; + accountId?: string | null; /** * Ads that have been activated for the account */ - activeAds?: string; + activeAds?: string | null; /** * Maximum number of active ads allowed for the account. */ - activeAdsLimitTier?: string; + activeAdsLimitTier?: string | null; /** * Ads that can be activated for the account. */ - availableAds?: string; + availableAds?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". */ - kind?: string; + 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. @@ -356,27 +356,27 @@ export namespace dfareporting_v3_3 { /** * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" */ - accountProfiles?: string[]; + accountProfiles?: string[] | null; /** * ID of this account permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". */ - kind?: string; + kind?: string | null; /** * Administrative level required to enable this account permission. */ - level?: string; + level?: string | null; /** * Name of this account permission. */ - name?: string; + name?: string | null; /** * Permission group of this account permission. */ - permissionGroupId?: string; + permissionGroupId?: string | null; } /** * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. @@ -385,15 +385,15 @@ export namespace dfareporting_v3_3 { /** * ID of this account permission group. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". */ - kind?: string; + kind?: string | null; /** * Name of this account permission group. */ - name?: string; + name?: string | null; } /** * Account Permission Group List Response @@ -406,7 +406,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". */ - kind?: string; + kind?: string | null; } /** * Account Permission List Response @@ -419,7 +419,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". */ - kind?: string; + kind?: string | null; } /** * Account List Response @@ -432,11 +432,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + 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. @@ -445,11 +445,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of the user profile. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + active?: boolean | null; /** * Filter that describes which advertisers are visible to the user profile. */ @@ -461,27 +461,27 @@ export namespace dfareporting_v3_3 { /** * Comments for this user profile. */ - comments?: string; + 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; + email?: string | null; /** * ID of the user profile. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". */ - kind?: string; + 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; + 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; + name?: string | null; /** * Filter that describes which sites are visible to the user profile. */ @@ -489,15 +489,15 @@ export namespace dfareporting_v3_3 { /** * Subaccount ID of the user profile. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Trafficker type of this user profile. This is a read-only field. */ - traffickerType?: string; + traffickerType?: string | null; /** * User type of the user profile. This is a read-only field that can be left blank. */ - userAccessType?: string; + userAccessType?: string | null; /** * Filter that describes which user roles are visible to the user profile. */ @@ -505,7 +505,7 @@ export namespace dfareporting_v3_3 { /** * User role ID of the user profile. This is a required field. */ - userRoleId?: string; + userRoleId?: string | null; } /** * Account User Profile List Response @@ -518,11 +518,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Represents an activity group. @@ -535,11 +535,11 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#activities. */ - kind?: string; + kind?: string | null; /** * List of names of floodlight activity metrics. */ - metricNames?: string[]; + metricNames?: string[] | null; } /** * Contains properties of a Campaign Manager ad. @@ -548,15 +548,15 @@ export namespace dfareporting_v3_3 { /** * Account ID of this ad. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Whether this ad is active. When true, archived must be false. */ - active?: boolean; + active?: boolean | null; /** * Advertiser ID of this ad. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -564,15 +564,15 @@ export namespace dfareporting_v3_3 { /** * Whether this ad is archived. When true, active must be false. */ - archived?: boolean; + archived?: boolean | null; /** * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. */ - audienceSegmentId?: string; + audienceSegmentId?: string | null; /** * Campaign ID of this ad. This is a required field on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -588,11 +588,11 @@ export namespace dfareporting_v3_3 { /** * Comments for this ad. */ - comments?: string; + 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; + compatibility?: string | null; /** * Information about the creation of this ad. This is a read-only field. */ @@ -620,11 +620,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + endTime?: string | null; /** * Event tag overrides for this ad. */ @@ -636,7 +636,7 @@ export namespace dfareporting_v3_3 { /** * ID of this ad. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this ad. This is a read-only, auto-generated field. */ @@ -648,7 +648,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". */ - kind?: string; + 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. */ @@ -660,7 +660,7 @@ export namespace dfareporting_v3_3 { /** * Name of this ad. This is a required field and must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * Placement assignments for this ad. */ @@ -676,23 +676,23 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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; + startTime?: string | null; /** * Subaccount ID of this ad. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + 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. */ @@ -700,7 +700,7 @@ export namespace dfareporting_v3_3 { /** * 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; + type?: string | null; } /** * Campaign ad blocking settings. @@ -709,19 +709,19 @@ export namespace dfareporting_v3_3 { /** * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. */ - clickThroughUrl?: string; + 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; + 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; + 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; + overrideClickThroughUrl?: boolean | null; } /** * Ad List Response @@ -734,11 +734,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Ad Slot @@ -747,35 +747,35 @@ export namespace dfareporting_v3_3 { /** * Comment for this ad slot. */ - comment?: string; + 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; + compatibility?: string | null; /** * Height of this ad slot. */ - height?: string; + height?: string | null; /** * ID of the placement from an external platform that is linked to this ad slot. */ - linkedPlacementId?: string; + linkedPlacementId?: string | null; /** * Name of this ad slot. */ - name?: string; + name?: string | null; /** * Payment source type of this ad slot. */ - paymentSourceType?: string; + paymentSourceType?: string | null; /** * Primary ad slot of a roadblock inventory item. */ - primary?: boolean; + primary?: boolean | null; /** * Width of this ad slot. */ - width?: string; + width?: string | null; } /** * Contains properties of a Campaign Manager advertiser. @@ -784,27 +784,27 @@ export namespace dfareporting_v3_3 { /** * Account ID of this advertiser.This is a read-only field that can be left blank. */ - accountId?: string; + 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; + 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; + 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; + defaultClickThroughEventTagId?: string | null; /** * Default email address used in sender field for tag emails. */ - defaultEmail?: string; + 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; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -812,7 +812,7 @@ export namespace dfareporting_v3_3 { /** * ID of this advertiser. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. */ @@ -820,27 +820,27 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". */ - kind?: string; + 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; + 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; + originalFloodlightConfigurationId?: string | null; /** * Status of this advertiser. */ - status?: string; + status?: string | null; /** * Subaccount ID of this advertiser.This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Suspension status of this advertiser. */ - suspended?: boolean; + suspended?: boolean | null; } /** * Groups advertisers together so that reports can be generated for the entire group at once. @@ -849,19 +849,19 @@ export namespace dfareporting_v3_3 { /** * Account ID of this advertiser group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this advertiser group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". */ - kind?: string; + 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; + name?: string | null; } /** * Advertiser Group List Response @@ -874,11 +874,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Landing Page List Response @@ -887,7 +887,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". */ - kind?: string; + kind?: string | null; /** * Landing page collection */ @@ -895,7 +895,7 @@ export namespace dfareporting_v3_3 { /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Advertiser List Response @@ -908,11 +908,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Audience Segment. @@ -921,15 +921,15 @@ export namespace dfareporting_v3_3 { /** * 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; + allocation?: number | null; /** * ID of this audience segment. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this audience segment. This is a required field and must be less than 65 characters long. */ - name?: string; + name?: string | null; } /** * Audience Segment Group. @@ -942,11 +942,11 @@ export namespace dfareporting_v3_3 { /** * ID of this audience segment group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this audience segment group. This is a required field and must be less than 65 characters long. */ - name?: string; + name?: string | null; } /** * Contains information about a browser that can be targeted by ads. @@ -955,27 +955,27 @@ export namespace dfareporting_v3_3 { /** * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. */ - browserVersionId?: string; + browserVersionId?: string | null; /** * DART ID of this browser. This is the ID used when generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". */ - kind?: string; + 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; + 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; + minorVersion?: string | null; /** * Name of this browser. */ - name?: string; + name?: string | null; } /** * Browser List Response @@ -988,7 +988,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains properties of a Campaign Manager campaign. @@ -997,7 +997,7 @@ export namespace dfareporting_v3_3 { /** * Account ID of this campaign. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Ad blocking settings for this campaign. */ @@ -1009,11 +1009,11 @@ export namespace dfareporting_v3_3 { /** * Advertiser group ID of the associated advertiser. */ - advertiserGroupId?: string; + advertiserGroupId?: string | null; /** * Advertiser ID of this campaign. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. */ @@ -1021,7 +1021,7 @@ export namespace dfareporting_v3_3 { /** * Whether this campaign has been archived. */ - archived?: boolean; + archived?: boolean | null; /** * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. */ @@ -1029,7 +1029,7 @@ export namespace dfareporting_v3_3 { /** * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. */ - billingInvoiceCode?: string; + billingInvoiceCode?: string | null; /** * Click-through URL suffix override properties for this campaign. */ @@ -1037,7 +1037,7 @@ export namespace dfareporting_v3_3 { /** * Arbitrary comments about this campaign. Must be less than 256 characters long. */ - comment?: string; + comment?: string | null; /** * Information about the creation of this campaign. This is a read-only field. */ @@ -1045,7 +1045,7 @@ export namespace dfareporting_v3_3 { /** * List of creative group IDs that are assigned to the campaign. */ - creativeGroupIds?: string[]; + creativeGroupIds?: string[] | null; /** * Creative optimization configuration for the campaign. */ @@ -1057,11 +1057,11 @@ export namespace dfareporting_v3_3 { /** * The default landing page ID for this campaign. */ - defaultLandingPageId?: string; + 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; + endDate?: string | null; /** * Overrides that can be used to activate or deactivate advertiser event tags. */ @@ -1069,11 +1069,11 @@ export namespace dfareporting_v3_3 { /** * External ID for this campaign. */ - externalId?: string; + externalId?: string | null; /** * ID of this campaign. This is a read-only auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. */ @@ -1081,7 +1081,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this campaign. This is a read-only field. */ @@ -1089,23 +1089,23 @@ export namespace dfareporting_v3_3 { /** * 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; + name?: string | null; /** * Whether Nielsen reports are enabled for this campaign. */ - nielsenOcrEnabled?: boolean; + 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; + startDate?: string | null; /** * Subaccount ID of this campaign. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Campaign trafficker contact emails. */ - traffickerEmails?: string[]; + traffickerEmails?: string[] | null; } /** * Identifies a creative which has been associated with a given campaign. @@ -1114,11 +1114,11 @@ export namespace dfareporting_v3_3 { /** * ID of the creative associated with the campaign. This is a required field. */ - creativeId?: string; + creativeId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". */ - kind?: string; + kind?: string | null; } /** * Campaign Creative Association List Response @@ -1131,11 +1131,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Campaign List Response @@ -1148,11 +1148,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Describes a change that a user has made to a resource. @@ -1161,59 +1161,59 @@ export namespace dfareporting_v3_3 { /** * Account ID of the modified object. */ - accountId?: string; + accountId?: string | null; /** * Action which caused the change. */ - action?: string; + action?: string | null; /** * Time when the object was modified. */ - changeTime?: string; + changeTime?: string | null; /** * Field name of the object which changed. */ - fieldName?: string; + fieldName?: string | null; /** * ID of this change log. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". */ - kind?: string; + kind?: string | null; /** * New value of the object field. */ - newValue?: string; + newValue?: string | null; /** * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. */ - objectId?: string; + objectId?: string | null; /** * Object type of the change log. */ - objectType?: string; + objectType?: string | null; /** * Old value of the object field. */ - oldValue?: string; + oldValue?: string | null; /** * Subaccount ID of the modified object. */ - subaccountId?: string; + 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; + transactionId?: string | null; /** * ID of the user who modified the object. */ - userProfileId?: string; + userProfileId?: string | null; /** * User profile name of the user who modified the object. */ - userProfileName?: string; + userProfileName?: string | null; } /** * Change Log List Response @@ -1226,11 +1226,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * City List Response @@ -1243,7 +1243,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains information about a city that can be targeted by ads. @@ -1252,39 +1252,39 @@ export namespace dfareporting_v3_3 { /** * Country code of the country to which this city belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this city belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this city. This is the ID used for targeting and generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". */ - kind?: string; + kind?: string | null; /** * Metro region code of the metro region (DMA) to which this city belongs. */ - metroCode?: string; + metroCode?: string | null; /** * ID of the metro region (DMA) to which this city belongs. */ - metroDmaId?: string; + metroDmaId?: string | null; /** * Name of this city. */ - name?: string; + name?: string | null; /** * Region code of the region to which this city belongs. */ - regionCode?: string; + regionCode?: string | null; /** * DART ID of the region to which this city belongs. */ - regionDartId?: string; + regionDartId?: string | null; } /** * Creative Click Tag. @@ -1297,11 +1297,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + name?: string | null; } /** * Click-through URL @@ -1310,19 +1310,19 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + customClickThroughUrl?: string | null; /** * Whether the campaign default landing page is used. */ - defaultLandingPage?: boolean; + defaultLandingPage?: boolean | null; /** * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. */ - landingPageId?: string; + landingPageId?: string | null; } /** * Click Through URL Suffix settings. @@ -1331,11 +1331,11 @@ export namespace dfareporting_v3_3 { /** * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. */ - clickThroughUrlSuffix?: string; + clickThroughUrlSuffix?: string | null; /** * Whether this entity should override the inherited click-through URL suffix with its own defined value. */ - overrideInheritedSuffix?: boolean; + overrideInheritedSuffix?: boolean | null; } /** * Companion Click-through override. @@ -1348,7 +1348,7 @@ export namespace dfareporting_v3_3 { /** * ID of the creative for this companion click-through override. */ - creativeId?: string; + creativeId?: string | null; } /** * Companion Settings @@ -1357,7 +1357,7 @@ export namespace dfareporting_v3_3 { /** * Whether companions are disabled for this placement. */ - companionsDisabled?: boolean; + 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. */ @@ -1365,11 +1365,11 @@ export namespace dfareporting_v3_3 { /** * Whether to serve only static images as companions. */ - imageOnly?: boolean; + imageOnly?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". */ - kind?: string; + kind?: string | null; } /** * Represents a response to the queryCompatibleFields method. @@ -1386,7 +1386,7 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#compatibleFields. */ - kind?: string; + kind?: string | null; /** * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ @@ -1407,15 +1407,15 @@ export namespace dfareporting_v3_3 { /** * ID of this connection type. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". */ - kind?: string; + kind?: string | null; /** * Name of this connection type. */ - name?: string; + name?: string | null; } /** * Connection Type List Response @@ -1428,7 +1428,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". */ - kind?: string; + kind?: string | null; } /** * Content Category List Response @@ -1441,11 +1441,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Organizes placements according to the contents of their associated webpages. @@ -1454,19 +1454,19 @@ export namespace dfareporting_v3_3 { /** * Account ID of this content category. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this content category. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". */ - kind?: string; + 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; + name?: string | null; } /** * A Conversion represents when a user successfully performs a desired action after seeing an ad. @@ -1475,7 +1475,7 @@ export namespace dfareporting_v3_3 { /** * Whether this particular request may come from a user under the age of 13, under COPPA compliance. */ - childDirectedTreatment?: boolean; + childDirectedTreatment?: boolean | null; /** * Custom floodlight variables. */ @@ -1483,63 +1483,63 @@ export namespace dfareporting_v3_3 { /** * 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; + encryptedUserId?: string | null; /** * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId or gclid is a required field. */ - encryptedUserIdCandidates?: string[]; + encryptedUserIdCandidates?: string[] | null; /** * Floodlight Activity ID of this conversion. This is a required field. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Floodlight Configuration ID of this conversion. This is a required field. */ - floodlightConfigurationId?: string; + 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; + gclid?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". */ - kind?: string; + 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; + 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; + 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; + mobileDeviceId?: string | null; /** * Whether the conversion was for a non personalized ad. */ - nonPersonalizedAd?: boolean; + 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; + ordinal?: string | null; /** * The quantity of the conversion. */ - quantity?: string; + quantity?: string | null; /** * The timestamp of conversion, in Unix epoch micros. This is a required field. */ - timestampMicros?: string; + 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; + treatmentForUnderage?: boolean | null; /** * The value of the conversion. */ - value?: number; + value?: number | null; } /** * The error code and description for a conversion that failed to insert or update. @@ -1548,15 +1548,15 @@ export namespace dfareporting_v3_3 { /** * The error code. */ - code?: string; + code?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". */ - kind?: string; + kind?: string | null; /** * A description of the error. */ - message?: string; + message?: string | null; } /** * Insert Conversions Request. @@ -1573,7 +1573,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". */ - kind?: string; + kind?: string | null; } /** * Insert Conversions Response. @@ -1582,11 +1582,11 @@ export namespace dfareporting_v3_3 { /** * Indicates that some or all conversions failed to insert. */ - hasFailures?: boolean; + hasFailures?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". */ - kind?: string; + kind?: string | null; /** * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. */ @@ -1607,7 +1607,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". */ - kind?: string; + kind?: string | null; } /** * Update Conversions Response. @@ -1616,11 +1616,11 @@ export namespace dfareporting_v3_3 { /** * Indicates that some or all conversions failed to update. */ - hasFailures?: boolean; + hasFailures?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". */ - kind?: string; + kind?: string | null; /** * The update status of each conversion. Statuses are returned in the same order that conversions are updated. */ @@ -1641,7 +1641,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". */ - kind?: string; + kind?: string | null; } /** * Country List Response @@ -1654,7 +1654,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". */ - kind?: string; + kind?: string | null; } /** * Contains information about a country that can be targeted by ads. @@ -1663,23 +1663,23 @@ export namespace dfareporting_v3_3 { /** * Country code. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of this country. This is the ID used for targeting and generating reports. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". */ - kind?: string; + kind?: string | null; /** * Name of this country. */ - name?: string; + name?: string | null; /** * Whether ad serving supports secure servers in this country. */ - sslEnabled?: boolean; + sslEnabled?: boolean | null; } /** * Contains properties of a Creative. @@ -1688,11 +1688,11 @@ export namespace dfareporting_v3_3 { /** * 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; + accountId?: string | null; /** * Whether the creative is active. Applicable to all creative types. */ - active?: boolean; + 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. */ @@ -1700,43 +1700,43 @@ export namespace dfareporting_v3_3 { /** * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. */ - adParameters?: string; + 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[]; + adTagKeys?: string[] | null; /** * Advertiser ID of this creative. This is a required field. Applicable to all creative types. */ - advertiserId?: string; + 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; + allowScriptAccess?: boolean | null; /** * Whether the creative is archived. Applicable to all creative types. */ - archived?: boolean; + 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; + 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; + 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; + authoringTool?: string | null; /** * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. */ - autoAdvanceImages?: boolean; + 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; + backgroundColor?: string | null; /** * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. */ @@ -1744,11 +1744,11 @@ export namespace dfareporting_v3_3 { /** * 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[]; + 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; + 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. */ @@ -1760,19 +1760,19 @@ export namespace dfareporting_v3_3 { /** * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. */ - commercialId?: string; + 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[]; + 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[]; + 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; + 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. */ @@ -1792,11 +1792,11 @@ export namespace dfareporting_v3_3 { /** * 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[]; + 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; + 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. */ @@ -1808,15 +1808,15 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + htmlCodeLocked?: boolean | null; /** * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. */ @@ -1824,7 +1824,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". */ - kind?: string; + kind?: string | null; /** * Creative last modification information. This is a read-only field. Applicable to all creative types. */ @@ -1832,23 +1832,23 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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; + 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; + name?: string | null; /** * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. */ - overrideCss?: string; + overrideCss?: string | null; /** * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. */ @@ -1856,11 +1856,11 @@ export namespace dfareporting_v3_3 { /** * 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; + redirectUrl?: string | null; /** * ID of current rendering version. This is a read-only field. Applicable to all creative types. */ - renderingId?: string; + renderingId?: string | null; /** * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. */ @@ -1868,11 +1868,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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. */ @@ -1884,39 +1884,39 @@ export namespace dfareporting_v3_3 { /** * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. */ - skippable?: boolean; + skippable?: boolean | null; /** * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. */ - sslCompliant?: boolean; + 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; + 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; + 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; + 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; + 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; + subaccountId?: string | null; /** * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. */ - thirdPartyBackupImageImpressionsUrl?: string; + thirdPartyBackupImageImpressionsUrl?: string | null; /** * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. */ - thirdPartyRichMediaImpressionsUrl?: string; + 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. */ @@ -1928,11 +1928,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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. */ @@ -1940,7 +1940,7 @@ export namespace dfareporting_v3_3 { /** * 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; + version?: number | null; } /** * Creative Asset. @@ -1949,11 +1949,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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. */ @@ -1961,11 +1961,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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. */ @@ -1973,11 +1973,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + audioSampleRate?: number | null; /** * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. */ @@ -1985,11 +1985,11 @@ export namespace dfareporting_v3_3 { /** * 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; + bitRate?: number | null; /** * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. */ - childAssetType?: string; + 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. */ @@ -1997,27 +1997,27 @@ export namespace dfareporting_v3_3 { /** * 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[]; + 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; + 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[]; + 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; + 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; + duration?: number | null; /** * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. */ - durationType?: string; + 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. */ @@ -2025,31 +2025,31 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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; + frameRate?: number | null; /** * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ - hideFlashObjects?: boolean; + hideFlashObjects?: boolean | null; /** * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ - hideSelectionBoxes?: boolean; + 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; + 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; + id?: string | null; /** * Dimension value for the ID of the asset. This is a read-only, auto-generated field. */ @@ -2057,11 +2057,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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. */ @@ -2069,15 +2069,15 @@ export namespace dfareporting_v3_3 { /** * Orientation of video asset. This is a read-only, auto-generated field. */ - orientation?: string; + 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; + originalBackup?: boolean | null; /** * Whether this asset is used as a polite load asset. */ - politeLoad?: boolean; + politeLoad?: boolean | null; /** * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. */ @@ -2085,27 +2085,27 @@ export namespace dfareporting_v3_3 { /** * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ - positionLeftUnit?: string; + 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; + 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; + 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; + 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; + 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; + 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. */ @@ -2113,39 +2113,39 @@ export namespace dfareporting_v3_3 { /** * 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; + sslCompliant?: boolean | null; /** * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. */ - startTimeType?: string; + 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; + 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; + 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; + 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; + 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; + zIndex?: number | null; /** * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ - zipFilename?: string; + zipFilename?: string | null; /** * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ - zipFilesize?: string; + zipFilesize?: string | null; } /** * Creative Asset ID. @@ -2154,11 +2154,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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. @@ -2175,11 +2175,11 @@ export namespace dfareporting_v3_3 { /** * 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[]; + detectedFeatures?: string[] | null; /** * Numeric ID of the asset. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. */ @@ -2187,11 +2187,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". */ - kind?: string; + 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[]; + 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. @@ -2200,7 +2200,7 @@ export namespace dfareporting_v3_3 { /** * 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; + 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. */ @@ -2213,11 +2213,11 @@ export namespace dfareporting_v3_3 { /** * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. */ - active?: boolean; + 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; + applyEventTags?: boolean | null; /** * Click-through URL of the creative assignment. */ @@ -2233,7 +2233,7 @@ export namespace dfareporting_v3_3 { /** * ID of the creative to be assigned. This is a required field. */ - creativeId?: string; + creativeId?: string | null; /** * Dimension value for the ID of the creative. This is a read-only, auto-generated field. */ @@ -2241,7 +2241,7 @@ export namespace dfareporting_v3_3 { /** * Date and time that the assigned creative should stop serving. Must be later than the start time. */ - endTime?: string; + 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 */ @@ -2249,19 +2249,19 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + sslCompliant?: boolean | null; /** * Date and time that the assigned creative should start serving. */ - startTime?: string; + 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; + weight?: number | null; } /** * Click-through URL @@ -2270,15 +2270,15 @@ export namespace dfareporting_v3_3 { /** * 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; + computedClickThroughUrl?: string | null; /** * Custom click-through URL. Applicable if the landingPageId field is left unset. */ - customClickThroughUrl?: string; + customClickThroughUrl?: string | null; /** * ID of the landing page for the click-through URL. */ - landingPageId?: string; + landingPageId?: string | null; } /** * Creative Custom Event. @@ -2287,23 +2287,23 @@ export namespace dfareporting_v3_3 { /** * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. */ - advertiserCustomEventId?: string; + advertiserCustomEventId?: string | null; /** * User-entered name for the event. */ - advertiserCustomEventName?: string; + advertiserCustomEventName?: string | null; /** * Type of the event. This is a read-only field. */ - advertiserCustomEventType?: string; + 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; + artworkLabel?: string | null; /** * Artwork type used by the creative.This is a read-only field. */ - artworkType?: string; + artworkType?: string | null; /** * Exit click-through URL for the event. This field is used only for exit events. */ @@ -2311,7 +2311,7 @@ export namespace dfareporting_v3_3 { /** * ID of this event. This is a required field and should not be modified after insertion. */ - id?: string; + id?: string | null; /** * Properties for rich media popup windows. This field is used only for exit events. */ @@ -2319,11 +2319,11 @@ export namespace dfareporting_v3_3 { /** * Target type used by the event. */ - targetType?: string; + targetType?: string | null; /** * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. */ - videoReportingId?: string; + videoReportingId?: string | null; } /** * Contains properties of a creative field. @@ -2332,11 +2332,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this creative field. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this creative field. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -2344,19 +2344,19 @@ export namespace dfareporting_v3_3 { /** * ID of this creative field. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this creative field. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Creative Field Assignment. @@ -2365,11 +2365,11 @@ export namespace dfareporting_v3_3 { /** * ID of the creative field. */ - creativeFieldId?: string; + creativeFieldId?: string | null; /** * ID of the creative field value. */ - creativeFieldValueId?: string; + creativeFieldValueId?: string | null; } /** * Creative Field List Response @@ -2382,11 +2382,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a creative field value. @@ -2395,15 +2395,15 @@ export namespace dfareporting_v3_3 { /** * ID of this creative field value. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". */ - kind?: string; + 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; + value?: string | null; } /** * Creative Field Value List Response @@ -2416,11 +2416,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a creative group. @@ -2429,11 +2429,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this creative group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this creative group. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -2441,23 +2441,23 @@ export namespace dfareporting_v3_3 { /** * 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; + groupNumber?: number | null; /** * ID of this creative group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this creative group. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Creative Group Assignment. @@ -2466,11 +2466,11 @@ export namespace dfareporting_v3_3 { /** * ID of the creative group to be assigned. */ - creativeGroupId?: string; + creativeGroupId?: string | null; /** * Creative group number of the creative group assignment. */ - creativeGroupNumber?: string; + creativeGroupNumber?: string | null; } /** * Creative Group List Response @@ -2483,11 +2483,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Creative optimization settings. @@ -2496,11 +2496,11 @@ export namespace dfareporting_v3_3 { /** * 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; + id?: string | null; /** * Name of this creative optimization config. This is a required field and must be less than 129 characters long. */ - name?: string; + name?: string | null; /** * List of optimization activities associated with this configuration. */ @@ -2508,7 +2508,7 @@ export namespace dfareporting_v3_3 { /** * Optimization model for this configuration. */ - optimizationModel?: string; + optimizationModel?: string | null; } /** * Creative Rotation. @@ -2521,15 +2521,15 @@ export namespace dfareporting_v3_3 { /** * 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; + creativeOptimizationConfigurationId?: string | null; /** * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. */ - type?: string; + type?: string | null; /** * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */ - weightCalculationStrategy?: string; + weightCalculationStrategy?: string | null; } /** * Creative List Response @@ -2542,11 +2542,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". @@ -2563,7 +2563,7 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -2580,15 +2580,15 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". */ - kind?: string; + 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; + type?: string | null; /** * The value of the custom floodlight variable. The length of string must not exceed 50 characters. */ - value?: string; + value?: string | null; } /** * Represents a Custom Rich Media Events group. @@ -2601,7 +2601,7 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#customRichMediaEvents. */ - kind?: string; + kind?: string | null; } /** * Custom Viewability Metric @@ -2614,11 +2614,11 @@ export namespace dfareporting_v3_3 { /** * ID of the custom viewability metric. */ - id?: string; + id?: string | null; /** * Name of the custom viewability metric. */ - name?: string; + name?: string | null; } /** * The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. @@ -2627,19 +2627,19 @@ export namespace dfareporting_v3_3 { /** * Whether the video must be audible to count an impression. */ - audible?: boolean; + 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; + 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; + timePercent?: number | null; /** * The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. */ - viewabilityPercent?: number; + viewabilityPercent?: number | null; } /** * Represents a date range. @@ -2648,19 +2648,19 @@ export namespace dfareporting_v3_3 { /** * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ - endDate?: string; + endDate?: string | null; /** * The kind of resource this is, in this case dfareporting#dateRange. */ - kind?: string; + kind?: string | null; /** * The date range relative to the date of when the report is run. */ - relativeDateRange?: string; + relativeDateRange?: string | null; /** * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ - startDate?: string; + startDate?: string | null; } /** * Day Part Targeting. @@ -2669,15 +2669,15 @@ export namespace dfareporting_v3_3 { /** * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" */ - daysOfWeek?: string[]; + 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[]; + hoursOfDay?: number[] | null; /** * Whether or not to use the user's local time. If false, the America/New York time zone applies. */ - userLocalTime?: boolean; + userLocalTime?: boolean | null; } /** * Contains information about a landing page deep link. @@ -2686,15 +2686,15 @@ export namespace dfareporting_v3_3 { /** * The URL of the mobile app being linked to. */ - appUrl?: string; + appUrl?: string | null; /** * The fallback URL. This URL will be served to users who do not have the mobile app installed. */ - fallbackUrl?: string; + fallbackUrl?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". */ - kind?: string; + kind?: string | null; /** * The mobile app targeted by this deep link. */ @@ -2702,7 +2702,7 @@ export namespace dfareporting_v3_3 { /** * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. */ - remarketingListIds?: string[]; + 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. @@ -2711,11 +2711,11 @@ export namespace dfareporting_v3_3 { /** * ID of the click-through event tag to apply to all ads in this entity's scope. */ - defaultClickThroughEventTagId?: string; + defaultClickThroughEventTagId?: string | null; /** * Whether this entity should override the inherited default click-through event tag with its own defined value. */ - overrideInheritedEventTag?: boolean; + overrideInheritedEventTag?: boolean | null; } /** * Delivery Schedule. @@ -2728,15 +2728,15 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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; + priority?: string | null; } /** * Google Ad Manager Settings @@ -2745,23 +2745,23 @@ export namespace dfareporting_v3_3 { /** * Ad Manager network code for this directory site. */ - dfpNetworkCode?: string; + dfpNetworkCode?: string | null; /** * Ad Manager network name for this directory site. */ - dfpNetworkName?: string; + dfpNetworkName?: string | null; /** * Whether this directory site accepts programmatic placements. */ - programmaticPlacementAccepted?: boolean; + programmaticPlacementAccepted?: boolean | null; /** * Whether this directory site is available only via Publisher Portal. */ - publisherPortalOnly?: boolean; + publisherPortalOnly?: boolean | null; /** * Whether this directory site accepts publisher-paid tags. */ - pubPaidPlacementAccepted?: boolean; + pubPaidPlacementAccepted?: boolean | null; } /** * Represents a dimension. @@ -2770,11 +2770,11 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#dimension. */ - kind?: string; + kind?: string | null; /** * The dimension name, e.g. dfa:advertiser */ - name?: string; + name?: string | null; } /** * Represents a dimension filter. @@ -2783,15 +2783,15 @@ export namespace dfareporting_v3_3 { /** * The name of the dimension to filter. */ - dimensionName?: string; + dimensionName?: string | null; /** * The kind of resource this is, in this case dfareporting#dimensionFilter. */ - kind?: string; + kind?: string | null; /** * The value of the dimension to filter. */ - value?: string; + value?: string | null; } /** * Represents a DimensionValue resource. @@ -2800,27 +2800,27 @@ export namespace dfareporting_v3_3 { /** * The name of the dimension. */ - dimensionName?: string; + dimensionName?: string | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID associated with the value if available. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#dimensionValue. */ - kind?: string; + 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; + matchType?: string | null; /** * The value of the dimension. */ - value?: string; + value?: string | null; } /** * Represents the list of DimensionValue resources. @@ -2829,7 +2829,7 @@ export namespace dfareporting_v3_3 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The dimension values returned in this response. */ @@ -2837,11 +2837,11 @@ export namespace dfareporting_v3_3 { /** * The kind of list this is, in this case dfareporting#dimensionValueList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Represents a DimensionValuesRequest. @@ -2850,11 +2850,11 @@ export namespace dfareporting_v3_3 { /** * The name of the dimension for which values should be requested. */ - dimensionName?: string; + 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; + endDate?: string | null; /** * The list of filters by which to filter values. The filters are ANDed. */ @@ -2862,11 +2862,11 @@ export namespace dfareporting_v3_3 { /** * The kind of request this is, in this case dfareporting#dimensionValueRequest. */ - kind?: string; + 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; + 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. @@ -2875,11 +2875,11 @@ export namespace dfareporting_v3_3 { /** * Whether this directory site is active. */ - active?: boolean; + active?: boolean | null; /** * ID of this directory site. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. */ @@ -2887,19 +2887,19 @@ export namespace dfareporting_v3_3 { /** * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" */ - inpageTagFormats?: string[]; + inpageTagFormats?: string[] | null; /** * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" */ - interstitialTagFormats?: string[]; + interstitialTagFormats?: string[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". */ - kind?: string; + kind?: string | null; /** * Name of this directory site. */ - name?: string; + name?: string | null; /** * Directory site settings. */ @@ -2907,7 +2907,7 @@ export namespace dfareporting_v3_3 { /** * URL of this directory site. */ - url?: string; + url?: string | null; } /** * Directory Site Settings @@ -2916,7 +2916,7 @@ export namespace dfareporting_v3_3 { /** * Whether this directory site has disabled active view creatives. */ - activeViewOptOut?: boolean; + activeViewOptOut?: boolean | null; /** * Directory site Ad Manager settings. */ @@ -2924,11 +2924,11 @@ export namespace dfareporting_v3_3 { /** * Whether this site accepts in-stream video ads. */ - instreamVideoPlacementAccepted?: boolean; + instreamVideoPlacementAccepted?: boolean | null; /** * Whether this site accepts interstitial ads. */ - interstitialPlacementAccepted?: boolean; + interstitialPlacementAccepted?: boolean | null; } /** * Directory Site List Response @@ -2941,11 +2941,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + 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. @@ -2954,19 +2954,19 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". */ - kind?: string; + 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; + name?: string | null; /** * ID of the object of this dynamic targeting key. This is a required field. */ - objectId?: string; + objectId?: string | null; /** * Type of the object of this dynamic targeting key. This is a required field. */ - objectType?: string; + objectType?: string | null; } /** * Dynamic Targeting Key List Response @@ -2979,7 +2979,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". */ - kind?: string; + kind?: string | null; } /** * A description of how user IDs are encrypted. @@ -2988,19 +2988,19 @@ export namespace dfareporting_v3_3 { /** * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. */ - encryptionEntityId?: string; + encryptionEntityId?: string | null; /** * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. */ - encryptionEntityType?: string; + encryptionEntityType?: string | null; /** * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. */ - encryptionSource?: string; + encryptionSource?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */ - kind?: string; + kind?: string | null; } /** * Contains properties of an event tag. @@ -3009,11 +3009,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this event tag. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3021,7 +3021,7 @@ export namespace dfareporting_v3_3 { /** * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -3029,55 +3029,55 @@ export namespace dfareporting_v3_3 { /** * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. */ - enabledByDefault?: boolean; + 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; + excludeFromAdxRequests?: boolean | null; /** * ID of this event tag. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". */ - kind?: string; + kind?: string | null; /** * Name of this event tag. This is a required field and must be less than 256 characters long. */ - name?: string; + 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; + 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[]; + siteIds?: string[] | null; /** * Whether this tag is SSL-compliant or not. This is a read-only field. */ - sslCompliant?: boolean; + sslCompliant?: boolean | null; /** * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. */ - status?: string; + status?: string | null; /** * Subaccount ID of this event tag. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + 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; + 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; + urlEscapeLevels?: number | null; } /** * Event tag override information. @@ -3086,11 +3086,11 @@ export namespace dfareporting_v3_3 { /** * Whether this override is enabled. */ - enabled?: boolean; + enabled?: boolean | null; /** * ID of this event tag override. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; } /** * Event Tag List Response @@ -3103,7 +3103,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". */ - kind?: string; + 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". @@ -3116,39 +3116,39 @@ export namespace dfareporting_v3_3 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The filename of the file. */ - fileName?: string; + fileName?: string | null; /** * The output format of the report. Only available once the file is available. */ - format?: string; + format?: string | null; /** * The unique ID of this report file. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#file. */ - kind?: string; + kind?: string | null; /** * The timestamp in milliseconds since epoch when this file was last modified. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * The ID of the report this file was generated from. */ - reportId?: string; + reportId?: string | null; /** * The status of the report file. */ - status?: string; + status?: string | null; /** * The URLs where the completed report file can be downloaded. */ - urls?: {apiUrl?: string; browserUrl?: string}; + urls?: {apiUrl?: string; browserUrl?: string} | null; } /** * Represents the list of File resources. @@ -3157,7 +3157,7 @@ export namespace dfareporting_v3_3 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The files returned in this response. */ @@ -3165,11 +3165,11 @@ export namespace dfareporting_v3_3 { /** * The kind of list this is, in this case dfareporting#fileList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Flight @@ -3178,19 +3178,19 @@ export namespace dfareporting_v3_3 { /** * Inventory item flight end date. */ - endDate?: string; + endDate?: string | null; /** * Rate or cost of this flight. */ - rateOrCost?: string; + rateOrCost?: string | null; /** * Inventory item flight start date. */ - startDate?: string; + startDate?: string | null; /** * Units of this flight. */ - units?: string; + units?: string | null; } /** * Floodlight Activity GenerateTag Response @@ -3199,15 +3199,15 @@ export namespace dfareporting_v3_3 { /** * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. */ - floodlightActivityTag?: string; + 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; + globalSiteTagGlobalSnippet?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". */ - kind?: string; + kind?: string | null; } /** * Floodlight Activity List Response @@ -3220,11 +3220,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains properties of a Floodlight activity. @@ -3233,11 +3233,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this floodlight activity. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3245,11 +3245,11 @@ export namespace dfareporting_v3_3 { /** * 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; + cacheBustingType?: string | null; /** * Counting method for conversions for this floodlight activity. This is a required field. */ - countingMethod?: string; + countingMethod?: string | null; /** * Dynamic floodlight tags. */ @@ -3257,27 +3257,27 @@ export namespace dfareporting_v3_3 { /** * URL where this tag will be deployed. If specified, must be less than 256 characters long. */ - expectedUrl?: string; + expectedUrl?: string | null; /** * Floodlight activity group ID of this floodlight activity. This is a required field. */ - floodlightActivityGroupId?: string; + floodlightActivityGroupId?: string | null; /** * Name of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupName?: string; + floodlightActivityGroupName?: string | null; /** * Tag string of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupTagString?: string; + floodlightActivityGroupTagString?: string | null; /** * Type of the associated floodlight activity group. This is a read-only field. */ - floodlightActivityGroupType?: string; + 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; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -3285,15 +3285,15 @@ export namespace dfareporting_v3_3 { /** * The type of Floodlight tag this activity will generate. This is a required field. */ - floodlightTagType?: string; + floodlightTagType?: string | null; /** * Whether this activity is archived. */ - hidden?: boolean; + hidden?: boolean | null; /** * ID of this floodlight activity. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. */ @@ -3301,15 +3301,15 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". */ - kind?: string; + 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; + name?: string | null; /** * General notes or implementation instructions for the tag. */ - notes?: string; + notes?: string | null; /** * Publisher dynamic floodlight tags. */ @@ -3317,31 +3317,31 @@ export namespace dfareporting_v3_3 { /** * Whether this tag should use SSL. */ - secure?: boolean; + 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; + sslCompliant?: boolean | null; /** * Whether this floodlight activity must be SSL-compliant. */ - sslRequired?: boolean; + sslRequired?: boolean | null; /** * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. */ - tagFormat?: string; + 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; + 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[]; + userDefinedVariableTypes?: string[] | null; } /** * Dynamic Tag @@ -3350,15 +3350,15 @@ export namespace dfareporting_v3_3 { /** * ID of this dynamic tag. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Name of this tag. */ - name?: string; + name?: string | null; /** * Tag code. */ - tag?: string; + tag?: string | null; } /** * Contains properties of a Floodlight activity group. @@ -3367,11 +3367,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this floodlight activity group. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3379,7 +3379,7 @@ export namespace dfareporting_v3_3 { /** * Floodlight configuration ID of this floodlight activity group. This is a required field. */ - floodlightConfigurationId?: string; + floodlightConfigurationId?: string | null; /** * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ @@ -3387,7 +3387,7 @@ export namespace dfareporting_v3_3 { /** * ID of this floodlight activity group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. */ @@ -3395,23 +3395,23 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". */ - kind?: string; + 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; + name?: string | null; /** * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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; + tagString?: string | null; /** * Type of the floodlight activity group. This is a required field that is read-only after insertion. */ - type?: string; + type?: string | null; } /** * Floodlight Activity Group List Response @@ -3424,11 +3424,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Publisher Dynamic Tag @@ -3437,11 +3437,11 @@ export namespace dfareporting_v3_3 { /** * Whether this tag is applicable only for click-throughs. */ - clickThrough?: boolean; + 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; + directorySiteId?: string | null; /** * Dynamic floodlight tag. */ @@ -3449,7 +3449,7 @@ export namespace dfareporting_v3_3 { /** * Site ID of this dynamic tag. */ - siteId?: string; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -3457,7 +3457,7 @@ export namespace dfareporting_v3_3 { /** * Whether this tag is applicable only for view-throughs. */ - viewThrough?: boolean; + viewThrough?: boolean | null; } /** * Contains properties of a Floodlight configuration. @@ -3466,11 +3466,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this floodlight configuration. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of the parent advertiser of this floodlight configuration. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -3478,7 +3478,7 @@ export namespace dfareporting_v3_3 { /** * Whether advertiser data is shared with Google Analytics. */ - analyticsDataSharingEnabled?: boolean; + analyticsDataSharingEnabled?: boolean | null; /** * Custom Viewability metric for the floodlight configuration. */ @@ -3486,15 +3486,15 @@ export namespace dfareporting_v3_3 { /** * 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; + exposureToConversionEnabled?: boolean | null; /** * Day that will be counted as the first day of the week in reports. This is a required field. */ - firstDayOfWeek?: string; + firstDayOfWeek?: string | null; /** * ID of this floodlight configuration. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. */ @@ -3502,11 +3502,11 @@ export namespace dfareporting_v3_3 { /** * Whether in-app attribution tracking is enabled. */ - inAppAttributionTrackingEnabled?: boolean; + inAppAttributionTrackingEnabled?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". */ - kind?: string; + kind?: string | null; /** * Lookback window settings for this floodlight configuration. */ @@ -3514,7 +3514,7 @@ export namespace dfareporting_v3_3 { /** * Types of attribution options for natural search conversions. */ - naturalSearchConversionAttributionOption?: string; + naturalSearchConversionAttributionOption?: string | null; /** * Settings for Campaign Manager Omniture integration. */ @@ -3522,7 +3522,7 @@ export namespace dfareporting_v3_3 { /** * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; /** * Configuration settings for dynamic and image floodlight tags. */ @@ -3547,7 +3547,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". */ - kind?: string; + kind?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". @@ -3564,7 +3564,7 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -3577,11 +3577,11 @@ export namespace dfareporting_v3_3 { /** * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. */ - duration?: string; + 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; + impressions?: string | null; } /** * FsCommand. @@ -3590,23 +3590,23 @@ export namespace dfareporting_v3_3 { /** * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ - left?: number; + left?: number | null; /** * Position in the browser where the window will open. */ - positionOption?: string; + positionOption?: string | null; /** * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ - top?: number; + top?: number | null; /** * Height of the window. */ - windowHeight?: number; + windowHeight?: number | null; /** * Width of the window. */ - windowWidth?: number; + windowWidth?: number | null; } /** * Geographical Targeting. @@ -3623,7 +3623,7 @@ export namespace dfareporting_v3_3 { /** * 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; + 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. */ @@ -3644,7 +3644,7 @@ export namespace dfareporting_v3_3 { /** * Account ID of this inventory item. */ - accountId?: string; + 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. */ @@ -3652,31 +3652,31 @@ export namespace dfareporting_v3_3 { /** * Advertiser ID of this inventory item. */ - advertiserId?: string; + advertiserId?: string | null; /** * Content category ID of this inventory item. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Estimated click-through rate of this inventory item. */ - estimatedClickThroughRate?: string; + estimatedClickThroughRate?: string | null; /** * Estimated conversion rate of this inventory item. */ - estimatedConversionRate?: string; + estimatedConversionRate?: string | null; /** * ID of this inventory item. */ - id?: string; + id?: string | null; /** * Whether this inventory item is in plan. */ - inPlan?: boolean; + inPlan?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this inventory item. */ @@ -3684,19 +3684,19 @@ export namespace dfareporting_v3_3 { /** * 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; + name?: string | null; /** * Negotiation channel ID of this inventory item. */ - negotiationChannelId?: string; + negotiationChannelId?: string | null; /** * Order ID of this inventory item. */ - orderId?: string; + orderId?: string | null; /** * Placement strategy ID of this inventory item. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing of this inventory item. */ @@ -3704,23 +3704,23 @@ export namespace dfareporting_v3_3 { /** * Project ID of this inventory item. */ - projectId?: string; + projectId?: string | null; /** * RFP ID of this inventory item. */ - rfpId?: string; + rfpId?: string | null; /** * ID of the site this inventory item is associated with. */ - siteId?: string; + siteId?: string | null; /** * Subaccount ID of this inventory item. */ - subaccountId?: string; + subaccountId?: string | null; /** * Type of inventory item. */ - type?: string; + type?: string | null; } /** * Inventory item List Response @@ -3733,11 +3733,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Key Value Targeting Expression. @@ -3746,7 +3746,7 @@ export namespace dfareporting_v3_3 { /** * Keyword expression being targeted by the ad. */ - expression?: string; + expression?: string | null; } /** * Contains information about where a user's browser is taken after the user clicks an ad. @@ -3755,11 +3755,11 @@ export namespace dfareporting_v3_3 { /** * Advertiser ID of this landing page. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Whether this landing page has been archived. */ - archived?: boolean; + archived?: boolean | null; /** * Links that will direct the user to a mobile app, if installed. */ @@ -3767,19 +3767,19 @@ export namespace dfareporting_v3_3 { /** * ID of this landing page. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". */ - kind?: string; + kind?: string | null; /** * Name of this landing page. This is a required field. It must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * URL of this landing page. This is a required field. */ - url?: string; + url?: string | null; } /** * Contains information about a language that can be targeted by ads. @@ -3788,19 +3788,19 @@ export namespace dfareporting_v3_3 { /** * Language ID of this language. This is the ID used for targeting and generating reports. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". */ - kind?: string; + 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; + languageCode?: string | null; /** * Name of this language. */ - name?: string; + name?: string | null; } /** * Language List Response @@ -3809,7 +3809,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". */ - kind?: string; + kind?: string | null; /** * Language collection. */ @@ -3831,7 +3831,7 @@ export namespace dfareporting_v3_3 { /** * Timestamp of the last change in milliseconds since epoch. */ - time?: string; + time?: string | null; } /** * A group clause made up of list population terms representing constraints joined by ORs. @@ -3849,11 +3849,11 @@ export namespace dfareporting_v3_3 { /** * Floodlight activity ID associated with this rule. This field can be left blank. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. */ - floodlightActivityName?: string; + 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. */ @@ -3866,35 +3866,35 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + 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; + operator?: string | null; /** * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. */ - remarketingListId?: string; + 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; + 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; + 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; + 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; + variableName?: string | null; } /** * Remarketing List Targeting Expression. @@ -3903,7 +3903,7 @@ export namespace dfareporting_v3_3 { /** * Expression describing which lists are being targeted by the ad. */ - expression?: string; + expression?: string | null; } /** * Lookback configuration settings. @@ -3912,11 +3912,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + postImpressionActivitiesDuration?: number | null; } /** * Represents a metric. @@ -3925,11 +3925,11 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#metric. */ - kind?: string; + kind?: string | null; /** * The metric name, e.g. dfa:impressions */ - name?: string; + name?: string | null; } /** * Contains information about a metro region that can be targeted by ads. @@ -3938,31 +3938,31 @@ export namespace dfareporting_v3_3 { /** * Country code of the country to which this metro region belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this metro region belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this metro region. */ - dartId?: string; + 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; + dmaId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". */ - kind?: string; + kind?: string | null; /** * Metro code of this metro region. This is equivalent to dma_id. */ - metroCode?: string; + metroCode?: string | null; /** * Name of this metro region. */ - name?: string; + name?: string | null; } /** * Metro List Response @@ -3971,7 +3971,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". */ - kind?: string; + kind?: string | null; /** * Metro collection. */ @@ -3984,23 +3984,23 @@ export namespace dfareporting_v3_3 { /** * Mobile app directory. */ - directory?: string; + directory?: string | null; /** * ID of this mobile app. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". */ - kind?: string; + kind?: string | null; /** * Publisher name. */ - publisherName?: string; + publisherName?: string | null; /** * Title of this mobile app. */ - title?: string; + title?: string | null; } /** * Mobile app List Response @@ -4009,7 +4009,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". */ - kind?: string; + kind?: string | null; /** * Mobile apps collection. */ @@ -4017,7 +4017,7 @@ export namespace dfareporting_v3_3 { /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Contains information about a mobile carrier that can be targeted by ads. @@ -4026,23 +4026,23 @@ export namespace dfareporting_v3_3 { /** * Country code of the country to which this mobile carrier belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this mobile carrier belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * ID of this mobile carrier. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". */ - kind?: string; + kind?: string | null; /** * Name of this mobile carrier. */ - name?: string; + name?: string | null; } /** * Mobile Carrier List Response @@ -4051,7 +4051,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". */ - kind?: string; + kind?: string | null; /** * Mobile carrier collection. */ @@ -4064,15 +4064,15 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". */ - kind?: string; + kind?: string | null; /** * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. */ - objectIds?: string[]; + 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; + status?: string | null; } /** * Offset Position. @@ -4081,11 +4081,11 @@ export namespace dfareporting_v3_3 { /** * Offset distance from left side of an asset or a window. */ - left?: number; + left?: number | null; /** * Offset distance from top side of an asset or a window. */ - top?: number; + top?: number | null; } /** * Omniture Integration Settings. @@ -4094,11 +4094,11 @@ export namespace dfareporting_v3_3 { /** * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. */ - omnitureCostDataEnabled?: boolean; + 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; + omnitureIntegrationEnabled?: boolean | null; } /** * Contains information about an operating system that can be targeted by ads. @@ -4107,23 +4107,23 @@ export namespace dfareporting_v3_3 { /** * DART ID of this operating system. This is the ID used for targeting. */ - dartId?: string; + dartId?: string | null; /** * Whether this operating system is for desktop. */ - desktop?: boolean; + desktop?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". */ - kind?: string; + kind?: string | null; /** * Whether this operating system is for mobile. */ - mobile?: boolean; + mobile?: boolean | null; /** * Name of this operating system. */ - name?: string; + name?: string | null; } /** * Operating System List Response @@ -4132,7 +4132,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". */ - kind?: string; + kind?: string | null; /** * Operating system collection. */ @@ -4145,23 +4145,23 @@ export namespace dfareporting_v3_3 { /** * ID of this operating system version. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". */ - kind?: string; + kind?: string | null; /** * Major version (leftmost number) of this operating system version. */ - majorVersion?: string; + majorVersion?: string | null; /** * Minor version (number after the first dot) of this operating system version. */ - minorVersion?: string; + minorVersion?: string | null; /** * Name of this operating system version. */ - name?: string; + name?: string | null; /** * Operating system of this operating system version. */ @@ -4174,7 +4174,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". */ - kind?: string; + kind?: string | null; /** * Operating system version collection. */ @@ -4187,7 +4187,7 @@ export namespace dfareporting_v3_3 { /** * Floodlight activity ID of this optimization activity. This is a required field. */ - floodlightActivityId?: string; + floodlightActivityId?: string | null; /** * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. */ @@ -4195,7 +4195,7 @@ export namespace dfareporting_v3_3 { /** * 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; + weight?: number | null; } /** * Describes properties of a Planning order. @@ -4204,27 +4204,27 @@ export namespace dfareporting_v3_3 { /** * Account ID of this order. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this order. */ - advertiserId?: string; + advertiserId?: string | null; /** * IDs for users that have to approve documents created for this order. */ - approverUserProfileIds?: string[]; + approverUserProfileIds?: string[] | null; /** * Buyer invoice ID associated with this order. */ - buyerInvoiceId?: string; + buyerInvoiceId?: string | null; /** * Name of the buyer organization. */ - buyerOrganizationName?: string; + buyerOrganizationName?: string | null; /** * Comments in this order. */ - comments?: string; + comments?: string | null; /** * Contacts for this order. */ @@ -4232,11 +4232,11 @@ export namespace dfareporting_v3_3 { /** * ID of this order. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this order. */ @@ -4244,43 +4244,43 @@ export namespace dfareporting_v3_3 { /** * Name of this order. */ - name?: string; + name?: string | null; /** * Notes of this order. */ - notes?: string; + notes?: string | null; /** * ID of the terms and conditions template used in this order. */ - planningTermId?: string; + planningTermId?: string | null; /** * Project ID of this order. */ - projectId?: string; + projectId?: string | null; /** * Seller order ID associated with this order. */ - sellerOrderId?: string; + sellerOrderId?: string | null; /** * Name of the seller organization. */ - sellerOrganizationName?: string; + sellerOrganizationName?: string | null; /** * Site IDs this order is associated with. */ - siteId?: string[]; + siteId?: string[] | null; /** * Free-form site names this order is associated with. */ - siteNames?: string[]; + siteNames?: string[] | null; /** * Subaccount ID of this order. */ - subaccountId?: string; + subaccountId?: string | null; /** * Terms and conditions of this order. */ - termsAndConditions?: string; + termsAndConditions?: string | null; } /** * Contact of an order. @@ -4289,23 +4289,23 @@ export namespace dfareporting_v3_3 { /** * 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; + contactInfo?: string | null; /** * Name of this contact. */ - contactName?: string; + contactName?: string | null; /** * Title of this contact. */ - contactTitle?: string; + contactTitle?: string | null; /** * Type of this contact. */ - contactType?: string; + contactType?: string | null; /** * ID of the user profile containing the signature that will be embedded into order documents. */ - signatureUserProfileId?: string; + signatureUserProfileId?: string | null; } /** * Contains properties of a Planning order document. @@ -4314,23 +4314,23 @@ export namespace dfareporting_v3_3 { /** * Account ID of this order document. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this order document. */ - advertiserId?: string; + 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; + amendedOrderDocumentId?: string | null; /** * IDs of users who have approved this order document. */ - approvedByUserProfileIds?: string[]; + approvedByUserProfileIds?: string[] | null; /** * Whether this order document is cancelled. */ - cancelled?: boolean; + cancelled?: boolean | null; /** * Information about the creation of this order document. */ @@ -4338,47 +4338,47 @@ export namespace dfareporting_v3_3 { /** * Effective date of this order document. */ - effectiveDate?: string; + effectiveDate?: string | null; /** * ID of this order document. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". */ - kind?: string; + kind?: string | null; /** * List of email addresses that received the last sent document. */ - lastSentRecipients?: string[]; + lastSentRecipients?: string[] | null; /** * Timestamp of the last email sent with this order document. */ - lastSentTime?: string; + lastSentTime?: string | null; /** * ID of the order from which this order document is created. */ - orderId?: string; + orderId?: string | null; /** * Project ID of this order document. */ - projectId?: string; + projectId?: string | null; /** * Whether this order document has been signed. */ - signed?: boolean; + signed?: boolean | null; /** * Subaccount ID of this order document. */ - subaccountId?: string; + subaccountId?: string | null; /** * Title of this order document. */ - title?: string; + title?: string | null; /** * Type of this order document */ - type?: string; + type?: string | null; } /** * Order document List Response @@ -4387,11 +4387,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Order document collection */ @@ -4404,11 +4404,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Order collection. */ @@ -4429,7 +4429,7 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -4446,11 +4446,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this placement. This field can be left blank. */ - accountId?: string; + 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; + adBlockingOptOut?: boolean | null; /** * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. */ @@ -4458,7 +4458,7 @@ export namespace dfareporting_v3_3 { /** * Advertiser ID of this placement. This field can be left blank. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -4466,11 +4466,11 @@ export namespace dfareporting_v3_3 { /** * Whether this placement is archived. */ - archived?: boolean; + archived?: boolean | null; /** * Campaign ID of this placement. This field is a required field on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -4478,15 +4478,15 @@ export namespace dfareporting_v3_3 { /** * Comments for this placement. */ - comment?: string; + 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; + compatibility?: string | null; /** * ID of the content category assigned to this placement. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Information about the creation of this placement. This is a read-only field. */ @@ -4494,7 +4494,7 @@ export namespace dfareporting_v3_3 { /** * 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; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -4502,11 +4502,11 @@ export namespace dfareporting_v3_3 { /** * External ID for this placement. */ - externalId?: string; + externalId?: string | null; /** * ID of this placement. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this placement. This is a read-only, auto-generated field. */ @@ -4514,11 +4514,11 @@ export namespace dfareporting_v3_3 { /** * Key name of this placement. This is a read-only, auto-generated field. */ - keyName?: string; + keyName?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this placement. This is a read-only field. */ @@ -4530,19 +4530,19 @@ export namespace dfareporting_v3_3 { /** * Name of this placement.This is a required field and must be less than 256 characters long. */ - name?: string; + name?: string | null; /** * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. */ - paymentApproved?: boolean; + paymentApproved?: boolean | null; /** * Payment source for this placement. This is a required field that is read-only after insertion. */ - paymentSource?: string; + paymentSource?: string | null; /** * ID of this placement's group, if applicable. */ - placementGroupId?: string; + placementGroupId?: string | null; /** * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. */ @@ -4550,7 +4550,7 @@ export namespace dfareporting_v3_3 { /** * ID of the placement strategy assigned to this placement. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. */ @@ -4558,7 +4558,7 @@ export namespace dfareporting_v3_3 { /** * 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; + primary?: boolean | null; /** * Information about the last publisher update. This is a read-only field. */ @@ -4566,7 +4566,7 @@ export namespace dfareporting_v3_3 { /** * 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; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -4578,19 +4578,19 @@ export namespace dfareporting_v3_3 { /** * Whether creatives assigned to this placement must be SSL-compliant. */ - sslRequired?: boolean; + sslRequired?: boolean | null; /** * Third-party placement status. */ - status?: string; + status?: string | null; /** * Subaccount ID of this placement. This field can be left blank. */ - subaccountId?: string; + 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[]; + tagFormats?: string[] | null; /** * Tag settings for this placement. */ @@ -4598,7 +4598,7 @@ export namespace dfareporting_v3_3 { /** * 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; + videoActiveViewOptOut?: boolean | null; /** * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. */ @@ -4606,7 +4606,7 @@ export namespace dfareporting_v3_3 { /** * 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; + vpaidAdapterChoice?: string | null; } /** * Placement Assignment. @@ -4615,11 +4615,11 @@ export namespace dfareporting_v3_3 { /** * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. */ - active?: boolean; + active?: boolean | null; /** * ID of the placement to be assigned. This is a required field. */ - placementId?: string; + placementId?: string | null; /** * Dimension value for the ID of the placement. This is a read-only, auto-generated field. */ @@ -4627,7 +4627,7 @@ export namespace dfareporting_v3_3 { /** * 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; + sslRequired?: boolean | null; } /** * Contains properties of a package or roadblock. @@ -4636,11 +4636,11 @@ export namespace dfareporting_v3_3 { /** * Account ID of this placement group. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this placement group. This is a required field on insertion. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -4648,11 +4648,11 @@ export namespace dfareporting_v3_3 { /** * Whether this placement group is archived. */ - archived?: boolean; + archived?: boolean | null; /** * Campaign ID of this placement group. This field is required on insertion. */ - campaignId?: string; + campaignId?: string | null; /** * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ @@ -4660,15 +4660,15 @@ export namespace dfareporting_v3_3 { /** * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. */ - childPlacementIds?: string[]; + childPlacementIds?: string[] | null; /** * Comments for this placement group. */ - comment?: string; + comment?: string | null; /** * ID of the content category assigned to this placement group. */ - contentCategoryId?: string; + contentCategoryId?: string | null; /** * Information about the creation of this placement group. This is a read-only field. */ @@ -4676,7 +4676,7 @@ export namespace dfareporting_v3_3 { /** * 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; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -4684,11 +4684,11 @@ export namespace dfareporting_v3_3 { /** * External ID for this placement. */ - externalId?: string; + externalId?: string | null; /** * ID of this placement group. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. */ @@ -4696,7 +4696,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this placement group. This is a read-only field. */ @@ -4704,15 +4704,15 @@ export namespace dfareporting_v3_3 { /** * Name of this placement group. This is a required field and must be less than 256 characters long. */ - name?: string; + 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; + placementGroupType?: string | null; /** * ID of the placement strategy assigned to this placement group. */ - placementStrategyId?: string; + placementStrategyId?: string | null; /** * Pricing schedule of this placement group. This field is required on insertion. */ @@ -4720,7 +4720,7 @@ export namespace dfareporting_v3_3 { /** * 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; + primaryPlacementId?: string | null; /** * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. */ @@ -4728,7 +4728,7 @@ export namespace dfareporting_v3_3 { /** * 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; + siteId?: string | null; /** * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ @@ -4736,7 +4736,7 @@ export namespace dfareporting_v3_3 { /** * Subaccount ID of this placement group. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Placement Group List Response @@ -4745,11 +4745,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement group collection. */ @@ -4762,7 +4762,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". */ - kind?: string; + kind?: string | null; /** * Set of generated tags for the specified placements. */ @@ -4775,11 +4775,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement collection. */ @@ -4792,11 +4792,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Placement strategy collection. */ @@ -4809,19 +4809,19 @@ export namespace dfareporting_v3_3 { /** * Account ID of this placement strategy.This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * ID of this placement strategy. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". */ - kind?: string; + 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; + name?: string | null; } /** * Placement Tag @@ -4830,7 +4830,7 @@ export namespace dfareporting_v3_3 { /** * Placement ID */ - placementId?: string; + placementId?: string | null; /** * Tags generated for this placement. */ @@ -4843,15 +4843,15 @@ export namespace dfareporting_v3_3 { /** * ID of this platform type. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". */ - kind?: string; + kind?: string | null; /** * Name of this platform type. */ - name?: string; + name?: string | null; } /** * Platform Type List Response @@ -4860,7 +4860,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". */ - kind?: string; + kind?: string | null; /** * Platform type collection. */ @@ -4881,31 +4881,31 @@ export namespace dfareporting_v3_3 { /** * Popup window position either centered or at specific coordinate. */ - positionType?: string; + positionType?: string | null; /** * Whether to display the browser address bar. */ - showAddressBar?: boolean; + showAddressBar?: boolean | null; /** * Whether to display the browser menu bar. */ - showMenuBar?: boolean; + showMenuBar?: boolean | null; /** * Whether to display the browser scroll bar. */ - showScrollBar?: boolean; + showScrollBar?: boolean | null; /** * Whether to display the browser status bar. */ - showStatusBar?: boolean; + showStatusBar?: boolean | null; /** * Whether to display the browser tool bar. */ - showToolBar?: boolean; + showToolBar?: boolean | null; /** * Title of popup window. */ - title?: string; + title?: string | null; } /** * Contains information about a postal code that can be targeted by ads. @@ -4914,23 +4914,23 @@ export namespace dfareporting_v3_3 { /** * Postal code. This is equivalent to the id field. */ - code?: string; + code?: string | null; /** * Country code of the country to which this postal code belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this postal code belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * ID of this postal code. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". */ - kind?: string; + kind?: string | null; } /** * Postal Code List Response @@ -4939,7 +4939,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". */ - kind?: string; + kind?: string | null; /** * Postal code collection. */ @@ -4952,11 +4952,11 @@ export namespace dfareporting_v3_3 { /** * Cap cost type of this inventory item. */ - capCostType?: string; + capCostType?: string | null; /** * End date of this inventory item. */ - endDate?: string; + 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. */ @@ -4964,15 +4964,15 @@ export namespace dfareporting_v3_3 { /** * 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; + groupType?: string | null; /** * Pricing type of this inventory item. */ - pricingType?: string; + pricingType?: string | null; /** * Start date of this inventory item. */ - startDate?: string; + startDate?: string | null; } /** * Pricing Schedule @@ -4981,23 +4981,23 @@ export namespace dfareporting_v3_3 { /** * Placement cap cost option. */ - capCostOption?: string; + capCostOption?: string | null; /** * Whether cap costs are ignored by ad serving. */ - disregardOverdelivery?: boolean; + 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; + endDate?: string | null; /** * Whether this placement is flighted. If true, pricing periods will be computed automatically. */ - flighted?: boolean; + 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; + floodlightActivityId?: string | null; /** * Pricing periods for this placement. */ @@ -5005,15 +5005,15 @@ export namespace dfareporting_v3_3 { /** * Placement pricing type. This field is required on insertion. */ - pricingType?: string; + 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; + 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; + testingStartDate?: string | null; } /** * Pricing Period @@ -5022,23 +5022,23 @@ export namespace dfareporting_v3_3 { /** * 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; + endDate?: string | null; /** * Comments for this pricing period. */ - pricingComment?: string; + 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; + 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; + startDate?: string | null; /** * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. */ - units?: string; + units?: string | null; } /** * Contains properties of a Planning project. @@ -5047,43 +5047,43 @@ export namespace dfareporting_v3_3 { /** * Account ID of this project. */ - accountId?: string; + accountId?: string | null; /** * Advertiser ID of this project. */ - advertiserId?: string; + advertiserId?: string | null; /** * Audience age group of this project. */ - audienceAgeGroup?: string; + audienceAgeGroup?: string | null; /** * Audience gender of this project. */ - audienceGender?: string; + 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; + budget?: string | null; /** * Client billing code of this project. */ - clientBillingCode?: string; + clientBillingCode?: string | null; /** * Name of the project client. */ - clientName?: string; + clientName?: string | null; /** * End date of the project. */ - endDate?: string; + endDate?: string | null; /** * ID of this project. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". */ - kind?: string; + kind?: string | null; /** * Information about the most recent modification of this project. */ @@ -5091,47 +5091,47 @@ export namespace dfareporting_v3_3 { /** * Name of this project. */ - name?: string; + name?: string | null; /** * Overview of this project. */ - overview?: string; + overview?: string | null; /** * Start date of the project. */ - startDate?: string; + startDate?: string | null; /** * Subaccount ID of this project. */ - subaccountId?: string; + subaccountId?: string | null; /** * Number of clicks that the advertiser is targeting. */ - targetClicks?: string; + targetClicks?: string | null; /** * Number of conversions that the advertiser is targeting. */ - targetConversions?: string; + targetConversions?: string | null; /** * CPA that the advertiser is targeting. */ - targetCpaNanos?: string; + targetCpaNanos?: string | null; /** * CPC that the advertiser is targeting. */ - targetCpcNanos?: string; + targetCpcNanos?: string | null; /** * vCPM from Active View that the advertiser is targeting. */ - targetCpmActiveViewNanos?: string; + targetCpmActiveViewNanos?: string | null; /** * CPM that the advertiser is targeting. */ - targetCpmNanos?: string; + targetCpmNanos?: string | null; /** * Number of impressions that the advertiser is targeting. */ - targetImpressions?: string; + targetImpressions?: string | null; } /** * Project List Response @@ -5140,11 +5140,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Project collection. */ @@ -5165,7 +5165,7 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -5186,15 +5186,15 @@ export namespace dfareporting_v3_3 { /** * The delivery type for the recipient. */ - deliveryType?: string; + deliveryType?: string | null; /** * The email address of the recipient. */ - email?: string; + email?: string | null; /** * The kind of resource this is, in this case dfareporting#recipient. */ - kind?: string; + kind?: string | null; } /** * Contains information about a region that can be targeted by ads. @@ -5203,27 +5203,27 @@ export namespace dfareporting_v3_3 { /** * Country code of the country to which this region belongs. */ - countryCode?: string; + countryCode?: string | null; /** * DART ID of the country to which this region belongs. */ - countryDartId?: string; + countryDartId?: string | null; /** * DART ID of this region. */ - dartId?: string; + dartId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". */ - kind?: string; + kind?: string | null; /** * Name of this region. */ - name?: string; + name?: string | null; /** * Region code. */ - regionCode?: string; + regionCode?: string | null; } /** * Region List Response @@ -5232,7 +5232,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". */ - kind?: string; + kind?: string | null; /** * Region collection. */ @@ -5245,15 +5245,15 @@ export namespace dfareporting_v3_3 { /** * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ - accountId?: string; + accountId?: string | null; /** * Whether this remarketing list is active. */ - active?: boolean; + active?: boolean | null; /** * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -5261,19 +5261,19 @@ export namespace dfareporting_v3_3 { /** * Remarketing list description. */ - description?: string; + description?: string | null; /** * Remarketing list ID. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". */ - kind?: string; + 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; + lifeSpan?: string | null; /** * Rule used to populate the remarketing list with users. */ @@ -5281,19 +5281,19 @@ export namespace dfareporting_v3_3 { /** * Number of users currently in the list. This is a read-only field. */ - listSize?: string; + listSize?: string | null; /** * Product from which this remarketing list was originated. */ - listSource?: string; + listSource?: string | null; /** * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. */ - name?: string; + 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; + 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. @@ -5302,19 +5302,19 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". */ - kind?: string; + kind?: string | null; /** * Remarketing list ID. This is a read-only, auto-generated field. */ - remarketingListId?: string; + remarketingListId?: string | null; /** * Accounts that the remarketing list is shared with. */ - sharedAccountIds?: string[]; + sharedAccountIds?: string[] | null; /** * Advertisers that the remarketing list is shared with. */ - sharedAdvertiserIds?: string[]; + sharedAdvertiserIds?: string[] | null; } /** * Remarketing list response @@ -5323,11 +5323,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Remarketing list collection. */ @@ -5340,7 +5340,7 @@ export namespace dfareporting_v3_3 { /** * The account ID to which this report belongs. */ - accountId?: string; + accountId?: string | null; /** * The report criteria for a report of type "STANDARD". */ @@ -5351,7 +5351,7 @@ export namespace dfareporting_v3_3 { dimensionFilters?: Schema$DimensionValue[]; dimensions?: Schema$SortedDimension[]; metricNames?: string[]; - }; + } | null; /** * The report criteria for a report of type "CROSS_DIMENSION_REACH". */ @@ -5363,7 +5363,7 @@ export namespace dfareporting_v3_3 { metricNames?: string[]; overlapMetricNames?: string[]; pivoted?: boolean; - }; + } | null; /** * The report's email delivery settings. */ @@ -5372,15 +5372,15 @@ export namespace dfareporting_v3_3 { emailOwnerDeliveryType?: string; message?: string; recipients?: Schema$Recipient[]; - }; + } | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The filename used when generating report files for this report. */ - fileName?: string; + fileName?: string | null; /** * The report criteria for a report of type "FLOODLIGHT". */ @@ -5396,31 +5396,31 @@ export namespace dfareporting_v3_3 { 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; + format?: string | null; /** * The unique ID identifying this report resource. */ - id?: string; + id?: string | null; /** * The kind of resource this is, in this case dfareporting#report. */ - kind?: string; + kind?: string | null; /** * The timestamp (in milliseconds since epoch) of when this report was last modified. */ - lastModifiedTime?: string; + lastModifiedTime?: string | null; /** * The name of the report. */ - name?: string; + name?: string | null; /** * The user profile id of the owner of this report. */ - ownerProfileId?: string; + ownerProfileId?: string | null; /** * The report criteria for a report of type "PATH_TO_CONVERSION". */ @@ -5444,7 +5444,7 @@ export namespace dfareporting_v3_3 { maximumInteractionGap?: number; pivotOnInteractionPath?: boolean; }; - }; + } | null; /** * The report criteria for a report of type "REACH". */ @@ -5457,7 +5457,7 @@ export namespace dfareporting_v3_3 { 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". */ @@ -5469,15 +5469,15 @@ export namespace dfareporting_v3_3 { repeatsOnWeekDays?: string[]; runsOnDayOfMonth?: string; startDate?: string; - }; + } | null; /** * The subaccount ID to which this report belongs if applicable. */ - subAccountId?: string; + subAccountId?: string | null; /** * The type of the report. */ - type?: string; + type?: string | null; } /** * Represents fields that are compatible to be selected for a report of type "STANDARD". @@ -5494,7 +5494,7 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#reportCompatibleFields. */ - kind?: string; + kind?: string | null; /** * Metrics which are compatible to be selected in the "metricNames" section of the report. */ @@ -5511,7 +5511,7 @@ export namespace dfareporting_v3_3 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The reports returned in this response. */ @@ -5519,11 +5519,11 @@ export namespace dfareporting_v3_3 { /** * The kind of list this is, in this case dfareporting#reportList. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Reporting Configuration @@ -5532,7 +5532,7 @@ export namespace dfareporting_v3_3 { /** * 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; + exposureToConversionEnabled?: boolean | null; /** * Default lookback windows for new advertisers in this account. */ @@ -5540,7 +5540,7 @@ export namespace dfareporting_v3_3 { /** * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" */ - reportGenerationTimeZoneId?: string; + reportGenerationTimeZoneId?: string | null; } /** * Rich Media Exit Override. @@ -5553,11 +5553,11 @@ export namespace dfareporting_v3_3 { /** * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. */ - enabled?: boolean; + enabled?: boolean | null; /** * ID for the override to refer to a specific exit in the creative. */ - exitId?: string; + exitId?: string | null; } /** * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. @@ -5566,15 +5566,15 @@ export namespace dfareporting_v3_3 { /** * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. */ - assetId?: string; + assetId?: string | null; /** * A user-friendly name for this rule. This is a required field. */ - name?: string; + 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; + targetingTemplateId?: string | null; } /** * Contains properties of a site. @@ -5583,15 +5583,15 @@ export namespace dfareporting_v3_3 { /** * Account ID of this site. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * Whether this site is approved. */ - approved?: boolean; + approved?: boolean | null; /** * Directory site associated with this site. This is a required field that is read-only after insertion. */ - directorySiteId?: string; + directorySiteId?: string | null; /** * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ @@ -5599,7 +5599,7 @@ export namespace dfareporting_v3_3 { /** * ID of this site. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Dimension value for the ID of this site. This is a read-only, auto-generated field. */ @@ -5607,15 +5607,15 @@ export namespace dfareporting_v3_3 { /** * Key name of this site. This is a read-only, auto-generated field. */ - keyName?: string; + keyName?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". */ - kind?: string; + 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; + name?: string | null; /** * Site contacts. */ @@ -5627,7 +5627,7 @@ export namespace dfareporting_v3_3 { /** * Subaccount ID of this site. This is a read-only field that can be left blank. */ - subaccountId?: string; + 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. */ @@ -5640,7 +5640,7 @@ export namespace dfareporting_v3_3 { /** * Whether companions are disabled for this site template. */ - companionsDisabled?: boolean; + 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. */ @@ -5648,11 +5648,11 @@ export namespace dfareporting_v3_3 { /** * Whether to serve only static images as companions. */ - imageOnly?: boolean; + imageOnly?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". */ - kind?: string; + kind?: string | null; } /** * Site Contact @@ -5661,35 +5661,35 @@ export namespace dfareporting_v3_3 { /** * Address of this site contact. */ - address?: string; + address?: string | null; /** * Site contact type. */ - contactType?: string; + contactType?: string | null; /** * Email address of this site contact. This is a required field. */ - email?: string; + email?: string | null; /** * First name of this site contact. */ - firstName?: string; + firstName?: string | null; /** * ID of this site contact. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Last name of this site contact. */ - lastName?: string; + lastName?: string | null; /** * Primary phone number of this site contact. */ - phone?: string; + phone?: string | null; /** * Title or designation of this site contact. */ - title?: string; + title?: string | null; } /** * Site Settings @@ -5698,15 +5698,15 @@ export namespace dfareporting_v3_3 { /** * Whether active view creatives are disabled for this site. */ - activeViewOptOut?: boolean; + 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; + adBlockingOptOut?: boolean | null; /** * Whether new cookies are disabled for this site. */ - disableNewCookie?: boolean; + disableNewCookie?: boolean | null; /** * Configuration settings for dynamic and image floodlight tags. */ @@ -5714,11 +5714,11 @@ export namespace dfareporting_v3_3 { /** * 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; + 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; + vpaidAdapterChoiceTemplate?: string | null; } /** * Skippable Settings @@ -5727,7 +5727,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". */ - kind?: string; + kind?: string | null; /** * Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. */ @@ -5739,7 +5739,7 @@ export namespace dfareporting_v3_3 { /** * Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. */ - skippable?: boolean; + skippable?: boolean | null; } /** * Site List Response @@ -5748,11 +5748,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Site collection. */ @@ -5765,11 +5765,11 @@ export namespace dfareporting_v3_3 { /** * 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[]; + enabledVideoFormats?: number[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". */ - kind?: string; + kind?: string | null; } /** * Video Settings @@ -5782,11 +5782,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". */ - kind?: string; + 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; + 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. */ @@ -5803,23 +5803,23 @@ export namespace dfareporting_v3_3 { /** * Height of this size. Acceptable values are 0 to 32767, inclusive. */ - height?: number; + height?: number | null; /** * IAB standard size. This is a read-only, auto-generated field. */ - iab?: boolean; + iab?: boolean | null; /** * ID of this size. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". */ - kind?: string; + kind?: string | null; /** * Width of this size. Acceptable values are 0 to 32767, inclusive. */ - width?: number; + width?: number | null; } /** * Size List Response @@ -5828,7 +5828,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". */ - kind?: string; + kind?: string | null; /** * Size collection. */ @@ -5841,7 +5841,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". */ - kind?: string; + kind?: string | null; /** * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. */ @@ -5853,7 +5853,7 @@ export namespace dfareporting_v3_3 { /** * Whether the user can skip creatives served to this placement. */ - skippable?: boolean; + skippable?: boolean | null; } /** * Represents a sorted dimension. @@ -5862,15 +5862,15 @@ export namespace dfareporting_v3_3 { /** * The kind of resource this is, in this case dfareporting#sortedDimension. */ - kind?: string; + kind?: string | null; /** * The name of the dimension. */ - name?: string; + name?: string | null; /** * An optional sort order for the dimension column. */ - sortOrder?: string; + sortOrder?: string | null; } /** * Contains properties of a Campaign Manager subaccount. @@ -5879,23 +5879,23 @@ export namespace dfareporting_v3_3 { /** * ID of the account that contains this subaccount. This is a read-only field that can be left blank. */ - accountId?: string; + accountId?: string | null; /** * IDs of the available user role permissions for this subaccount. */ - availablePermissionIds?: string[]; + availablePermissionIds?: string[] | null; /** * ID of this subaccount. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". */ - kind?: string; + 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; + name?: string | null; } /** * Subaccount List Response @@ -5904,11 +5904,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Subaccount collection. */ @@ -5921,23 +5921,23 @@ export namespace dfareporting_v3_3 { /** * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ - adId?: string; + adId?: string | null; /** * Tag string to record a click. */ - clickTag?: string; + clickTag?: string | null; /** * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ - creativeId?: string; + creativeId?: string | null; /** * TagData tag format of this tag. */ - format?: string; + format?: string | null; /** * Tag string for serving an ad. */ - impressionTag?: string; + impressionTag?: string | null; } /** * Tag Settings @@ -5946,19 +5946,19 @@ export namespace dfareporting_v3_3 { /** * 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; + additionalKeyValues?: string | null; /** * Whether static landing page URLs should be included in the tags. This setting applies only to placements. */ - includeClickThroughUrls?: boolean; + includeClickThroughUrls?: boolean | null; /** * Whether click-tracking string should be included in the tags. */ - includeClickTracking?: boolean; + 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; + keywordOption?: string | null; } /** * Dynamic and Image Tag Settings. @@ -5967,11 +5967,11 @@ export namespace dfareporting_v3_3 { /** * Whether dynamic floodlight tags are enabled. */ - dynamicTagEnabled?: boolean; + dynamicTagEnabled?: boolean | null; /** * Whether image tags are enabled. */ - imageTagEnabled?: boolean; + 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. @@ -5980,15 +5980,15 @@ export namespace dfareporting_v3_3 { /** * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ - accountId?: string; + accountId?: string | null; /** * Whether this targetable remarketing list is active. */ - active?: boolean; + active?: boolean | null; /** * Dimension value for the advertiser ID that owns this targetable remarketing list. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. */ @@ -5996,35 +5996,35 @@ export namespace dfareporting_v3_3 { /** * Targetable remarketing list description. */ - description?: string; + description?: string | null; /** * Targetable remarketing list ID. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". */ - kind?: string; + kind?: string | null; /** * Number of days that a user should remain in the targetable remarketing list without an impression. */ - lifeSpan?: string; + lifeSpan?: string | null; /** * Number of users currently in the list. This is a read-only field. */ - listSize?: string; + listSize?: string | null; /** * Product from which this targetable remarketing list was originated. */ - listSource?: string; + listSource?: string | null; /** * Name of the targetable remarketing list. Is no greater than 128 characters long. */ - name?: string; + 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; + subaccountId?: string | null; } /** * Targetable remarketing list response @@ -6033,11 +6033,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Targetable remarketing list collection. */ @@ -6050,11 +6050,11 @@ export namespace dfareporting_v3_3 { /** * 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; + accountId?: string | null; /** * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. */ - advertiserId?: string; + advertiserId?: string | null; /** * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ @@ -6070,7 +6070,7 @@ export namespace dfareporting_v3_3 { /** * ID of this targeting template. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Key-value targeting criteria. */ @@ -6078,7 +6078,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". */ - kind?: string; + kind?: string | null; /** * Language targeting criteria. */ @@ -6090,11 +6090,11 @@ export namespace dfareporting_v3_3 { /** * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. */ - name?: string; + 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; + subaccountId?: string | null; /** * Technology platform targeting criteria. */ @@ -6107,11 +6107,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Targeting template collection. */ @@ -6124,11 +6124,11 @@ export namespace dfareporting_v3_3 { /** * User-entered value. */ - customHtml?: string; + customHtml?: string | null; /** * Type of browser window for which the backup image of the flash creative can be displayed. */ - targetWindowOption?: string; + targetWindowOption?: string | null; } /** * Technology Targeting. @@ -6166,11 +6166,11 @@ export namespace dfareporting_v3_3 { /** * Name of the third-party authentication token. */ - name?: string; + name?: string | null; /** * Value of the third-party authentication token. This is a read-only, auto-generated field. */ - value?: string; + value?: string | null; } /** * Third-party Tracking URL. @@ -6179,11 +6179,11 @@ export namespace dfareporting_v3_3 { /** * Third-party URL type for in-stream video and in-stream audio creatives. */ - thirdPartyUrlType?: string; + thirdPartyUrlType?: string | null; /** * URL for the specified third-party URL type. */ - url?: string; + url?: string | null; } /** * Transcode Settings @@ -6192,11 +6192,11 @@ export namespace dfareporting_v3_3 { /** * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. */ - enabledVideoFormats?: number[]; + enabledVideoFormats?: number[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". */ - kind?: string; + 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. @@ -6205,11 +6205,11 @@ export namespace dfareporting_v3_3 { /** * Registry used for the Ad ID value. */ - registry?: string; + 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; + value?: string | null; } /** * User Defined Variable configuration. @@ -6218,15 +6218,15 @@ export namespace dfareporting_v3_3 { /** * Data type for the variable. This is a required field. */ - dataType?: string; + 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; + reportName?: string | null; /** * Variable name in the tag. This is a required field. */ - variableType?: string; + variableType?: string | null; } /** * Represents a UserProfile resource. @@ -6235,35 +6235,35 @@ export namespace dfareporting_v3_3 { /** * The account ID to which this profile belongs. */ - accountId?: string; + accountId?: string | null; /** * The account name this profile belongs to. */ - accountName?: string; + accountName?: string | null; /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The kind of resource this is, in this case dfareporting#userProfile. */ - kind?: string; + kind?: string | null; /** * The unique ID of the user profile. */ - profileId?: string; + profileId?: string | null; /** * The sub account ID this profile belongs to if applicable. */ - subAccountId?: string; + subAccountId?: string | null; /** * The sub account name this profile belongs to if applicable. */ - subAccountName?: string; + subAccountName?: string | null; /** * The user name. */ - userName?: string; + userName?: string | null; } /** * Represents the list of user profiles. @@ -6272,7 +6272,7 @@ export namespace dfareporting_v3_3 { /** * The eTag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The user profiles returned in this response. */ @@ -6280,7 +6280,7 @@ export namespace dfareporting_v3_3 { /** * The kind of list this is, in this case dfareporting#userProfileList. */ - kind?: string; + kind?: string | null; } /** * Contains properties of auser role, which is used to manage user access. @@ -6289,27 +6289,27 @@ export namespace dfareporting_v3_3 { /** * Account ID of this user role. This is a read-only field that can be left blank. */ - accountId?: string; + 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; + defaultUserRole?: boolean | null; /** * ID of this user role. This is a read-only, auto-generated field. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". */ - kind?: string; + 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; + 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; + parentUserRoleId?: string | null; /** * List of permissions associated with this user role. */ @@ -6317,7 +6317,7 @@ export namespace dfareporting_v3_3 { /** * Subaccount ID of this user role. This is a read-only field that can be left blank. */ - subaccountId?: string; + subaccountId?: string | null; } /** * Contains properties of a user role permission. @@ -6326,23 +6326,23 @@ export namespace dfareporting_v3_3 { /** * Levels of availability for a user role permission. */ - availability?: string; + availability?: string | null; /** * ID of this user role permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". */ - kind?: string; + kind?: string | null; /** * Name of this user role permission. */ - name?: string; + name?: string | null; /** * ID of the permission group that this user role permission belongs to. */ - permissionGroupId?: string; + permissionGroupId?: string | null; } /** * Represents a grouping of related user role permissions. @@ -6351,15 +6351,15 @@ export namespace dfareporting_v3_3 { /** * ID of this user role permission. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". */ - kind?: string; + kind?: string | null; /** * Name of this user role permission group. */ - name?: string; + name?: string | null; } /** * User Role Permission Group List Response @@ -6368,7 +6368,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". */ - kind?: string; + kind?: string | null; /** * User role permission group collection. */ @@ -6381,7 +6381,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". */ - kind?: string; + kind?: string | null; /** * User role permission collection. */ @@ -6394,11 +6394,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". */ - kind?: string; + kind?: string | null; /** * Pagination token to be used for the next list operation. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * User role collection. */ @@ -6411,15 +6411,15 @@ export namespace dfareporting_v3_3 { /** * File type of the video format. */ - fileType?: string; + fileType?: string | null; /** * ID of the video format. */ - id?: number; + id?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". */ - kind?: string; + kind?: string | null; /** * The resolution of this video format. */ @@ -6427,7 +6427,7 @@ export namespace dfareporting_v3_3 { /** * The target bit rate of this video format. */ - targetBitRate?: number; + targetBitRate?: number | null; } /** * Video Format List Response @@ -6436,7 +6436,7 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". */ - kind?: string; + kind?: string | null; /** * Video format collection. */ @@ -6449,11 +6449,11 @@ export namespace dfareporting_v3_3 { /** * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. */ - offsetPercentage?: number; + offsetPercentage?: number | null; /** * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. */ - offsetSeconds?: number; + offsetSeconds?: number | null; } /** * Video Settings @@ -6466,11 +6466,11 @@ export namespace dfareporting_v3_3 { /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". */ - kind?: string; + kind?: string | null; /** * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. */ - orientation?: string; + 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. */ diff --git a/src/apis/digitalassetlinks/v1.ts b/src/apis/digitalassetlinks/v1.ts index d22810ca620..f19ac10cffd 100644 --- a/src/apis/digitalassetlinks/v1.ts +++ b/src/apis/digitalassetlinks/v1.ts @@ -130,7 +130,7 @@ export namespace digitalassetlinks_v1 { /** * Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED */ - packageName?: string; + packageName?: string | null; } /** * Uniquely identifies an asset. A digital asset is an identifiable and addressable online entity that typically provides some service or content. Examples of assets are websites, Android apps, Twitter feeds, and Plus Pages. @@ -152,7 +152,7 @@ export namespace digitalassetlinks_v1 { /** * The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). */ - sha256Fingerprint?: string; + sha256Fingerprint?: string | null; } /** * Response message for the CheckAssetLinks call. @@ -161,19 +161,19 @@ export namespace digitalassetlinks_v1 { /** * Human-readable message containing information intended to help end users understand, reproduce and debug the result. The message will be in English and we are currently not planning to offer any translations. Please note that no guarantees are made about the contents or format of this string. Any aspect of it may be subject to change without notice. You should not attempt to programmatically parse this data. For programmatic access, use the error_code field below. */ - debugString?: string; + debugString?: string | null; /** * Error codes that describe the result of the Check operation. */ - errorCode?: string[]; + errorCode?: string[] | null; /** * Set to true if the assets specified in the request are linked by the relation specified in the request. */ - linked?: boolean; + linked?: boolean | null; /** * From serving time, how much longer the response should be considered valid barring further updates. REQUIRED */ - maxAge?: string; + maxAge?: string | null; } /** * Response message for the List call. @@ -182,15 +182,15 @@ export namespace digitalassetlinks_v1 { /** * Human-readable message containing information intended to help end users understand, reproduce and debug the result. The message will be in English and we are currently not planning to offer any translations. Please note that no guarantees are made about the contents or format of this string. Any aspect of it may be subject to change without notice. You should not attempt to programmatically parse this data. For programmatic access, use the error_code field below. */ - debugString?: string; + debugString?: string | null; /** * Error codes that describe the result of the List operation. */ - errorCode?: string[]; + errorCode?: string[] | null; /** * From serving time, how much longer the response should be considered valid barring further updates. REQUIRED */ - maxAge?: string; + maxAge?: string | null; /** * A list of all the matching statements that have been found. */ @@ -203,7 +203,7 @@ export namespace digitalassetlinks_v1 { /** * The relation identifies the use of the statement as intended by the source asset's owner (that is, the person or entity who issued the statement). Every complete statement has a relation. We identify relations with strings of the format `<kind>/<detail>`, where `<kind>` must be one of a set of pre-defined purpose categories, and `<detail>` is a free-form lowercase alphanumeric string that describes the specific use case of the statement. Refer to [our API documentation](/digital-asset-links/v1/relation-strings) for the current list of supported relations. Example: `delegate_permission/common.handle_all_urls` REQUIRED */ - relation?: string; + relation?: string | null; /** * Every statement has a source asset. REQUIRED */ @@ -220,7 +220,7 @@ export namespace digitalassetlinks_v1 { /** * Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://<hostname>[:<port>] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED */ - site?: string; + site?: string | null; } export class Resource$Assetlinks { diff --git a/src/apis/discovery/v1.ts b/src/apis/discovery/v1.ts index dd9dc1c0c5c..6cbb8fff8ad 100644 --- a/src/apis/discovery/v1.ts +++ b/src/apis/discovery/v1.ts @@ -105,7 +105,7 @@ export namespace discovery_v1 { /** * Indicate the version of the Discovery API used to generate this doc. */ - discoveryVersion?: string; + discoveryVersion?: string | null; /** * The individual directory entries. One entry per api/version pair. */ @@ -122,17 +122,17 @@ export namespace discovery_v1 { preferred?: boolean; title?: string; version?: string; - }>; + }> | null; /** * The kind for this response. */ - kind?: string; + kind?: string | null; } export interface Schema$JsonSchema { /** * A reference to another schema. The value of this property is the "id" of another schema. */ - $ref?: string; + $ref?: string | null; /** * If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. */ @@ -140,31 +140,31 @@ export namespace discovery_v1 { /** * Additional information about this property. */ - annotations?: {required?: string[]}; + annotations?: {required?: string[]} | null; /** * The default value of this property (if one exists). */ - default?: string; + default?: string | null; /** * A description of this object. */ - description?: string; + description?: string | null; /** * Values this parameter may take (if it is an enum). */ - enum?: string[]; + enum?: string[] | null; /** * The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. */ - enumDescriptions?: string[]; + enumDescriptions?: string[] | null; /** * An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 */ - format?: string; + format?: string | null; /** * Unique identifier for this schema. */ - id?: string; + id?: string | null; /** * If this is a schema for an array, this property is the schema for each element in the array. */ @@ -172,183 +172,183 @@ export namespace discovery_v1 { /** * Whether this parameter goes in the query or the path for REST requests. */ - location?: string; + location?: string | null; /** * The maximum value of this parameter. */ - maximum?: string; + maximum?: string | null; /** * The minimum value of this parameter. */ - minimum?: string; + minimum?: string | null; /** * The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html */ - pattern?: string; + pattern?: string | null; /** * If this is a schema for an object, list the schema for each property of this object. */ - properties?: {[key: string]: Schema$JsonSchema}; + properties?: {[key: string]: Schema$JsonSchema} | null; /** * The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. */ - readOnly?: boolean; + readOnly?: boolean | null; /** * Whether this parameter may appear multiple times. */ - repeated?: boolean; + repeated?: boolean | null; /** * Whether the parameter is required. */ - required?: boolean; + required?: boolean | null; /** * The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 */ - type?: string; + type?: string | null; /** * In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. */ variant?: { discriminant?: string; map?: Array<{$ref?: string; type_value?: string}>; - }; + } | null; } export interface Schema$RestDescription { /** * Authentication information. */ - auth?: {oauth2?: {scopes?: {[key: string]: {description?: string}}}}; + auth?: {oauth2?: {scopes?: {[key: string]: {description?: string}}}} | null; /** * [DEPRECATED] The base path for REST requests. */ - basePath?: string; + basePath?: string | null; /** * [DEPRECATED] The base URL for REST requests. */ - baseUrl?: string; + baseUrl?: string | null; /** * The path for REST batch requests. */ - batchPath?: string; + batchPath?: string | null; /** * Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. */ - canonicalName?: string; + canonicalName?: string | null; /** * The description of this API. */ - description?: string; + description?: string | null; /** * Indicate the version of the Discovery API used to generate this doc. */ - discoveryVersion?: string; + discoveryVersion?: string | null; /** * A link to human readable documentation for the API. */ - documentationLink?: string; + documentationLink?: string | null; /** * The ETag for this response. */ - etag?: string; + etag?: string | null; /** * Enable exponential backoff for suitable methods in the generated clients. */ - exponentialBackoffDefault?: boolean; + exponentialBackoffDefault?: boolean | null; /** * A list of supported features for this API. */ - features?: string[]; + features?: string[] | null; /** * Links to 16x16 and 32x32 icons representing the API. */ - icons?: {x16?: string; x32?: string}; + icons?: {x16?: string; x32?: string} | null; /** * The ID of this API. */ - id?: string; + id?: string | null; /** * The kind for this response. */ - kind?: string; + kind?: string | null; /** * Labels for the status of this API, such as labs or deprecated. */ - labels?: string[]; + labels?: string[] | null; /** * API-level methods for this API. */ - methods?: {[key: string]: Schema$RestMethod}; + methods?: {[key: string]: Schema$RestMethod} | null; /** * The name of this API. */ - name?: string; + name?: string | null; /** * The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. */ - ownerDomain?: string; + ownerDomain?: string | null; /** * The name of the owner of this API. See ownerDomain. */ - ownerName?: string; + ownerName?: string | null; /** * The package of the owner of this API. See ownerDomain. */ - packagePath?: string; + packagePath?: string | null; /** * Common parameters that apply across all apis. */ - parameters?: {[key: string]: Schema$JsonSchema}; + parameters?: {[key: string]: Schema$JsonSchema} | null; /** * The protocol described by this document. */ - protocol?: string; + protocol?: string | null; /** * The resources in this API. */ - resources?: {[key: string]: Schema$RestResource}; + resources?: {[key: string]: Schema$RestResource} | null; /** * The version of this API. */ - revision?: string; + revision?: string | null; /** * The root URL under which all API services live. */ - rootUrl?: string; + rootUrl?: string | null; /** * The schemas for this API. */ - schemas?: {[key: string]: Schema$JsonSchema}; + schemas?: {[key: string]: Schema$JsonSchema} | null; /** * The base path for all REST requests. */ - servicePath?: string; + servicePath?: string | null; /** * The title of this API. */ - title?: string; + title?: string | null; /** * The version of this API. */ - version?: string; - version_module?: boolean; + version?: string | null; + version_module?: boolean | null; } export interface Schema$RestMethod { /** * Description of this method. */ - description?: string; + description?: string | null; /** * Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. */ - etagRequired?: boolean; + etagRequired?: boolean | null; /** * HTTP method used by this method. */ - httpMethod?: string; + httpMethod?: string | null; /** * A unique ID for this method. This property can be used to match methods between different versions of Discovery. */ - id?: string; + id?: string | null; /** * Media upload parameters. */ @@ -359,57 +359,57 @@ export namespace discovery_v1 { resumable?: {multipart?: boolean; path?: string}; simple?: {multipart?: boolean; path?: string}; }; - }; + } | null; /** * Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first. */ - parameterOrder?: string[]; + parameterOrder?: string[] | null; /** * Details for all parameters in this method. */ - parameters?: {[key: string]: Schema$JsonSchema}; + parameters?: {[key: string]: Schema$JsonSchema} | null; /** * The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. */ - path?: string; + path?: string | null; /** * The schema for the request. */ - request?: {$ref?: string; parameterName?: string}; + request?: {$ref?: string; parameterName?: string} | null; /** * The schema for the response. */ - response?: {$ref?: string}; + response?: {$ref?: string} | null; /** * OAuth 2.0 scopes applicable to this method. */ - scopes?: string[]; + scopes?: string[] | null; /** * Whether this method supports media downloads. */ - supportsMediaDownload?: boolean; + supportsMediaDownload?: boolean | null; /** * Whether this method supports media uploads. */ - supportsMediaUpload?: boolean; + supportsMediaUpload?: boolean | null; /** * Whether this method supports subscriptions. */ - supportsSubscription?: boolean; + supportsSubscription?: boolean | null; /** * Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download. */ - useMediaDownloadService?: boolean; + useMediaDownloadService?: boolean | null; } export interface Schema$RestResource { /** * Methods on this resource. */ - methods?: {[key: string]: Schema$RestMethod}; + methods?: {[key: string]: Schema$RestMethod} | null; /** * Sub-resources on this resource. */ - resources?: {[key: string]: Schema$RestResource}; + resources?: {[key: string]: Schema$RestResource} | null; } export class Resource$Apis { diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 552a01dfb15..967d88ff737 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -208,7 +208,7 @@ export namespace dlp_v2 { /** * Absolute number of the row from the beginning of the table at the time of scanning. */ - rowNumber?: string; + rowNumber?: string | null; /** * Complete BigQuery table reference. */ @@ -229,12 +229,12 @@ export namespace dlp_v2 { /** * Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. */ - rowsLimit?: string; + rowsLimit?: string | null; /** * Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. */ - rowsLimitPercent?: number; - sampleMethod?: string; + rowsLimitPercent?: number | null; + sampleMethod?: string | null; /** * Complete BigQuery table reference. */ @@ -247,15 +247,15 @@ export namespace dlp_v2 { /** * Dataset ID of the table. */ - datasetId?: string; + datasetId?: string | null; /** * The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. */ - projectId?: string; + projectId?: string | null; /** * Name of the table. */ - tableId?: string; + tableId?: string | null; } /** * Bounding box encompassing detected text within an image. @@ -264,19 +264,19 @@ export namespace dlp_v2 { /** * Height of the bounding box in pixels. */ - height?: number; + height?: number | null; /** * Left coordinate of the bounding box. (0,0) is upper left. */ - left?: number; + left?: number | null; /** * Top coordinate of the bounding box. (0,0) is upper left. */ - top?: number; + top?: number | null; /** * Width of the bounding box in pixels. */ - width?: number; + width?: number | null; } /** * Bucket is represented as a range, along with replacement values. @@ -311,11 +311,11 @@ export namespace dlp_v2 { /** * Content data to inspect or redact. */ - data?: string; + data?: string | null; /** * The type of data stored in the bytes string. Default will be TEXT_UTF8. */ - type?: string; + type?: string | null; } /** * The request message for canceling a DLP job. @@ -334,11 +334,11 @@ export namespace dlp_v2 { /** * Total number of values in this bucket. */ - bucketSize?: string; + bucketSize?: string | null; /** * Total number of distinct values in this bucket. */ - bucketValueCount?: string; + bucketValueCount?: string | null; /** * Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20. */ @@ -346,11 +346,11 @@ export namespace dlp_v2 { /** * Lower bound on the value frequency of the values in this bucket. */ - valueFrequencyLowerBound?: string; + valueFrequencyLowerBound?: string | null; /** * Upper bound on the value frequency of the values in this bucket. */ - valueFrequencyUpperBound?: string; + valueFrequencyUpperBound?: string | null; } /** * Result of the categorical stats computation. @@ -372,22 +372,22 @@ export namespace dlp_v2 { /** * Character to mask the sensitive values&mdash;for example, "*" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "*" for strings, 0 for digits. */ - maskingCharacter?: string; + maskingCharacter?: string | null; /** * Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally. */ - numberToMask?: number; + numberToMask?: number | null; /** * Mask characters in reverse order. For example, if `masking_character` is '0', number_to_mask is 14, and `reverse_order` is false, then 1234-5678-9012-3456 -> 00000000000000-3456 If `masking_character` is '*', `number_to_mask` is 3, and `reverse_order` is true, then 12345 -> 12*** */ - reverseOrder?: boolean; + reverseOrder?: boolean | null; } /** * Characters to skip when doing deidentification of a value. These will be left alone and skipped. */ export interface Schema$GooglePrivacyDlpV2CharsToIgnore { - charactersToSkip?: string; - commonCharactersToIgnore?: string; + charactersToSkip?: string | null; + commonCharactersToIgnore?: string | null; } /** * Message representing a set of files in Cloud Storage. @@ -396,7 +396,7 @@ export namespace dlp_v2 { /** * The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed. */ - url?: string; + url?: string | null; } /** * Options defining a file or a set of files within a Google Cloud Storage bucket. @@ -405,11 +405,11 @@ export namespace dlp_v2 { /** * Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. */ - bytesLimitPerFile?: string; + bytesLimitPerFile?: string | null; /** * Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. */ - bytesLimitPerFilePercent?: number; + bytesLimitPerFilePercent?: number | null; /** * The set of one or more files to scan. */ @@ -417,12 +417,12 @@ export namespace dlp_v2 { /** * Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. */ - filesLimitPercent?: number; + filesLimitPercent?: number | null; /** * List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. */ - fileTypes?: string[]; - sampleMethod?: string; + fileTypes?: string[] | null; + sampleMethod?: string | null; } /** * Message representing a single file or path in Cloud Storage. @@ -431,7 +431,7 @@ export namespace dlp_v2 { /** * A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt */ - path?: string; + path?: string | null; } /** * Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` @@ -440,15 +440,15 @@ export namespace dlp_v2 { /** * The name of a Cloud Storage bucket. Required. */ - bucketName?: string; + bucketName?: string | null; /** * A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. */ - excludeRegex?: string[]; + excludeRegex?: string[] | null; /** * A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. */ - includeRegex?: string[]; + includeRegex?: string[] | null; } /** * Represents a color in the RGB color space. @@ -457,15 +457,15 @@ export namespace dlp_v2 { /** * The amount of blue in the color as a value in the interval [0, 1]. */ - blue?: number; + blue?: number | null; /** * The amount of green in the color as a value in the interval [0, 1]. */ - green?: number; + green?: number | null; /** * The amount of red in the color as a value in the interval [0, 1]. */ - red?: number; + red?: number | null; } /** * The field type of `value` and `field` do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A `value` of type: - `string` can be compared against all other types - `boolean` can only be compared against other booleans - `integer` can be compared against doubles or a string if the string value can be parsed as an integer. - `double` can be compared against integers or a string if the string can be parsed as a double. - `Timestamp` can be compared against strings in RFC 3339 date string format. - `TimeOfDay` can be compared against timestamps and strings in the format of 'HH:mm:ss'. If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false. @@ -478,7 +478,7 @@ export namespace dlp_v2 { /** * Operator used to compare the field or infoType to the value. [required] */ - operator?: string; + operator?: string | null; /** * Value to compare against. [Required, except for `EXISTS` tests.] */ @@ -505,7 +505,7 @@ export namespace dlp_v2 { /** * String data to inspect or redact. */ - value?: string; + value?: string | null; } /** * Findings container location data. @@ -514,15 +514,15 @@ export namespace dlp_v2 { /** * 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; + containerName?: string | null; /** * Findings container modification timestamp, if applicable. For Google Cloud Storage contains last file modification timestamp. For BigQuery table contains last_modified_time property. For Datastore - not populated. */ - containerTimestamp?: string; + containerTimestamp?: string | null; /** * Findings container version, if available ("generation" for Google Cloud Storage). */ - containerVersion?: string; + containerVersion?: string | null; /** * Location data for document files. */ @@ -547,7 +547,7 @@ export namespace dlp_v2 { /** * The template 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. */ - templateId?: string; + templateId?: string | null; } /** * Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage. @@ -557,7 +557,7 @@ export namespace dlp_v2 { /** * 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. */ - jobId?: string; + jobId?: string | null; riskJob?: Schema$GooglePrivacyDlpV2RiskAnalysisJobConfig; } /** @@ -571,7 +571,7 @@ export namespace dlp_v2 { /** * The template 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. */ - templateId?: string; + templateId?: string | null; } /** * Request message for CreateJobTrigger. @@ -584,7 +584,7 @@ export namespace dlp_v2 { /** * The trigger 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. */ - triggerId?: string; + triggerId?: string | null; } /** * Request message for CreateStoredInfoType. @@ -597,7 +597,7 @@ export namespace dlp_v2 { /** * The storedInfoType 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. */ - storedInfoTypeId?: string; + storedInfoTypeId?: string | null; } /** * Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297. @@ -637,7 +637,7 @@ export namespace dlp_v2 { * 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 { - commonAlphabet?: string; + 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 */ @@ -649,11 +649,11 @@ export namespace dlp_v2 { /** * This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 62]. This must be encoded as ASCII. The order of characters does not matter. */ - customAlphabet?: string; + customAlphabet?: string | null; /** * The native way to select the alphabet. Must be in the range [2, 62]. */ - radix?: number; + radix?: number | null; /** * The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType [`SurrogateType`](/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 */ @@ -674,7 +674,7 @@ export namespace dlp_v2 { /** * If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. */ - exclusionType?: string; + exclusionType?: string | null; /** * CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. */ @@ -682,7 +682,7 @@ export namespace dlp_v2 { /** * Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. */ - likelihood?: string; + likelihood?: string | null; /** * Regular expression based CustomInfoType. */ @@ -733,11 +733,11 @@ export namespace dlp_v2 { /** * For example, -5 means shift date to at most 5 days back in the past. [Required] */ - lowerBoundDays?: number; + 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] */ - upperBoundDays?: number; + upperBoundDays?: number | null; } /** * Message for a date time object. e.g. 2018-01-01, 5th August. @@ -747,7 +747,7 @@ export namespace dlp_v2 { * One or more of the following must be set. All fields are optional, but when set must be valid date or time values. */ date?: Schema$GoogleTypeDate; - dayOfWeek?: string; + dayOfWeek?: string | null; time?: Schema$GoogleTypeTimeOfDay; timeZone?: Schema$GooglePrivacyDlpV2TimeZone; } @@ -775,7 +775,7 @@ export namespace dlp_v2 { /** * 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. */ - deidentifyTemplateName?: string; + deidentifyTemplateName?: string | null; /** * Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument. */ @@ -783,7 +783,7 @@ export namespace dlp_v2 { /** * 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. */ - inspectTemplateName?: string; + inspectTemplateName?: string | null; /** * The item to de-identify. Will be treated as text. */ @@ -791,7 +791,7 @@ export namespace dlp_v2 { /** * The geographic location to process de-identification. Reserved for future extensions. */ - location?: string; + location?: string | null; } /** * Results of de-identifying a ContentItem. @@ -813,7 +813,7 @@ export namespace dlp_v2 { /** * The creation timestamp of a inspectTemplate, output only field. */ - createTime?: string; + createTime?: string | null; /** * ///////////// // The core content of the template // /////////////// */ @@ -821,19 +821,19 @@ export namespace dlp_v2 { /** * Short description (max 256 chars). */ - description?: string; + description?: string | null; /** * Display name (max 256 chars). */ - displayName?: string; + 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` */ - name?: string; + name?: string | null; /** * The last update timestamp of a inspectTemplate, output only field. */ - updateTime?: string; + updateTime?: string | null; } /** * δ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead. @@ -850,7 +850,7 @@ export namespace dlp_v2 { /** * 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. */ - regionCode?: string; + regionCode?: string | null; } /** * A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. @@ -859,11 +859,11 @@ export namespace dlp_v2 { /** * Number of records within these probability bounds. */ - bucketSize?: string; + bucketSize?: string | null; /** * Total number of distinct quasi-identifier tuple values in this bucket. */ - bucketValueCount?: string; + bucketValueCount?: string | null; /** * Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20. */ @@ -871,11 +871,11 @@ export namespace dlp_v2 { /** * Always greater than or equal to min_probability. */ - maxProbability?: number; + maxProbability?: number | null; /** * Between 0 and 1. */ - minProbability?: number; + minProbability?: number | null; } /** * A tuple of values for the quasi-identifier columns. @@ -884,7 +884,7 @@ export namespace dlp_v2 { /** * The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called δ, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside *and* outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then δ is 0.15. */ - estimatedProbability?: number; + estimatedProbability?: number | null; /** * The quasi-identifier values. */ @@ -928,11 +928,11 @@ export namespace dlp_v2 { /** * Time when the job was created. */ - createTime?: string; + createTime?: string | null; /** * Time when the job finished. */ - endTime?: string; + endTime?: string | null; /** * A stream of errors encountered running the job. */ @@ -944,11 +944,11 @@ export namespace dlp_v2 { /** * If created by a job trigger, the resource name of the trigger that instantiated the job. */ - jobTriggerName?: string; + jobTriggerName?: string | null; /** * The server-assigned name. */ - name?: string; + name?: string | null; /** * Results from analyzing risk of a data source. */ @@ -956,15 +956,15 @@ export namespace dlp_v2 { /** * Time when the job started. */ - startTime?: string; + startTime?: string | null; /** * State of a job. */ - state?: string; + state?: string | null; /** * The type of job. */ - type?: string; + type?: string | null; } /** * Location of a finding within a document. @@ -973,7 +973,7 @@ export namespace dlp_v2 { /** * Offset of the line, from the beginning of the file, where the finding is located. */ - fileOffset?: string; + fileOffset?: string | null; } /** * An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the `EntityId` might be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity. @@ -992,7 +992,7 @@ export namespace dlp_v2 { /** * The times the error occurred. */ - timestamps?: string[]; + timestamps?: string[] | null; } /** * List of exclude infoTypes. @@ -1018,7 +1018,7 @@ export namespace dlp_v2 { /** * How the rule is applied, see MatchingType documentation for details. */ - matchingType?: string; + matchingType?: string | null; /** * Regular expression which defines the rule. */ @@ -1032,7 +1032,7 @@ export namespace dlp_v2 { /** * The operator to apply to the result of conditions. Default and currently only supported value is `AND`. */ - logicalOperator?: string; + logicalOperator?: string | null; } /** * General identifier of a data field in a storage service. @@ -1041,7 +1041,7 @@ export namespace dlp_v2 { /** * Name describing the field. */ - name?: string; + name?: string | null; } /** * The transformation to apply to the field. @@ -1075,7 +1075,7 @@ export namespace dlp_v2 { /** * The Cloud Storage url of the file(s) to scan, in the format `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/x, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/x. Exactly one of `url` or `regex_file_set` must be set. */ - url?: string; + url?: string | null; } /** * Represents a piece of potentially sensitive content. @@ -1084,7 +1084,7 @@ export namespace dlp_v2 { /** * Timestamp when finding was detected. */ - createTime?: string; + createTime?: string | null; /** * The type of content that might have been found. Provided if `excluded_types` is false. */ @@ -1092,7 +1092,7 @@ export namespace dlp_v2 { /** * Confidence of how likely it is that the `info_type` is correct. */ - likelihood?: string; + likelihood?: string | null; /** * Where the content was found. */ @@ -1100,7 +1100,7 @@ export namespace dlp_v2 { /** * The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if `include_quote` is true and the finding is less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes in length, the quote may be omitted. */ - quote?: string; + quote?: string | null; /** * Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME. */ @@ -1114,11 +1114,11 @@ export namespace dlp_v2 { /** * Max number of findings that will be returned for each item scanned. When set within `InspectDataSourceRequest`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored. */ - maxFindingsPerItem?: number; + maxFindingsPerItem?: number | null; /** * Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher. */ - maxFindingsPerRequest?: number; + 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. @@ -1127,7 +1127,7 @@ export namespace dlp_v2 { /** * 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]. */ - bucketSize?: number; + 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]. */ @@ -1174,7 +1174,7 @@ export namespace dlp_v2 { /** * If true, all text found in the image, regardless whether it matches an info_type, is redacted. Only one should be provided. */ - redactAllText?: boolean; + redactAllText?: boolean | null; /** * The color to use when redacting content from an image. If not specified, the default is black. */ @@ -1187,7 +1187,7 @@ export namespace dlp_v2 { /** * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. InfoType names should conform to the pattern [a-zA-Z0-9_]{1,64}. */ - name?: string; + name?: string | null; } /** * InfoType description. @@ -1196,19 +1196,19 @@ export namespace dlp_v2 { /** * Description of the infotype. Translated when language is provided in the request. */ - description?: string; + description?: string | null; /** * Human readable form of the infoType name. */ - displayName?: string; + displayName?: string | null; /** * Internal name of the infoType. */ - name?: string; + name?: string | null; /** * Which parts of the API supports this InfoType. */ - supportedBy?: string[]; + supportedBy?: string[] | null; } /** * Max findings configuration per infoType, per content item or long running DlpJob. @@ -1221,7 +1221,7 @@ export namespace dlp_v2 { /** * Max findings limit for the given infoType. */ - maxFindings?: number; + maxFindings?: number | null; } /** * Statistics regarding a specific InfoType. @@ -1230,7 +1230,7 @@ export namespace dlp_v2 { /** * Number of findings for this infoType. */ - count?: string; + count?: string | null; /** * The type of finding this stat is for. */ @@ -1265,7 +1265,7 @@ export namespace dlp_v2 { /** * List of options defining data content to scan. If empty, text, images, and other content will be included. */ - contentOptions?: string[]; + contentOptions?: string[] | null; /** * CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. */ @@ -1273,11 +1273,11 @@ export namespace dlp_v2 { /** * When true, excludes type information of the findings. */ - excludeInfoTypes?: boolean; + excludeInfoTypes?: boolean | null; /** * When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. */ - includeQuote?: boolean; + includeQuote?: boolean | null; /** * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. The special InfoType name "ALL_BASIC" can be used to trigger all detectors, but may change over time as new InfoTypes are added. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference. */ @@ -1286,7 +1286,7 @@ export namespace dlp_v2 { /** * Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more. */ - minLikelihood?: string; + minLikelihood?: string | null; /** * Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. */ @@ -1303,7 +1303,7 @@ export namespace dlp_v2 { /** * 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. */ - inspectTemplateName?: string; + inspectTemplateName?: string | null; /** * The item to inspect. */ @@ -1311,7 +1311,7 @@ export namespace dlp_v2 { /** * The geographic location to process content inspection. Reserved for future extensions. */ - location?: string; + location?: string | null; } /** * Results of inspecting an item. @@ -1373,7 +1373,7 @@ export namespace dlp_v2 { /** * If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template. */ - inspectTemplateName?: string; + inspectTemplateName?: string | null; /** * The data to scan. */ @@ -1390,7 +1390,7 @@ export namespace dlp_v2 { /** * If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches. */ - findingsTruncated?: boolean; + findingsTruncated?: boolean | null; } /** * The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. @@ -1399,15 +1399,15 @@ export namespace dlp_v2 { /** * The creation timestamp of a inspectTemplate, output only field. */ - createTime?: string; + createTime?: string | null; /** * Short description (max 256 chars). */ - description?: string; + description?: string | null; /** * Display name (max 256 chars). */ - displayName?: string; + displayName?: string | null; /** * The core content of the template. Configuration of the scanning process. */ @@ -1415,11 +1415,11 @@ export namespace dlp_v2 { /** * 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` */ - name?: string; + name?: string | null; /** * The last update timestamp of a inspectTemplate, output only field. */ - updateTime?: string; + updateTime?: string | null; } /** * Enable email notification to project owners and editors on jobs's completion/failure. @@ -1432,15 +1432,15 @@ export namespace dlp_v2 { /** * The creation timestamp of a triggeredJob, output only field. */ - createTime?: string; + createTime?: string | null; /** * User provided description (max 256 chars) */ - description?: string; + description?: string | null; /** * Display name (max 100 chars) */ - displayName?: string; + 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. */ @@ -1449,15 +1449,15 @@ export namespace dlp_v2 { /** * The timestamp of the last time this trigger executed, output only field. */ - lastRunTime?: string; + lastRunTime?: string | null; /** * Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. */ - name?: string; + name?: string | null; /** * A status for this trigger. [required] */ - status?: string; + status?: string | null; /** * A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. */ @@ -1465,7 +1465,7 @@ export namespace dlp_v2 { /** * The last update timestamp of a triggeredJob, output only field. */ - updateTime?: string; + updateTime?: string | null; } /** * k-anonymity metric, used for analysis of reidentification risk. @@ -1487,7 +1487,7 @@ export namespace dlp_v2 { /** * Size of the equivalence class, for example number of rows with the above set of values. */ - equivalenceClassSize?: string; + equivalenceClassSize?: string | null; /** * Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request. */ @@ -1497,11 +1497,11 @@ export namespace dlp_v2 { /** * Total number of equivalence classes in this bucket. */ - bucketSize?: string; + bucketSize?: string | null; /** * Total number of distinct equivalence classes in this bucket. */ - bucketValueCount?: string; + bucketValueCount?: string | null; /** * Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20. */ @@ -1509,11 +1509,11 @@ export namespace dlp_v2 { /** * Lower bound on the size of the equivalence classes in this bucket. */ - equivalenceClassSizeLowerBound?: string; + equivalenceClassSizeLowerBound?: string | null; /** * Upper bound on the size of the equivalence classes in this bucket. */ - equivalenceClassSizeUpperBound?: string; + equivalenceClassSizeUpperBound?: string | null; } /** * Result of the k-anonymity computation. @@ -1544,7 +1544,7 @@ export namespace dlp_v2 { /** * The name of the kind. */ - name?: string; + 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. @@ -1561,7 +1561,7 @@ export namespace dlp_v2 { /** * 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. */ - regionCode?: string; + regionCode?: string | null; } /** * A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. @@ -1570,11 +1570,11 @@ export namespace dlp_v2 { /** * Number of records within these anonymity bounds. */ - bucketSize?: string; + bucketSize?: string | null; /** * Total number of distinct quasi-identifier tuple values in this bucket. */ - bucketValueCount?: string; + bucketValueCount?: string | null; /** * Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20. */ @@ -1582,11 +1582,11 @@ export namespace dlp_v2 { /** * Always greater than or equal to min_anonymity. */ - maxAnonymity?: string; + maxAnonymity?: string | null; /** * Always positive. */ - minAnonymity?: string; + minAnonymity?: string | null; } /** * A tuple of values for the quasi-identifier columns. @@ -1595,7 +1595,7 @@ export namespace dlp_v2 { /** * The estimated anonymity for these quasi-identifier values. */ - estimatedAnonymity?: string; + estimatedAnonymity?: string | null; /** * The quasi-identifier values. */ @@ -1617,11 +1617,11 @@ export namespace dlp_v2 { /** * The resource name of the KMS CryptoKey to use for unwrapping. [required] */ - cryptoKeyName?: string; + cryptoKeyName?: string | null; /** * The wrapped data crypto key. [required] */ - wrappedKey?: string; + wrappedKey?: string | null; } /** * Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. @@ -1647,7 +1647,7 @@ export namespace dlp_v2 { /** * Approximate number of distinct phrases in the dictionary. */ - approxNumPhrases?: string; + approxNumPhrases?: string | null; } /** * l-diversity metric, used for analysis of reidentification risk. @@ -1669,11 +1669,11 @@ export namespace dlp_v2 { /** * Size of the k-anonymity equivalence class. */ - equivalenceClassSize?: string; + equivalenceClassSize?: string | null; /** * Number of distinct sensitive values in this equivalence class. */ - numDistinctSensitiveValues?: string; + numDistinctSensitiveValues?: string | null; /** * Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request. */ @@ -1687,11 +1687,11 @@ export namespace dlp_v2 { /** * Total number of equivalence classes in this bucket. */ - bucketSize?: string; + bucketSize?: string | null; /** * Total number of distinct equivalence classes in this bucket. */ - bucketValueCount?: string; + bucketValueCount?: string | null; /** * Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20. */ @@ -1699,11 +1699,11 @@ export namespace dlp_v2 { /** * Lower bound on the sensitive value frequencies of the equivalence classes in this bucket. */ - sensitiveValueFrequencyLowerBound?: string; + sensitiveValueFrequencyLowerBound?: string | null; /** * Upper bound on the sensitive value frequencies of the equivalence classes in this bucket. */ - sensitiveValueFrequencyUpperBound?: string; + sensitiveValueFrequencyUpperBound?: string | null; } /** * Result of the l-diversity computation. @@ -1721,11 +1721,11 @@ export namespace dlp_v2 { /** * Set the likelihood of a finding to a fixed value. */ - fixedLikelihood?: string; + fixedLikelihood?: string | null; /** * Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. */ - relativeLikelihood?: number; + relativeLikelihood?: number | null; } /** * Response message for ListDeidentifyTemplates. @@ -1738,7 +1738,7 @@ export namespace dlp_v2 { /** * If the next page is available then the next page token to be used in following ListDeidentifyTemplates request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for listing DLP jobs. @@ -1751,7 +1751,7 @@ export namespace dlp_v2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Request for the list of infoTypes. @@ -1760,11 +1760,11 @@ export namespace dlp_v2 { /** * Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. */ - filter?: string; + filter?: string | null; /** * Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. */ - languageCode?: string; + languageCode?: string | null; } /** * Response to the ListInfoTypes request. @@ -1786,7 +1786,7 @@ export namespace dlp_v2 { /** * If the next page is available then the next page token to be used in following ListInspectTemplates request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for ListJobTriggers. @@ -1799,7 +1799,7 @@ export namespace dlp_v2 { /** * If the next page is available then the next page token to be used in following ListJobTriggers request. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for ListStoredInfoTypes. @@ -1808,7 +1808,7 @@ export namespace dlp_v2 { /** * If the next page is available then the next page token to be used in following ListStoredInfoTypes request. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. */ @@ -1864,7 +1864,7 @@ export namespace dlp_v2 { /** * Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. */ - outputSchema?: string; + outputSchema?: string | null; /** * Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. */ @@ -1877,11 +1877,11 @@ export namespace dlp_v2 { /** * If not empty, the ID of the namespace to which the entities belong. */ - namespaceId?: string; + namespaceId?: string | null; /** * The ID of the project to which the entities belong. */ - projectId?: string; + projectId?: string | null; } /** * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. @@ -1890,15 +1890,15 @@ export namespace dlp_v2 { /** * The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. */ - id?: string; + id?: string | null; /** * The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ - kind?: string; + kind?: string | null; /** * The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ - name?: string; + name?: string | null; } /** * A rule for transforming a value. @@ -1934,11 +1934,11 @@ export namespace dlp_v2 { /** * Number of characters after the finding to consider. */ - windowAfter?: number; + windowAfter?: number | null; /** * Number of characters before the finding to consider. */ - windowBefore?: number; + windowBefore?: number | null; } /** * Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect @@ -1955,7 +1955,7 @@ export namespace dlp_v2 { /** * Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. */ - topic?: string; + topic?: string | null; } /** * A column with a semantic tag attached. @@ -1964,7 +1964,7 @@ export namespace dlp_v2 { /** * 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; + customTag?: string | null; /** * Identifies the column. [required] */ @@ -1982,14 +1982,14 @@ 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 { - customTag?: string; + customTag?: string | null; 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 { - customTag?: string; + customTag?: string | null; field?: Schema$GooglePrivacyDlpV2FieldId; } /** @@ -2008,11 +2008,11 @@ export namespace dlp_v2 { /** * Index of the last character of the range (exclusive). */ - end?: string; + end?: string | null; /** * Index of the first character of the range (inclusive). */ - start?: string; + start?: string | null; } /** * A condition for determining whether a transformation should be applied to a field. @@ -2032,7 +2032,7 @@ export namespace dlp_v2 { /** * Values of identifying columns in the given row. Order of values matches the order of field identifiers specified in the scanning request. */ - idValues?: string[]; + idValues?: string[] | null; } /** * Location of a finding within a row or record. @@ -2092,7 +2092,7 @@ export namespace dlp_v2 { /** * Whether the response should include findings along with the redacted image. */ - includeFindings?: boolean; + includeFindings?: boolean | null; /** * Configuration for the inspector. */ @@ -2105,7 +2105,7 @@ export namespace dlp_v2 { /** * If an image was being inspected and the InspectConfig's include_quote was set to true, then this field will include all text, if any, that was found in the image. */ - extractedText?: string; + extractedText?: string | null; /** * The findings. Populated when include_findings in the request is true. */ @@ -2113,7 +2113,7 @@ export namespace dlp_v2 { /** * The redacted image. The type will be the same as the original image. */ - redactedImage?: string; + redactedImage?: string | null; } /** * Message defining a custom regular expression. @@ -2122,11 +2122,11 @@ export namespace dlp_v2 { /** * The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. */ - groupIndexes?: number[]; + groupIndexes?: number[] | null; /** * Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. */ - pattern?: string; + pattern?: string | null; } /** * Request to re-identify an item. @@ -2139,7 +2139,7 @@ export namespace dlp_v2 { /** * 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. */ - inspectTemplateName?: string; + inspectTemplateName?: string | null; /** * The item to re-identify. Will be treated as text. */ @@ -2147,7 +2147,7 @@ export namespace dlp_v2 { /** * The geographic location to process content reidentification. Reserved for future extensions. */ - location?: string; + location?: string | null; /** * Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoReplaceFfxFpeConfig` */ @@ -2155,7 +2155,7 @@ export namespace dlp_v2 { /** * 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. */ - reidentifyTemplateName?: string; + reidentifyTemplateName?: string | null; } /** * Results of re-identifying a item. @@ -2201,11 +2201,11 @@ export namespace dlp_v2 { /** * Total size in bytes that were processed. */ - processedBytes?: string; + processedBytes?: string | null; /** * Estimate of the number of bytes to process. */ - totalEstimatedBytes?: string; + totalEstimatedBytes?: string | null; } /** * Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more. @@ -2240,7 +2240,7 @@ export namespace dlp_v2 { /** * With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days. */ - recurrencePeriodDuration?: string; + recurrencePeriodDuration?: string | null; } /** * An auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable). @@ -2288,7 +2288,7 @@ export namespace dlp_v2 { /** * Resource name. */ - name?: string; + name?: string | null; /** * Pending versions of the stored info type. Empty if no versions are pending. */ @@ -2301,11 +2301,11 @@ export namespace dlp_v2 { /** * Description of the StoredInfoType (max 256 characters). */ - description?: string; + description?: string | null; /** * Display name of the StoredInfoType (max 256 characters). */ - displayName?: string; + displayName?: string | null; /** * StoredInfoType where findings are defined by a dictionary of phrases. */ @@ -2331,7 +2331,7 @@ export namespace dlp_v2 { /** * Create timestamp of the version. Read-only, determined by the system when the version is created. */ - createTime?: string; + 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. */ @@ -2339,7 +2339,7 @@ export namespace dlp_v2 { /** * Stored info type version state. Read-only, updated by the system during dictionary creation. */ - state?: string; + state?: string | null; /** * Statistics about this storedInfoType version. */ @@ -2352,22 +2352,22 @@ export namespace dlp_v2 { /** * Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. */ - createTime?: string; + createTime?: string | null; /** * Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. */ - name?: string; + name?: string | null; } /** * A collection that informs the user the number of times a particular `TransformationResultCode` and error details occurred. */ export interface Schema$GooglePrivacyDlpV2SummaryResult { - code?: string; - count?: string; + code?: string | null; + count?: string | null; /** * A place for warnings or errors to show up if a transformation didn't work as expected. */ - details?: string; + details?: string | null; } /** * Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. @@ -2387,13 +2387,13 @@ export namespace dlp_v2 { /** * The zero-based index of the row where the finding is located. */ - rowIndex?: string; + rowIndex?: string | null; } 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; + customTag?: string | null; /** * Identifies the column. [required] */ @@ -2411,7 +2411,7 @@ export namespace dlp_v2 { * For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a portion of the value. */ export interface Schema$GooglePrivacyDlpV2TimePartConfig { - partToExtract?: string; + partToExtract?: string | null; } /** * Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery. @@ -2420,15 +2420,15 @@ export namespace dlp_v2 { /** * When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger. */ - enableAutoPopulationOfTimespanConfig?: boolean; + enableAutoPopulationOfTimespanConfig?: boolean | null; /** * Exclude files or rows newer than this value. If set to zero, no upper time limit is applied. */ - endTime?: string; + endTime?: string | null; /** * Exclude files or rows older than this value. */ - startTime?: string; + startTime?: string | null; /** * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore or BigQuery. If not specified for BigQuery, table last modification timestamp is checked against given time span. The valid data types of the timestamp field are: for BigQuery - timestamp, date, datetime; for Datastore - timestamp. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid. */ @@ -2438,7 +2438,7 @@ export namespace dlp_v2 { /** * 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; + offsetMinutes?: number | null; } /** * Overview of the modifications that occurred. @@ -2451,7 +2451,7 @@ export namespace dlp_v2 { /** * Total size in bytes that were transformed in some way. */ - transformedBytes?: string; + transformedBytes?: string | null; } /** * Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set. @@ -2481,7 +2481,7 @@ export namespace dlp_v2 { /** * Total size in bytes that were transformed in some way. */ - transformedBytes?: string; + transformedBytes?: string | null; } /** * Use this to have a random data crypto key generated. It will be discarded after the request finishes. @@ -2490,7 +2490,7 @@ export namespace dlp_v2 { /** * 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). */ - name?: string; + name?: string | null; } /** * What event needs to occur for a new job to be started. @@ -2508,7 +2508,7 @@ export namespace dlp_v2 { /** * A 128/192/256 bit key. [required] */ - key?: string; + key?: string | null; } /** * Request message for UpdateDeidentifyTemplate. @@ -2521,7 +2521,7 @@ export namespace dlp_v2 { /** * Mask to control which fields get updated. */ - updateMask?: string; + updateMask?: string | null; } /** * Request message for UpdateInspectTemplate. @@ -2534,7 +2534,7 @@ export namespace dlp_v2 { /** * Mask to control which fields get updated. */ - updateMask?: string; + updateMask?: string | null; } /** * Request message for UpdateJobTrigger. @@ -2547,7 +2547,7 @@ export namespace dlp_v2 { /** * Mask to control which fields get updated. */ - updateMask?: string; + updateMask?: string | null; } /** * Request message for UpdateStoredInfoType. @@ -2560,19 +2560,19 @@ export namespace dlp_v2 { /** * Mask to control which fields get updated. */ - updateMask?: string; + updateMask?: string | null; } /** * 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 { - booleanValue?: boolean; + booleanValue?: boolean | null; dateValue?: Schema$GoogleTypeDate; - dayOfWeekValue?: string; - floatValue?: number; - integerValue?: string; - stringValue?: string; - timestampValue?: string; + dayOfWeekValue?: string | null; + floatValue?: number | null; + integerValue?: string | null; + stringValue?: string | null; + timestampValue?: string | null; timeValue?: Schema$GoogleTypeTimeOfDay; } /** @@ -2582,7 +2582,7 @@ export namespace dlp_v2 { /** * How many times the value is contained in the field. */ - count?: string; + count?: string | null; /** * A value contained in the field in question. */ @@ -2595,7 +2595,7 @@ export namespace dlp_v2 { /** * Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] */ - words?: string[]; + words?: 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 `{}`. @@ -2608,15 +2608,15 @@ export namespace dlp_v2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. @@ -2625,15 +2625,15 @@ export namespace dlp_v2 { /** * 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; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. @@ -2642,19 +2642,19 @@ export namespace dlp_v2 { /** * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ - hours?: number; + hours?: number | null; /** * Minutes of hour of day. Must be from 0 to 59. */ - minutes?: number; + minutes?: number | null; /** * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ - nanos?: number; + nanos?: number | null; /** * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ - seconds?: number; + seconds?: number | null; } export class Resource$Infotypes { diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index fc8b226af7f..77b12387b8e 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -93,6 +93,7 @@ export namespace dns_v1 { dnsKeys: Resource$Dnskeys; managedZoneOperations: Resource$Managedzoneoperations; managedZones: Resource$Managedzones; + policies: Resource$Policies; projects: Resource$Projects; resourceRecordSets: Resource$Resourcerecordsets; @@ -108,6 +109,7 @@ export namespace dns_v1 { this.context ); this.managedZones = new Resource$Managedzones(this.context); + this.policies = new Resource$Policies(this.context); this.projects = new Resource$Projects(this.context); this.resourceRecordSets = new Resource$Resourcerecordsets(this.context); } @@ -128,23 +130,23 @@ export namespace dns_v1 { /** * Unique identifier for the resource; defined by the server (output only). */ - id?: string; + id?: string | null; /** * If the DNS queries for the zone will be served. */ - isServing?: boolean; + isServing?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#change". */ - kind?: string; + kind?: string | null; /** * The time that this operation was started by the server (output only). This is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ - status?: string; + status?: string | null; } /** * The response to a request to enumerate Changes to a ResourceRecordSets collection. @@ -158,11 +160,11 @@ export namespace dns_v1 { /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A DNSSEC key pair. @@ -171,15 +173,15 @@ export namespace dns_v1 { /** * String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. */ - algorithm?: string; + algorithm?: string | null; /** * The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. */ - creationTime?: string; + creationTime?: string | null; /** * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. */ - description?: string; + description?: string | null; /** * Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. */ @@ -187,41 +189,41 @@ export namespace dns_v1 { /** * Unique identifier for the resource; defined by the server (output only). */ - id?: string; + id?: string | null; /** * Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. */ - isActive?: boolean; + isActive?: boolean | null; /** * Length of the key in bits. Specified at creation time then immutable. */ - keyLength?: number; + keyLength?: number | null; /** * The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. */ - keyTag?: number; + keyTag?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". */ - kind?: string; + kind?: string | null; /** * Base64 encoded public half of this key. Output only. */ - publicKey?: string; + publicKey?: string | null; /** * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. */ - type?: string; + type?: string | null; } export interface Schema$DnsKeyDigest { /** * The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. */ - digest?: string; + digest?: string | null; /** * Specifies the algorithm used to calculate this digest. */ - type?: string; + type?: string | null; } /** * The response to a request to enumerate DnsKeys in a ManagedZone. @@ -235,11 +237,11 @@ export namespace dns_v1 { /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. @@ -248,19 +250,19 @@ export namespace dns_v1 { /** * String mnemonic specifying the DNSSEC algorithm of this key. */ - algorithm?: string; + algorithm?: string | null; /** * Length of the keys in bits. */ - keyLength?: number; + keyLength?: number | null; /** * Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. */ - keyType?: string; + keyType?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". */ - kind?: string; + kind?: string | null; } /** * A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. @@ -269,43 +271,47 @@ export namespace dns_v1 { /** * The time that this resource was created on the server. This is in RFC3339 text format. Output only. */ - creationTime?: string; + creationTime?: string | null; /** * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. */ - description?: string; + description?: string | null; /** * The DNS name of this managed zone, for instance "example.com.". */ - dnsName?: string; + dnsName?: string | null; /** * DNSSEC configuration. */ dnssecConfig?: Schema$ManagedZoneDnsSecConfig; + /** + * The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. + */ + forwardingConfig?: Schema$ManagedZoneForwardingConfig; /** * Unique identifier for the resource; defined by the server (output only) */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". */ - kind?: string; + kind?: string | null; /** * User labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. */ - name?: string; + name?: string | null; /** * Delegate your managed_zone to these virtual name servers; defined by the server (output only) */ - nameServers?: string[]; + nameServers?: string[] | null; /** * 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; + nameServerSet?: string | null; /** * For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. */ @@ -313,36 +319,56 @@ export namespace dns_v1 { /** * The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. */ - visibility?: string; + visibility?: string | null; } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Can only be changed while state is OFF. + * Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". */ - kind?: string; + kind?: string | null; /** - * Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF. + * Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. */ - nonExistence?: string; + nonExistence?: string | null; /** * Specifies whether DNSSEC is enabled, and what mode it is in. */ - state?: string; + state?: string | null; + } + export interface Schema$ManagedZoneForwardingConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". + */ + kind?: string | null; + /** + * List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. + */ + targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[]; + } + export interface Schema$ManagedZoneForwardingConfigNameServerTarget { + /** + * IPv4 address of a target name server. + */ + ipv4Address?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". + */ + kind?: string | null; } export interface Schema$ManagedZoneOperationsListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The operation resources. */ @@ -352,7 +378,7 @@ export namespace dns_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". */ - kind?: string; + kind?: string | null; /** * The list of VPC networks that can see this zone. */ @@ -362,18 +388,18 @@ export namespace dns_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". */ - kind?: string; + kind?: string | null; /** * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ - networkUrl?: string; + networkUrl?: string | null; } export interface Schema$ManagedZonesListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The managed zone resources. */ @@ -381,7 +407,7 @@ export namespace dns_v1 { /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. @@ -394,27 +420,27 @@ export namespace dns_v1 { /** * Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#operation". */ - kind?: string; + kind?: string | null; /** * The time that this operation was started by the server. This is in RFC3339 text format (output only). */ - startTime?: string; + startTime?: string | null; /** * Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ - status?: string; + status?: string | null; /** * Type of the operation. Operations include insert, update, and delete (output only). */ - type?: string; + type?: string | null; /** * User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) */ - user?: string; + user?: string | null; /** * Only populated if the operation targeted a ManagedZone (output only). */ @@ -440,6 +466,92 @@ export namespace dns_v1 { */ oldValue?: Schema$ManagedZone; } + export interface Schema$PoliciesListResponse { + header?: Schema$ResponseHeader; + /** + * Type of resource. + */ + kind?: string | null; + /** + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. + */ + nextPageToken?: string | null; + /** + * The policy resources. + */ + policies?: Schema$Policy[]; + } + export interface Schema$PoliciesPatchResponse { + header?: Schema$ResponseHeader; + policy?: Schema$Policy; + } + export interface Schema$PoliciesUpdateResponse { + header?: Schema$ResponseHeader; + policy?: Schema$Policy; + } + /** + * A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. + */ + export interface Schema$Policy { + /** + * Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. + */ + alternativeNameServerConfig?: Schema$PolicyAlternativeNameServerConfig; + /** + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. + */ + description?: string | null; + /** + * Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy. + */ + enableInboundForwarding?: boolean | null; + /** + * Unique identifier for the resource; defined by the server (output only). + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policy". + */ + kind?: string | null; + /** + * User assigned name for this policy. + */ + name?: string | null; + /** + * List of network names specifying networks to which this policy is applied. + */ + networks?: Schema$PolicyNetwork[]; + } + export interface Schema$PolicyAlternativeNameServerConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig". + */ + kind?: string | null; + /** + * Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. + */ + targetNameServers?: Schema$PolicyAlternativeNameServerConfigTargetNameServer[]; + } + export interface Schema$PolicyAlternativeNameServerConfigTargetNameServer { + /** + * IPv4 address to forward to. + */ + ipv4Address?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer". + */ + kind?: string | null; + } + export interface Schema$PolicyNetwork { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork". + */ + kind?: string | null; + /** + * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ + networkUrl?: string | null; + } /** * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. */ @@ -447,15 +559,15 @@ export namespace dns_v1 { /** * User assigned unique identifier for the resource (output only). */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#project". */ - kind?: string; + kind?: string | null; /** * Unique numeric identifier for the resource; defined by the server (output only). */ - number?: string; + number?: string | null; /** * Quotas assigned to this project (output only). */ @@ -468,43 +580,59 @@ export namespace dns_v1 { /** * Maximum allowed number of DnsKeys per ManagedZone. */ - dnsKeysPerManagedZone?: number; + dnsKeysPerManagedZone?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#quota". */ - kind?: string; + kind?: string | null; /** * Maximum allowed number of managed zones in the project. */ - managedZones?: number; + managedZones?: number | null; /** * Maximum allowed number of managed zones which can be attached to a network. */ - managedZonesPerNetwork?: number; + managedZonesPerNetwork?: number | null; /** * Maximum allowed number of networks to which a privately scoped zone can be attached. */ - networksPerManagedZone?: number; + networksPerManagedZone?: number | null; + /** + * Maximum allowed number of networks per policy. + */ + networksPerPolicy?: number | null; + /** + * Maximum allowed number of policies per project. + */ + policies?: number | null; /** * Maximum allowed number of ResourceRecords per ResourceRecordSet. */ - resourceRecordsPerRrset?: number; + resourceRecordsPerRrset?: number | null; /** * Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. */ - rrsetAdditionsPerChange?: number; + rrsetAdditionsPerChange?: number | null; /** * Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest. */ - rrsetDeletionsPerChange?: number; + rrsetDeletionsPerChange?: number | null; /** * Maximum allowed number of ResourceRecordSets per zone in the project. */ - rrsetsPerManagedZone?: number; + rrsetsPerManagedZone?: number | null; + /** + * Maximum allowed number of target name servers per managed forwarding zone. + */ + targetNameServersPerManagedZone?: number | null; + /** + * Maximum allowed number of alternative target name servers per policy. + */ + targetNameServersPerPolicy?: number | null; /** * Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. */ - totalRrdataSizePerChange?: number; + totalRrdataSizePerChange?: number | null; /** * DNSSEC algorithm and key length types that can be used for DnsKeys. */ @@ -517,38 +645,38 @@ export namespace dns_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet". */ - kind?: string; + kind?: string | null; /** * For example, www.example.com. */ - name?: string; + name?: string | null; /** * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. */ - rrdatas?: string[]; + rrdatas?: string[] | null; /** * As defined in RFC 4034 (section 3.2). */ - signatureRrdatas?: string[]; + signatureRrdatas?: string[] | null; /** * Number of seconds that this ResourceRecordSet can be cached by resolvers. */ - ttl?: number; + ttl?: number | null; /** * The identifier of a supported record type. See the list of Supported DNS record types. */ - type?: string; + type?: string | null; } export interface Schema$ResourceRecordSetsListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The resource record set resources. */ @@ -561,7 +689,7 @@ export namespace dns_v1 { /** * For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). */ - operationId?: string; + operationId?: string | null; } export class Resource$Changes { @@ -2309,6 +2437,587 @@ export namespace dns_v1 { requestBody?: Schema$ManagedZone; } + export class Resource$Policies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dns.policies.create + * @desc Create a new Policy + * @alias dns.policies.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Policies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Policies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Policies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Policies$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dns/v1/projects/{project}/policies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.delete + * @desc Delete a previously created Policy. Will fail if the policy is still being referenced by a network. + * @alias dns.policies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Policies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Policies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Policies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Policies$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.get + * @desc Fetch the representation of an existing Policy. + * @alias dns.policies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + 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://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.list + * @desc Enumerate all Policies associated with a project. + * @alias dns.policies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Policies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Policies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Policies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Policies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dns/v1/projects/{project}/policies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.patch + * @desc Apply a partial update to an existing Policy. + * @alias dns.policies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Policies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Policies$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Policies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Policies$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.update + * @desc Update an existing Policy. + * @alias dns.policies.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Policies$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Policies$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Policies$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Policies$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Policies$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + */ + maxResults?: number; + /** + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + */ + pageToken?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 4003185b4b0..1043fe6618b 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -130,23 +130,23 @@ export namespace dns_v1beta2 { /** * Unique identifier for the resource; defined by the server (output only). */ - id?: string; + id?: string | null; /** * If the DNS queries for the zone will be served. */ - isServing?: boolean; + isServing?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#change". */ - kind?: string; + kind?: string | null; /** * The time that this operation was started by the server (output only). This is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ - status?: string; + status?: string | null; } /** * The response to a request to enumerate Changes to a ResourceRecordSets collection. @@ -160,11 +160,11 @@ export namespace dns_v1beta2 { /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A DNSSEC key pair. @@ -173,15 +173,15 @@ export namespace dns_v1beta2 { /** * String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. */ - algorithm?: string; + algorithm?: string | null; /** * The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. */ - creationTime?: string; + creationTime?: string | null; /** * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. */ - description?: string; + description?: string | null; /** * Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. */ @@ -189,41 +189,41 @@ export namespace dns_v1beta2 { /** * Unique identifier for the resource; defined by the server (output only). */ - id?: string; + id?: string | null; /** * Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. */ - isActive?: boolean; + isActive?: boolean | null; /** * Length of the key in bits. Specified at creation time then immutable. */ - keyLength?: number; + keyLength?: number | null; /** * The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. */ - keyTag?: number; + keyTag?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". */ - kind?: string; + kind?: string | null; /** * Base64 encoded public half of this key. Output only. */ - publicKey?: string; + publicKey?: string | null; /** * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. */ - type?: string; + type?: string | null; } export interface Schema$DnsKeyDigest { /** * The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. */ - digest?: string; + digest?: string | null; /** * Specifies the algorithm used to calculate this digest. */ - type?: string; + type?: string | null; } /** * The response to a request to enumerate DnsKeys in a ManagedZone. @@ -237,11 +237,11 @@ export namespace dns_v1beta2 { /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. @@ -250,19 +250,19 @@ export namespace dns_v1beta2 { /** * String mnemonic specifying the DNSSEC algorithm of this key. */ - algorithm?: string; + algorithm?: string | null; /** * Length of the keys in bits. */ - keyLength?: number; + keyLength?: number | null; /** * Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. */ - keyType?: string; + keyType?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". */ - kind?: string; + kind?: string | null; } /** * A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. @@ -271,15 +271,15 @@ export namespace dns_v1beta2 { /** * The time that this resource was created on the server. This is in RFC3339 text format. Output only. */ - creationTime?: string; + creationTime?: string | null; /** * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. */ - description?: string; + description?: string | null; /** * The DNS name of this managed zone, for instance "example.com.". */ - dnsName?: string; + dnsName?: string | null; /** * DNSSEC configuration. */ @@ -291,27 +291,27 @@ export namespace dns_v1beta2 { /** * Unique identifier for the resource; defined by the server (output only) */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". */ - kind?: string; + kind?: string | null; /** * User labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. */ - name?: string; + name?: string | null; /** * Delegate your managed_zone to these virtual name servers; defined by the server (output only) */ - nameServers?: string[]; + nameServers?: string[] | null; /** * 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; + 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. */ @@ -323,31 +323,31 @@ export namespace dns_v1beta2 { /** * The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. */ - visibility?: string; + visibility?: string | null; } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Can only be changed while state is OFF. + * Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". */ - kind?: string; + kind?: string | null; /** - * Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF. + * Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. */ - nonExistence?: string; + nonExistence?: string | null; /** * Specifies whether DNSSEC is enabled, and what mode it is in. */ - state?: string; + state?: string | null; } export interface Schema$ManagedZoneForwardingConfig { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". */ - kind?: string; + kind?: string | null; /** * List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. */ @@ -357,22 +357,22 @@ export namespace dns_v1beta2 { /** * IPv4 address of a target name server. */ - ipv4Address?: string; + ipv4Address?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". */ - kind?: string; + kind?: string | null; } export interface Schema$ManagedZoneOperationsListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The operation resources. */ @@ -382,7 +382,7 @@ export namespace dns_v1beta2 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". */ - kind?: string; + kind?: string | null; /** * The network with which to peer. */ @@ -390,23 +390,23 @@ export namespace dns_v1beta2 { } export interface Schema$ManagedZonePeeringConfigTargetNetwork { /** - * If this zone has been deactivated (possibly because the producer network it targeted was deleted), the time at which it was deactivated. If the peering connection is still active, this will be the empty string. This is in RFC3339 text format. Output only. + * 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; + deactivateTime?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". */ - kind?: string; + 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; + networkUrl?: string | null; } export interface Schema$ManagedZonePrivateVisibilityConfig { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". */ - kind?: string; + kind?: string | null; /** * The list of VPC networks that can see this zone. */ @@ -416,18 +416,18 @@ export namespace dns_v1beta2 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". */ - kind?: string; + kind?: string | null; /** * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ - networkUrl?: string; + networkUrl?: string | null; } export interface Schema$ManagedZonesListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The managed zone resources. */ @@ -435,7 +435,7 @@ export namespace dns_v1beta2 { /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. @@ -448,27 +448,27 @@ export namespace dns_v1beta2 { /** * Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#operation". */ - kind?: string; + kind?: string | null; /** * The time that this operation was started by the server. This is in RFC3339 text format (output only). */ - startTime?: string; + startTime?: string | null; /** * Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ - status?: string; + status?: string | null; /** * Type of the operation. Operations include insert, update, and delete (output only). */ - type?: string; + type?: string | null; /** * User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) */ - user?: string; + user?: string | null; /** * Only populated if the operation targeted a ManagedZone (output only). */ @@ -499,11 +499,11 @@ export namespace dns_v1beta2 { /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The policy resources. */ @@ -528,27 +528,27 @@ export namespace dns_v1beta2 { /** * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. */ - description?: string; + description?: string | null; /** * Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy. */ - enableInboundForwarding?: boolean; + enableInboundForwarding?: boolean | null; /** * Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. */ - enableLogging?: boolean; + enableLogging?: boolean | null; /** * Unique identifier for the resource; defined by the server (output only). */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#policy". */ - kind?: string; + kind?: string | null; /** * User assigned name for this policy. */ - name?: string; + name?: string | null; /** * List of network names specifying networks to which this policy is applied. */ @@ -558,7 +558,7 @@ export namespace dns_v1beta2 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig". */ - kind?: string; + kind?: string | null; /** * Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. */ @@ -568,21 +568,21 @@ export namespace dns_v1beta2 { /** * IPv4 address to forward to. */ - ipv4Address?: string; + ipv4Address?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer". */ - kind?: string; + kind?: string | null; } export interface Schema$PolicyNetwork { /** * Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork". */ - kind?: string; + kind?: string | null; /** * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ - networkUrl?: string; + networkUrl?: string | null; } /** * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. @@ -591,15 +591,15 @@ export namespace dns_v1beta2 { /** * User assigned unique identifier for the resource (output only). */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#project". */ - kind?: string; + kind?: string | null; /** * Unique numeric identifier for the resource; defined by the server (output only). */ - number?: string; + number?: string | null; /** * Quotas assigned to this project (output only). */ @@ -612,59 +612,59 @@ export namespace dns_v1beta2 { /** * Maximum allowed number of DnsKeys per ManagedZone. */ - dnsKeysPerManagedZone?: number; + dnsKeysPerManagedZone?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#quota". */ - kind?: string; + kind?: string | null; /** * Maximum allowed number of managed zones in the project. */ - managedZones?: number; + managedZones?: number | null; /** * Maximum allowed number of managed zones which can be attached to a network. */ - managedZonesPerNetwork?: number; + managedZonesPerNetwork?: number | null; /** * Maximum allowed number of networks to which a privately scoped zone can be attached. */ - networksPerManagedZone?: number; + networksPerManagedZone?: number | null; /** * Maximum allowed number of networks per policy. */ - networksPerPolicy?: number; + networksPerPolicy?: number | null; /** * Maximum allowed number of policies per project. */ - policies?: number; + policies?: number | null; /** * Maximum allowed number of ResourceRecords per ResourceRecordSet. */ - resourceRecordsPerRrset?: number; + resourceRecordsPerRrset?: number | null; /** * Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. */ - rrsetAdditionsPerChange?: number; + rrsetAdditionsPerChange?: number | null; /** * Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest. */ - rrsetDeletionsPerChange?: number; + rrsetDeletionsPerChange?: number | null; /** * Maximum allowed number of ResourceRecordSets per zone in the project. */ - rrsetsPerManagedZone?: number; + rrsetsPerManagedZone?: number | null; /** * Maximum allowed number of target name servers per managed forwarding zone. */ - targetNameServersPerManagedZone?: number; + targetNameServersPerManagedZone?: number | null; /** * Maximum allowed number of alternative target name servers per policy. */ - targetNameServersPerPolicy?: number; + targetNameServersPerPolicy?: number | null; /** * Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. */ - totalRrdataSizePerChange?: number; + totalRrdataSizePerChange?: number | null; /** * DNSSEC algorithm and key length types that can be used for DnsKeys. */ @@ -677,38 +677,38 @@ export namespace dns_v1beta2 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet". */ - kind?: string; + kind?: string | null; /** * For example, www.example.com. */ - name?: string; + name?: string | null; /** * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. */ - rrdatas?: string[]; + rrdatas?: string[] | null; /** * As defined in RFC 4034 (section 3.2). */ - signatureRrdatas?: string[]; + signatureRrdatas?: string[] | null; /** * Number of seconds that this ResourceRecordSet can be cached by resolvers. */ - ttl?: number; + ttl?: number | null; /** * The identifier of a supported record type. See the list of Supported DNS record types. */ - type?: string; + type?: string | null; } export interface Schema$ResourceRecordSetsListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The resource record set resources. */ @@ -721,7 +721,7 @@ export namespace dns_v1beta2 { /** * For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). */ - operationId?: string; + operationId?: string | null; } export class Resource$Changes { diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index a1e546e9273..8ab0827175d 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -93,6 +93,7 @@ export namespace dns_v2beta1 { dnsKeys: Resource$Dnskeys; managedZoneOperations: Resource$Managedzoneoperations; managedZones: Resource$Managedzones; + policies: Resource$Policies; projects: Resource$Projects; resourceRecordSets: Resource$Resourcerecordsets; @@ -108,6 +109,7 @@ export namespace dns_v2beta1 { this.context ); this.managedZones = new Resource$Managedzones(this.context); + this.policies = new Resource$Policies(this.context); this.projects = new Resource$Projects(this.context); this.resourceRecordSets = new Resource$Resourcerecordsets(this.context); } @@ -128,23 +130,23 @@ export namespace dns_v2beta1 { /** * Unique identifier for the resource; defined by the server (output only). */ - id?: string; + id?: string | null; /** * If the DNS queries for the zone will be served. */ - isServing?: boolean; + isServing?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#change". */ - kind?: string; + kind?: string | null; /** * The time that this operation was started by the server (output only). This is in RFC3339 text format. */ - startTime?: string; + startTime?: string | null; /** * Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ - status?: string; + status?: string | null; } /** * The response to a request to enumerate Changes to a ResourceRecordSets collection. @@ -158,11 +160,11 @@ export namespace dns_v2beta1 { /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A DNSSEC key pair. @@ -171,15 +173,15 @@ export namespace dns_v2beta1 { /** * String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. */ - algorithm?: string; + algorithm?: string | null; /** * The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. */ - creationTime?: string; + creationTime?: string | null; /** * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. */ - description?: string; + description?: string | null; /** * Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. */ @@ -187,41 +189,41 @@ export namespace dns_v2beta1 { /** * Unique identifier for the resource; defined by the server (output only). */ - id?: string; + id?: string | null; /** * Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. */ - isActive?: boolean; + isActive?: boolean | null; /** * Length of the key in bits. Specified at creation time then immutable. */ - keyLength?: number; + keyLength?: number | null; /** * The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. */ - keyTag?: number; + keyTag?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". */ - kind?: string; + kind?: string | null; /** * Base64 encoded public half of this key. Output only. */ - publicKey?: string; + publicKey?: string | null; /** * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. */ - type?: string; + type?: string | null; } export interface Schema$DnsKeyDigest { /** * The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. */ - digest?: string; + digest?: string | null; /** * Specifies the algorithm used to calculate this digest. */ - type?: string; + type?: string | null; } /** * The response to a request to enumerate DnsKeys in a ManagedZone. @@ -235,11 +237,11 @@ export namespace dns_v2beta1 { /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. @@ -248,19 +250,19 @@ export namespace dns_v2beta1 { /** * String mnemonic specifying the DNSSEC algorithm of this key. */ - algorithm?: string; + algorithm?: string | null; /** * Length of the keys in bits. */ - keyLength?: number; + keyLength?: number | null; /** * Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. */ - keyType?: string; + keyType?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". */ - kind?: string; + kind?: string | null; } /** * A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. @@ -269,43 +271,47 @@ export namespace dns_v2beta1 { /** * The time that this resource was created on the server. This is in RFC3339 text format. Output only. */ - creationTime?: string; + creationTime?: string | null; /** * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. */ - description?: string; + description?: string | null; /** * The DNS name of this managed zone, for instance "example.com.". */ - dnsName?: string; + dnsName?: string | null; /** * DNSSEC configuration. */ dnssecConfig?: Schema$ManagedZoneDnsSecConfig; + /** + * The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. + */ + forwardingConfig?: Schema$ManagedZoneForwardingConfig; /** * Unique identifier for the resource; defined by the server (output only) */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". */ - kind?: string; + kind?: string | null; /** * User labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. */ - name?: string; + name?: string | null; /** * Delegate your managed_zone to these virtual name servers; defined by the server (output only) */ - nameServers?: string[]; + nameServers?: string[] | null; /** * 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; + nameServerSet?: string | null; /** * For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. */ @@ -313,36 +319,56 @@ export namespace dns_v2beta1 { /** * The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. */ - visibility?: string; + visibility?: string | null; } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Can only be changed while state is OFF. + * Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". */ - kind?: string; + kind?: string | null; /** - * Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF. + * Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. */ - nonExistence?: string; + nonExistence?: string | null; /** * Specifies whether DNSSEC is enabled, and what mode it is in. */ - state?: string; + state?: string | null; + } + export interface Schema$ManagedZoneForwardingConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". + */ + kind?: string | null; + /** + * List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. + */ + targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[]; + } + export interface Schema$ManagedZoneForwardingConfigNameServerTarget { + /** + * IPv4 address of a target name server. + */ + ipv4Address?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". + */ + kind?: string | null; } export interface Schema$ManagedZoneOperationsListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The operation resources. */ @@ -352,7 +378,7 @@ export namespace dns_v2beta1 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". */ - kind?: string; + kind?: string | null; /** * The list of VPC networks that can see this zone. */ @@ -362,18 +388,18 @@ export namespace dns_v2beta1 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". */ - kind?: string; + kind?: string | null; /** * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ - networkUrl?: string; + networkUrl?: string | null; } export interface Schema$ManagedZonesListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The managed zone resources. */ @@ -381,7 +407,7 @@ export namespace dns_v2beta1 { /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. @@ -394,27 +420,27 @@ export namespace dns_v2beta1 { /** * Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#operation". */ - kind?: string; + kind?: string | null; /** * The time that this operation was started by the server. This is in RFC3339 text format (output only). */ - startTime?: string; + startTime?: string | null; /** * Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ - status?: string; + status?: string | null; /** * Type of the operation. Operations include insert, update, and delete (output only). */ - type?: string; + type?: string | null; /** * User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) */ - user?: string; + user?: string | null; /** * Only populated if the operation targeted a ManagedZone (output only). */ @@ -440,6 +466,92 @@ export namespace dns_v2beta1 { */ oldValue?: Schema$ManagedZone; } + export interface Schema$PoliciesListResponse { + header?: Schema$ResponseHeader; + /** + * Type of resource. + */ + kind?: string | null; + /** + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. + */ + nextPageToken?: string | null; + /** + * The policy resources. + */ + policies?: Schema$Policy[]; + } + export interface Schema$PoliciesPatchResponse { + header?: Schema$ResponseHeader; + policy?: Schema$Policy; + } + export interface Schema$PoliciesUpdateResponse { + header?: Schema$ResponseHeader; + policy?: Schema$Policy; + } + /** + * A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. + */ + export interface Schema$Policy { + /** + * Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. + */ + alternativeNameServerConfig?: Schema$PolicyAlternativeNameServerConfig; + /** + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. + */ + description?: string | null; + /** + * Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy. + */ + enableInboundForwarding?: boolean | null; + /** + * Unique identifier for the resource; defined by the server (output only). + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policy". + */ + kind?: string | null; + /** + * User assigned name for this policy. + */ + name?: string | null; + /** + * List of network names specifying networks to which this policy is applied. + */ + networks?: Schema$PolicyNetwork[]; + } + export interface Schema$PolicyAlternativeNameServerConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig". + */ + kind?: string | null; + /** + * Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. + */ + targetNameServers?: Schema$PolicyAlternativeNameServerConfigTargetNameServer[]; + } + export interface Schema$PolicyAlternativeNameServerConfigTargetNameServer { + /** + * IPv4 address to forward to. + */ + ipv4Address?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer". + */ + kind?: string | null; + } + export interface Schema$PolicyNetwork { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork". + */ + kind?: string | null; + /** + * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ + networkUrl?: string | null; + } /** * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. */ @@ -447,15 +559,15 @@ export namespace dns_v2beta1 { /** * User assigned unique identifier for the resource (output only). */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#project". */ - kind?: string; + kind?: string | null; /** * Unique numeric identifier for the resource; defined by the server (output only). */ - number?: string; + number?: string | null; /** * Quotas assigned to this project (output only). */ @@ -468,43 +580,59 @@ export namespace dns_v2beta1 { /** * Maximum allowed number of DnsKeys per ManagedZone. */ - dnsKeysPerManagedZone?: number; + dnsKeysPerManagedZone?: number | null; /** * Identifies what kind of resource this is. Value: the fixed string "dns#quota". */ - kind?: string; + kind?: string | null; /** * Maximum allowed number of managed zones in the project. */ - managedZones?: number; + managedZones?: number | null; /** * Maximum allowed number of managed zones which can be attached to a network. */ - managedZonesPerNetwork?: number; + managedZonesPerNetwork?: number | null; /** * Maximum allowed number of networks to which a privately scoped zone can be attached. */ - networksPerManagedZone?: number; + networksPerManagedZone?: number | null; + /** + * Maximum allowed number of networks per policy. + */ + networksPerPolicy?: number | null; + /** + * Maximum allowed number of policies per project. + */ + policies?: number | null; /** * Maximum allowed number of ResourceRecords per ResourceRecordSet. */ - resourceRecordsPerRrset?: number; + resourceRecordsPerRrset?: number | null; /** * Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. */ - rrsetAdditionsPerChange?: number; + rrsetAdditionsPerChange?: number | null; /** * Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest. */ - rrsetDeletionsPerChange?: number; + rrsetDeletionsPerChange?: number | null; /** * Maximum allowed number of ResourceRecordSets per zone in the project. */ - rrsetsPerManagedZone?: number; + rrsetsPerManagedZone?: number | null; + /** + * Maximum allowed number of target name servers per managed forwarding zone. + */ + targetNameServersPerManagedZone?: number | null; + /** + * Maximum allowed number of alternative target name servers per policy. + */ + targetNameServersPerPolicy?: number | null; /** * Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. */ - totalRrdataSizePerChange?: number; + totalRrdataSizePerChange?: number | null; /** * DNSSEC algorithm and key length types that can be used for DnsKeys. */ @@ -517,38 +645,38 @@ export namespace dns_v2beta1 { /** * Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet". */ - kind?: string; + kind?: string | null; /** * For example, www.example.com. */ - name?: string; + name?: string | null; /** * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. */ - rrdatas?: string[]; + rrdatas?: string[] | null; /** * As defined in RFC 4034 (section 3.2). */ - signatureRrdatas?: string[]; + signatureRrdatas?: string[] | null; /** * Number of seconds that this ResourceRecordSet can be cached by resolvers. */ - ttl?: number; + ttl?: number | null; /** * The identifier of a supported record type. See the list of Supported DNS record types. */ - type?: string; + type?: string | null; } export interface Schema$ResourceRecordSetsListResponse { header?: Schema$ResponseHeader; /** * Type of resource. */ - kind?: string; + kind?: string | null; /** * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The resource record set resources. */ @@ -561,7 +689,7 @@ export namespace dns_v2beta1 { /** * For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). */ - operationId?: string; + operationId?: string | null; } export class Resource$Changes { @@ -2619,6 +2747,587 @@ export namespace dns_v2beta1 { requestBody?: Schema$ManagedZone; } + export class Resource$Policies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dns.policies.create + * @desc Create a new Policy + * @alias dns.policies.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Policies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Policies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Policies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Policies$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dns/v2beta1/projects/{project}/policies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.delete + * @desc Delete a previously created Policy. Will fail if the policy is still being referenced by a network. + * @alias dns.policies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Policies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Policies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Policies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Policies$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v2beta1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.get + * @desc Fetch the representation of an existing Policy. + * @alias dns.policies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + 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://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v2beta1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.list + * @desc Enumerate all Policies associated with a project. + * @alias dns.policies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Policies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Policies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Policies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Policies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dns/v2beta1/projects/{project}/policies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.patch + * @desc Apply a partial update to an existing Policy. + * @alias dns.policies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Policies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Policies$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Policies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Policies$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v2beta1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dns.policies.update + * @desc Update an existing Policy. + * @alias dns.policies.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Policies$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Policies$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Policies$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Policies$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dns/v2beta1/projects/{project}/policies/{policy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Policies$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + */ + maxResults?: number; + /** + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + */ + pageToken?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index fc5147af4ce..1ade2d59ca7 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -124,15 +124,17 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. An AutoText may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested text style changes to this AutoText, keyed by suggestion ID. */ - suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; + suggestedTextStyleChanges?: { + [key: string]: Schema$SuggestedTextStyle; + } | null; /** * The text style of this AutoText. */ @@ -140,7 +142,7 @@ export namespace docs_v1 { /** * The type of this auto text. */ - type?: string; + type?: string | null; } /** * Represents the background of a document. @@ -158,7 +160,7 @@ export namespace docs_v1 { /** * Indicates whether the current background color has been modified in this suggestion. */ - backgroundColorSuggested?: boolean; + backgroundColorSuggested?: boolean | null; } /** * Request message for BatchUpdateDocument. @@ -180,7 +182,7 @@ export namespace docs_v1 { /** * The ID of the document to which the updates were applied to. */ - documentId?: string; + documentId?: string | null; /** * The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */ @@ -206,11 +208,11 @@ export namespace docs_v1 { /** * The ID of the list this paragraph belongs to. */ - listId?: string; + listId?: string | null; /** * The nesting level of this paragraph in the list. */ - nestingLevel?: number; + nestingLevel?: number | null; /** * The paragraph specific text style applied to this bullet. */ @@ -223,11 +225,11 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to the list_id. */ - listIdSuggested?: boolean; + listIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to the nesting_level. */ - nestingLevelSuggested?: boolean; + nestingLevelSuggested?: boolean | null; /** * A mask that indicates which of the fields in text style have been changed in this suggestion. */ @@ -249,15 +251,17 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested text style changes to this ColumnBreak, keyed by suggestion ID. */ - suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; + suggestedTextStyleChanges?: { + [key: string]: Schema$SuggestedTextStyle; + } | null; /** * The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted adjacent to it. */ @@ -270,7 +274,7 @@ export namespace docs_v1 { /** * The name of the NamedRange. Names do not need to be unique. Names must be at least 1 character and no more than 256 characters, measured in UTF-16 code units. */ - name?: string; + name?: string | null; /** * The range to apply the name to. */ @@ -283,7 +287,7 @@ export namespace docs_v1 { /** * The ID of the created named range. */ - namedRangeId?: string; + namedRangeId?: string | null; } /** * Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. @@ -292,7 +296,7 @@ export namespace docs_v1 { /** * The kinds of bullet glyphs to be used. */ - bulletPreset?: string; + bulletPreset?: string | null; /** * The range to apply the bullet preset to. */ @@ -305,23 +309,23 @@ export namespace docs_v1 { /** * The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. */ - angle?: number; + angle?: number | null; /** * The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. */ - offsetBottom?: number; + offsetBottom?: number | null; /** * The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. */ - offsetLeft?: number; + offsetLeft?: number | null; /** * The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. */ - offsetRight?: number; + offsetRight?: number | null; /** * The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. */ - offsetTop?: number; + offsetTop?: number | null; } /** * A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. @@ -330,23 +334,23 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to angle. */ - angleSuggested?: boolean; + angleSuggested?: boolean | null; /** * Indicates if there was a suggested change to offset_bottom. */ - offsetBottomSuggested?: boolean; + offsetBottomSuggested?: boolean | null; /** * Indicates if there was a suggested change to offset_left. */ - offsetLeftSuggested?: boolean; + offsetLeftSuggested?: boolean | null; /** * Indicates if there was a suggested change to offset_right. */ - offsetRightSuggested?: boolean; + offsetRightSuggested?: boolean | null; /** * Indicates if there was a suggested change to offset_top. */ - offsetTopSuggested?: boolean; + offsetTopSuggested?: boolean | null; } /** * Deletes content from the document. @@ -364,11 +368,11 @@ export namespace docs_v1 { /** * The name of the range(s) to delete. All named ranges with the given name will be deleted. */ - name?: string; + name?: string | null; /** * The ID of the named range to delete. */ - namedRangeId?: string; + namedRangeId?: string | null; } /** * Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. @@ -386,7 +390,7 @@ export namespace docs_v1 { /** * The ID of the positioned object to delete. */ - objectId?: string; + objectId?: string | null; } /** * Deletes a column from a table. @@ -413,11 +417,11 @@ export namespace docs_v1 { /** * The magnitude. */ - magnitude?: number; + magnitude?: number | null; /** * The units for magnitude. */ - unit?: string; + unit?: string | null; } /** * A Google Docs document. @@ -430,7 +434,7 @@ export namespace docs_v1 { /** * Output only. The ID of the document. */ - documentId?: string; + documentId?: string | null; /** * Output only. The style of the document. */ @@ -438,27 +442,27 @@ export namespace docs_v1 { /** * Output only. The footers in the document, keyed by footer ID. */ - footers?: {[key: string]: Schema$Footer}; + footers?: {[key: string]: Schema$Footer} | null; /** * Output only. The footnotes in the document, keyed by footnote ID. */ - footnotes?: {[key: string]: Schema$Footnote}; + footnotes?: {[key: string]: Schema$Footnote} | null; /** * Output only. The headers in the document, keyed by header ID. */ - headers?: {[key: string]: Schema$Header}; + headers?: {[key: string]: Schema$Header} | null; /** * Output only. The inline objects in the document, keyed by object ID. */ - inlineObjects?: {[key: string]: Schema$InlineObject}; + inlineObjects?: {[key: string]: Schema$InlineObject} | null; /** * Output only. The lists in the document, keyed by list ID. */ - lists?: {[key: string]: Schema$List}; + lists?: {[key: string]: Schema$List} | null; /** * Output only. The named ranges in the document, keyed by name. */ - namedRanges?: {[key: string]: Schema$NamedRanges}; + namedRanges?: {[key: string]: Schema$NamedRanges} | null; /** * Output only. The named styles of the document. */ @@ -466,29 +470,31 @@ export namespace docs_v1 { /** * Output only. The positioned objects in the document, keyed by object ID. */ - positionedObjects?: {[key: string]: Schema$PositionedObject}; + positionedObjects?: {[key: string]: Schema$PositionedObject} | null; /** * Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */ - revisionId?: string; + revisionId?: string | null; /** * Output only. The suggested changes to the style of the document, keyed by suggestion ID. */ suggestedDocumentStyleChanges?: { [key: string]: Schema$SuggestedDocumentStyle; - }; + } | null; /** * Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. */ - suggestedNamedStylesChanges?: {[key: string]: Schema$SuggestedNamedStyles}; + suggestedNamedStylesChanges?: { + [key: string]: Schema$SuggestedNamedStyles; + } | null; /** * Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. */ - suggestionsViewMode?: string; + suggestionsViewMode?: string | null; /** * The title of the document. */ - title?: string; + title?: string | null; } /** * The style of the document. @@ -501,27 +507,27 @@ export namespace docs_v1 { /** * The ID of the default footer. If not set, there is no default footer. This property is read-only. */ - defaultFooterId?: string; + defaultFooterId?: string | null; /** * The ID of the default header. If not set, there is no default header. This property is read-only. */ - defaultHeaderId?: string; + defaultHeaderId?: string | null; /** * The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there is no even page footer. This property is read-only. */ - evenPageFooterId?: string; + evenPageFooterId?: string | null; /** * The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there is no even page header. This property is read-only. */ - evenPageHeaderId?: string; + evenPageHeaderId?: string | null; /** * The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there is no first page footer. This property is read-only. */ - firstPageFooterId?: string; + firstPageFooterId?: string | null; /** * The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there is no first page header. This property is read-only. */ - firstPageHeaderId?: string; + firstPageHeaderId?: string | null; /** * The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. */ @@ -541,7 +547,7 @@ export namespace docs_v1 { /** * The page number from which to start counting the number of pages. */ - pageNumberStart?: number; + pageNumberStart?: number | null; /** * The size of a page in the document. */ @@ -549,11 +555,11 @@ export namespace docs_v1 { /** * Indicates whether to use the even page header / footer IDs for the even pages. This property is read-only. */ - useEvenPageHeaderFooter?: boolean; + useEvenPageHeaderFooter?: boolean | null; /** * Indicates whether to use the first page header / footer IDs for the first page. This property is read-only. */ - useFirstPageHeaderFooter?: boolean; + useFirstPageHeaderFooter?: boolean | null; } /** * A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there is a new suggested value. @@ -566,47 +572,47 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to default_footer_id. */ - defaultFooterIdSuggested?: boolean; + defaultFooterIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to default_header_id. */ - defaultHeaderIdSuggested?: boolean; + defaultHeaderIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to even_page_footer_id. */ - evenPageFooterIdSuggested?: boolean; + evenPageFooterIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to even_page_header_id. */ - evenPageHeaderIdSuggested?: boolean; + evenPageHeaderIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to first_page_footer_id. */ - firstPageFooterIdSuggested?: boolean; + firstPageFooterIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to first_page_header_id. */ - firstPageHeaderIdSuggested?: boolean; + firstPageHeaderIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_bottom. */ - marginBottomSuggested?: boolean; + marginBottomSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_left. */ - marginLeftSuggested?: boolean; + marginLeftSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_right. */ - marginRightSuggested?: boolean; + marginRightSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_top. */ - marginTopSuggested?: boolean; + marginTopSuggested?: boolean | null; /** * Indicates if there was a suggested change to page_number_start. */ - pageNumberStartSuggested?: boolean; + pageNumberStartSuggested?: boolean | null; /** * A mask that indicates which of the fields in size have been changed in this suggestion. */ @@ -614,11 +620,11 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to use_even_page_header_footer. */ - useEvenPageHeaderFooterSuggested?: boolean; + useEvenPageHeaderFooterSuggested?: boolean | null; /** * Indicates if there was a suggested change to use_first_page_header_footer. */ - useFirstPageHeaderFooterSuggested?: boolean; + useFirstPageHeaderFooterSuggested?: boolean | null; } /** * The properties of an embedded drawing. @@ -635,7 +641,7 @@ export namespace docs_v1 { /** * The description of the embedded object. The `title` and `description` are both combined to display alt text. */ - description?: string; + description?: string | null; /** * The properties of an embedded drawing. */ @@ -675,7 +681,7 @@ export namespace docs_v1 { /** * The title of the embedded object. The `title` and `description` are both combined to display alt text. */ - title?: string; + title?: string | null; } /** * A border around an EmbeddedObject. @@ -688,11 +694,11 @@ export namespace docs_v1 { /** * The dash style of the border. */ - dashStyle?: string; + dashStyle?: string | null; /** * The property state of the border property. */ - propertyState?: string; + propertyState?: string | null; /** * The width of the border. */ @@ -705,19 +711,19 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to color. */ - colorSuggested?: boolean; + colorSuggested?: boolean | null; /** * Indicates if there was a suggested change to dash_style. */ - dashStyleSuggested?: boolean; + dashStyleSuggested?: boolean | null; /** * Indicates if there was a suggested change to property_state. */ - propertyStateSuggested?: boolean; + propertyStateSuggested?: boolean | null; /** * Indicates if there was a suggested change to width. */ - widthSuggested?: boolean; + widthSuggested?: boolean | null; } /** * A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there is a new suggested value. @@ -726,7 +732,7 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to description. */ - descriptionSuggested?: boolean; + descriptionSuggested?: boolean | null; /** * A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. */ @@ -746,19 +752,19 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to margin_bottom. */ - marginBottomSuggested?: boolean; + marginBottomSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_left. */ - marginLeftSuggested?: boolean; + marginLeftSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_right. */ - marginRightSuggested?: boolean; + marginRightSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_top. */ - marginTopSuggested?: boolean; + marginTopSuggested?: boolean | null; /** * A mask that indicates which of the fields in size have been changed in this suggestion. */ @@ -766,7 +772,7 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to title. */ - titleSuggested?: boolean; + titleSuggested?: boolean | null; } /** * Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. @@ -775,7 +781,7 @@ export namespace docs_v1 { /** * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */ - segmentId?: string; + segmentId?: string | null; } /** * A ParagraphElement representing an equation. @@ -784,11 +790,11 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A Equation may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; } /** * A document footer. @@ -801,7 +807,7 @@ export namespace docs_v1 { /** * The ID of the footer. */ - footerId?: string; + footerId?: string | null; } /** * A document footnote. @@ -814,7 +820,7 @@ export namespace docs_v1 { /** * The ID of the footnote. */ - footnoteId?: string; + footnoteId?: string | null; } /** * A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. @@ -823,23 +829,25 @@ export namespace docs_v1 { /** * The ID of the footnote that contains the content of this footnote reference. */ - footnoteId?: string; + footnoteId?: string | null; /** * The rendered number of this footnote. */ - footnoteNumber?: string; + footnoteNumber?: string | null; /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested text style changes to this FootnoteReference, keyed by suggestion ID. */ - suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; + suggestedTextStyleChanges?: { + [key: string]: Schema$SuggestedTextStyle; + } | null; /** * The text style of this FootnoteReference. */ @@ -856,7 +864,7 @@ export namespace docs_v1 { /** * The ID of the header. */ - headerId?: string; + headerId?: string | null; } /** * A ParagraphElement representing a horizontal line. @@ -865,15 +873,17 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested text style changes to this HorizontalRule, keyed by suggestion ID. */ - suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; + suggestedTextStyleChanges?: { + [key: string]: Schema$SuggestedTextStyle; + } | null; /** * The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted adjacent to it. */ @@ -886,19 +896,19 @@ export namespace docs_v1 { /** * The clockwise rotation angle of the image, in radians. */ - angle?: number; + angle?: number | null; /** * The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. */ - brightness?: number; + brightness?: number | null; /** * A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. */ - contentUri?: string; + contentUri?: string | null; /** * The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. */ - contrast?: number; + contrast?: number | null; /** * The crop properties of the image. */ @@ -906,11 +916,11 @@ export namespace docs_v1 { /** * The source URI is the URI used to insert the image. The source URI can be empty. */ - sourceUri?: string; + sourceUri?: string | null; /** * The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. */ - transparency?: number; + transparency?: number | null; } /** * A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. @@ -919,19 +929,19 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to angle. */ - angleSuggested?: boolean; + angleSuggested?: boolean | null; /** * Indicates if there was a suggested change to brightness. */ - brightnessSuggested?: boolean; + brightnessSuggested?: boolean | null; /** * Indicates if there was a suggested change to content_uri. */ - contentUriSuggested?: boolean; + contentUriSuggested?: boolean | null; /** * Indicates if there was a suggested change to contrast. */ - contrastSuggested?: boolean; + contrastSuggested?: boolean | null; /** * A mask that indicates which of the fields in crop_properties have been changed in this suggestion. */ @@ -939,11 +949,11 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to source_uri. */ - sourceUriSuggested?: boolean; + sourceUriSuggested?: boolean | null; /** * Indicates if there was a suggested change to transparency. */ - transparencySuggested?: boolean; + transparencySuggested?: boolean | null; } /** * An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. @@ -956,21 +966,21 @@ export namespace docs_v1 { /** * The ID of this inline object. */ - objectId?: string; + objectId?: string | null; /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested changes to the inline object properties, keyed by suggestion ID. */ suggestedInlineObjectPropertiesChanges?: { [key: string]: Schema$SuggestedInlineObjectProperties; - }; + } | null; /** * The suggested insertion ID. If empty, then this is not a suggested insertion. */ - suggestedInsertionId?: string; + suggestedInsertionId?: string | null; } /** * A ParagraphElement that contains an InlineObject. @@ -979,19 +989,21 @@ export namespace docs_v1 { /** * The ID of the InlineObject this element contains. */ - inlineObjectId?: string; + inlineObjectId?: string | null; /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested text style changes to this InlineObject, keyed by suggestion ID. */ - suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; + suggestedTextStyleChanges?: { + [key: string]: Schema$SuggestedTextStyle; + } | null; /** * The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted adjacent to it. */ @@ -1034,7 +1046,7 @@ export namespace docs_v1 { /** * The image URI. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI can be at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field. */ - uri?: string; + uri?: string | null; } /** * The result of inserting an inline image. @@ -1043,7 +1055,7 @@ export namespace docs_v1 { /** * The ID of the created InlineObject. */ - objectId?: string; + objectId?: string | null; } /** * The result of inserting an embedded Google Sheets chart. @@ -1052,7 +1064,7 @@ export namespace docs_v1 { /** * The object ID of the inserted chart. */ - objectId?: string; + objectId?: string | null; } /** * Inserts a page break followed by a newline at the specified location. @@ -1074,7 +1086,7 @@ export namespace docs_v1 { /** * Whether to insert new column to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left. */ - insertRight?: boolean; + insertRight?: boolean | null; /** * The reference table cell location from which columns will be inserted. A new column will be inserted to the left (or right) of the column where the reference cell is. If the reference cell is a merged cell, a new column will be inserted to the left (or right) of the merged cell. */ @@ -1087,7 +1099,7 @@ export namespace docs_v1 { /** * The number of columns in the table. */ - columns?: number; + columns?: number | null; /** * Inserts the table at the end of the given header, footer or document body. A newline character will be inserted before the inserted table. Tables cannot be inserted inside a footnote. */ @@ -1099,7 +1111,7 @@ export namespace docs_v1 { /** * The number of rows in the table. */ - rows?: number; + rows?: number | null; } /** * Inserts an empty row into a table. @@ -1108,7 +1120,7 @@ export namespace docs_v1 { /** * Whether to insert new row below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell. */ - insertBelow?: boolean; + insertBelow?: boolean | null; /** * The reference table cell location from which rows will be inserted. A new row will be inserted above (or below) the row where the reference cell is. If the reference cell is a merged cell, a new row will be inserted above (or below) the merged cell. */ @@ -1129,7 +1141,7 @@ export namespace docs_v1 { /** * The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. */ - text?: string; + text?: string | null; } /** * A reference to another portion of a document or an external URL resource. @@ -1138,15 +1150,15 @@ export namespace docs_v1 { /** * The ID of a bookmark in this document. */ - bookmarkId?: string; + bookmarkId?: string | null; /** * The ID of a heading in this document. */ - headingId?: string; + headingId?: string | null; /** * An external URL. */ - url?: string; + url?: string | null; } /** * A reference to the external linked source content. @@ -1177,17 +1189,17 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this list. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion ID. If empty, then this is not a suggested insertion. */ - suggestedInsertionId?: string; + suggestedInsertionId?: string | null; /** * The suggested changes to the list properties, keyed by suggestion ID. */ suggestedListPropertiesChanges?: { [key: string]: Schema$SuggestedListProperties; - }; + } | null; } /** * The properties of a list which describe the look and feel of bullets belonging to paragraphs associated with a list. @@ -1214,11 +1226,11 @@ export namespace docs_v1 { /** * The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. */ - index?: number; + index?: number | null; /** * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */ - segmentId?: string; + segmentId?: string | null; } /** * Merges cells in a Table. @@ -1236,11 +1248,11 @@ export namespace docs_v1 { /** * The name of the named range. */ - name?: string; + name?: string | null; /** * The ID of the named range. */ - namedRangeId?: string; + namedRangeId?: string | null; /** * The ranges that belong to this named range. */ @@ -1253,7 +1265,7 @@ export namespace docs_v1 { /** * The name that all the named ranges share. */ - name?: string; + name?: string | null; /** * The NamedRanges that share the same name. */ @@ -1266,7 +1278,7 @@ export namespace docs_v1 { /** * The type of this named style. */ - namedStyleType?: string; + namedStyleType?: string | null; /** * The paragraph style of this named style. */ @@ -1301,7 +1313,7 @@ export namespace docs_v1 { /** * The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. */ - namedStyleType?: string; + namedStyleType?: string | null; /** * A mask that indicates which of the fields in paragraph style have been changed in this suggestion. */ @@ -1318,19 +1330,19 @@ export namespace docs_v1 { /** * The alignment of the bullet within the space allotted for rendering the bullet. */ - bulletAlignment?: string; + bulletAlignment?: string | null; /** * The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholder are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `<prefix>%[nesting_level]<suffix>`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs <p>`A.` <p>`B.` <p>`C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs <p>`1.` <p>`2.` <p>` 2.1.` <p>` 2.2.` <p>`3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. */ - glyphFormat?: string; + glyphFormat?: string | null; /** * A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. */ - glyphSymbol?: string; + glyphSymbol?: string | null; /** * The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. */ - glyphType?: string; + glyphType?: string | null; /** * The amount of indentation for the first line of paragraphs at this level of nesting. */ @@ -1342,7 +1354,7 @@ export namespace docs_v1 { /** * The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and roman numeraled lists, i.e. for values of both 0 and 1, lettered and roman numeraled lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. */ - startNumber?: number; + startNumber?: number | null; /** * The text style of bullets at this level of nesting. */ @@ -1355,31 +1367,31 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to bullet_alignment. */ - bulletAlignmentSuggested?: boolean; + bulletAlignmentSuggested?: boolean | null; /** * Indicates if there was a suggested change to glyph_format. */ - glyphFormatSuggested?: boolean; + glyphFormatSuggested?: boolean | null; /** * Indicates if there was a suggested change to glyph_symbol. */ - glyphSymbolSuggested?: boolean; + glyphSymbolSuggested?: boolean | null; /** * Indicates if there was a suggested change to glyph_type. */ - glyphTypeSuggested?: boolean; + glyphTypeSuggested?: boolean | null; /** * Indicates if there was a suggested change to indent_first_line. */ - indentFirstLineSuggested?: boolean; + indentFirstLineSuggested?: boolean | null; /** * Indicates if there was a suggested change to indent_start. */ - indentStartSuggested?: boolean; + indentStartSuggested?: boolean | null; /** * Indicates if there was a suggested change to start_number. */ - startNumberSuggested?: boolean; + startNumberSuggested?: boolean | null; /** * A mask that indicates which of the fields in text style have been changed in this suggestion. */ @@ -1392,7 +1404,7 @@ export namespace docs_v1 { /** * The object IDs. */ - objectIds?: string[]; + objectIds?: string[] | null; } /** * A color that can either be fully opaque or fully transparent. @@ -1410,15 +1422,17 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested text style changes to this PageBreak, keyed by suggestion ID. */ - suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; + suggestedTextStyleChanges?: { + [key: string]: Schema$SuggestedTextStyle; + } | null; /** * The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted adjacent to it. */ @@ -1443,21 +1457,23 @@ export namespace docs_v1 { /** * The IDs of the positioned objects tethered to this paragraph. */ - positionedObjectIds?: string[]; + positionedObjectIds?: string[] | null; /** * The suggested changes to this paragraph's bullet. */ - suggestedBulletChanges?: {[key: string]: Schema$SuggestedBullet}; + suggestedBulletChanges?: {[key: string]: Schema$SuggestedBullet} | null; /** * The suggested paragraph style changes to this paragraph, keyed by suggestion ID. */ suggestedParagraphStyleChanges?: { [key: string]: Schema$SuggestedParagraphStyle; - }; + } | null; /** * The IDs of the positioned objects that are suggested to be attached to this paragraph, keyed by suggestion ID. */ - suggestedPositionedObjectIds?: {[key: string]: Schema$ObjectReferences}; + suggestedPositionedObjectIds?: { + [key: string]: Schema$ObjectReferences; + } | null; } /** * A border around a paragraph. @@ -1470,7 +1486,7 @@ export namespace docs_v1 { /** * The dash style of the border. */ - dashStyle?: string; + dashStyle?: string | null; /** * The padding of the border. */ @@ -1495,7 +1511,7 @@ export namespace docs_v1 { /** * The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. */ - endIndex?: number; + endIndex?: number | null; /** * An equation paragraph element. */ @@ -1519,7 +1535,7 @@ export namespace docs_v1 { /** * The zero-based start index of this paragraph element, in UTF-16 code units. */ - startIndex?: number; + startIndex?: number | null; /** * A text run paragraph element. */ @@ -1532,11 +1548,11 @@ export namespace docs_v1 { /** * The text alignment for this paragraph. */ - alignment?: string; + alignment?: string | null; /** * Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. */ - avoidWidowAndOrphan?: boolean; + avoidWidowAndOrphan?: boolean | null; /** * The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety. */ @@ -1560,11 +1576,11 @@ export namespace docs_v1 { /** * The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. */ - direction?: string; + direction?: string | null; /** * The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. */ - headingId?: string; + headingId?: string | null; /** * The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. */ @@ -1580,19 +1596,19 @@ export namespace docs_v1 { /** * Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. */ - keepLinesTogether?: boolean; + keepLinesTogether?: boolean | null; /** * Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. */ - keepWithNext?: boolean; + keepWithNext?: boolean | null; /** * The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. */ - lineSpacing?: number; + lineSpacing?: number | null; /** * The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. */ - namedStyleType?: string; + namedStyleType?: string | null; /** * The shading of the paragraph. If unset, the value is inherited from the parent. */ @@ -1608,7 +1624,7 @@ export namespace docs_v1 { /** * The spacing mode for the paragraph. */ - spacingMode?: string; + spacingMode?: string | null; /** * A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. */ @@ -1621,67 +1637,67 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to alignment. */ - alignmentSuggested?: boolean; + alignmentSuggested?: boolean | null; /** * Indicates if there was a suggested change to avoid_widow_and_orphan. */ - avoidWidowAndOrphanSuggested?: boolean; + avoidWidowAndOrphanSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_between. */ - borderBetweenSuggested?: boolean; + borderBetweenSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_bottom. */ - borderBottomSuggested?: boolean; + borderBottomSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_left. */ - borderLeftSuggested?: boolean; + borderLeftSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_right. */ - borderRightSuggested?: boolean; + borderRightSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_top. */ - borderTopSuggested?: boolean; + borderTopSuggested?: boolean | null; /** * Indicates if there was a suggested change to direction. */ - directionSuggested?: boolean; + directionSuggested?: boolean | null; /** * Indicates if there was a suggested change to heading_id. */ - headingIdSuggested?: boolean; + headingIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to indent_end. */ - indentEndSuggested?: boolean; + indentEndSuggested?: boolean | null; /** * Indicates if there was a suggested change to indent_first_line. */ - indentFirstLineSuggested?: boolean; + indentFirstLineSuggested?: boolean | null; /** * Indicates if there was a suggested change to indent_start. */ - indentStartSuggested?: boolean; + indentStartSuggested?: boolean | null; /** * Indicates if there was a suggested change to keep_lines_together. */ - keepLinesTogetherSuggested?: boolean; + keepLinesTogetherSuggested?: boolean | null; /** * Indicates if there was a suggested change to keep_with_next. */ - keepWithNextSuggested?: boolean; + keepWithNextSuggested?: boolean | null; /** * Indicates if there was a suggested change to line_spacing. */ - lineSpacingSuggested?: boolean; + lineSpacingSuggested?: boolean | null; /** * Indicates if there was a suggested change to named_style_type. */ - namedStyleTypeSuggested?: boolean; + namedStyleTypeSuggested?: boolean | null; /** * A mask that indicates which of the fields in shading have been changed in this suggestion. */ @@ -1689,15 +1705,15 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to space_above. */ - spaceAboveSuggested?: boolean; + spaceAboveSuggested?: boolean | null; /** * Indicates if there was a suggested change to space_below. */ - spaceBelowSuggested?: boolean; + spaceBelowSuggested?: boolean | null; /** * Indicates if there was a suggested change to spacing_mode. */ - spacingModeSuggested?: boolean; + spacingModeSuggested?: boolean | null; } /** * An object that is tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. @@ -1706,7 +1722,7 @@ export namespace docs_v1 { /** * The ID of this positioned object. */ - objectId?: string; + objectId?: string | null; /** * The properties of this positioned object. */ @@ -1714,17 +1730,17 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion ID. If empty, then this is not a suggested insertion. */ - suggestedInsertionId?: string; + suggestedInsertionId?: string | null; /** * The suggested changes to the positioned object properties, keyed by suggestion ID. */ suggestedPositionedObjectPropertiesChanges?: { [key: string]: Schema$SuggestedPositionedObjectProperties; - }; + } | null; } /** * The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it is tethered to. @@ -1733,7 +1749,7 @@ export namespace docs_v1 { /** * The layout of this positioned object. */ - layout?: string; + layout?: string | null; /** * The offset of the left edge of the positioned object relative to the beginning of the Paragraph it is tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. */ @@ -1750,15 +1766,15 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to layout. */ - layoutSuggested?: boolean; + layoutSuggested?: boolean | null; /** * Indicates if there was a suggested change to left_offset. */ - leftOffsetSuggested?: boolean; + leftOffsetSuggested?: boolean | null; /** * Indicates if there was a suggested change to top_offset. */ - topOffsetSuggested?: boolean; + topOffsetSuggested?: boolean | null; } /** * Properties of a PositionedObject. @@ -1793,15 +1809,15 @@ export namespace docs_v1 { /** * The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */ - endIndex?: number; + endIndex?: number | null; /** * The ID of the header, footer or footnote that this range is contained in. An empty segment ID signifies the document's body. */ - segmentId?: string; + segmentId?: string | null; /** * The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */ - startIndex?: number; + startIndex?: number | null; } /** * Replaces all instances of text matching a criteria with replace text. @@ -1814,7 +1830,7 @@ export namespace docs_v1 { /** * The text that will replace the matched text. */ - replaceText?: string; + replaceText?: string | null; } /** * The result of replacing text. @@ -1823,7 +1839,7 @@ export namespace docs_v1 { /** * The number of occurrences changed by replacing all text. */ - occurrencesChanged?: number; + occurrencesChanged?: number | null; } /** * Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor. @@ -1832,15 +1848,15 @@ export namespace docs_v1 { /** * The ID of the existing image that will be replaced. */ - imageObjectId?: string; + imageObjectId?: string | null; /** * The replacement method. */ - imageReplaceMethod?: string; + imageReplaceMethod?: string | null; /** * The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI can be at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.source_uri field. */ - uri?: string; + uri?: string | null; } /** * A single update to apply to a document. @@ -1971,15 +1987,15 @@ export namespace docs_v1 { /** * The blue component of the color, from 0.0 to 1.0. */ - blue?: number; + blue?: number | null; /** * The green component of the color, from 0.0 to 1.0. */ - green?: number; + green?: number | null; /** * The red component of the color, from 0.0 to 1.0. */ - red?: number; + red?: number | null; } /** * A StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. @@ -1992,11 +2008,11 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; } /** * Properties that apply to a section's column. @@ -2022,11 +2038,11 @@ export namespace docs_v1 { /** * The style of column separators. This style can be set even when there is one column in the section. */ - columnSeparatorStyle?: string; + columnSeparatorStyle?: string | null; /** * The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. */ - contentDirection?: string; + contentDirection?: string | null; } /** * The shading of a paragraph. @@ -2044,7 +2060,7 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to the Shading. */ - backgroundColorSuggested?: boolean; + backgroundColorSuggested?: boolean | null; } /** * A reference to a linked chart embedded from Google Sheets. @@ -2053,11 +2069,11 @@ export namespace docs_v1 { /** * The ID of the specific chart in the Google Sheets spreadsheet that is embedded. */ - chartId?: number; + chartId?: number | null; /** * The ID of the Google Sheets spreadsheet that contains the source chart. */ - spreadsheetId?: string; + spreadsheetId?: string | null; } /** * A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there is a new suggested value. @@ -2066,11 +2082,11 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to chart_id. */ - chartIdSuggested?: boolean; + chartIdSuggested?: boolean | null; /** * Indicates if there was a suggested change to spreadsheet_id. */ - spreadsheetIdSuggested?: boolean; + spreadsheetIdSuggested?: boolean | null; } /** * A width and height. @@ -2092,11 +2108,11 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to height. */ - heightSuggested?: boolean; + heightSuggested?: boolean | null; /** * Indicates if there was a suggested change to width. */ - widthSuggested?: boolean; + widthSuggested?: boolean | null; } /** * A StructuralElement describes content that provides structure to the document. @@ -2105,7 +2121,7 @@ export namespace docs_v1 { /** * The zero-based end index of this structural element, exclusive, in UTF-16 code units. */ - endIndex?: number; + endIndex?: number | null; /** * A paragraph type of structural element. */ @@ -2117,7 +2133,7 @@ export namespace docs_v1 { /** * The zero-based start index of this structural element, in UTF-16 code units. */ - startIndex?: number; + startIndex?: number | null; /** * A table type of structural element. */ @@ -2134,11 +2150,11 @@ export namespace docs_v1 { /** * Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive. */ - matchCase?: boolean; + matchCase?: boolean | null; /** * The text to search for in the document. */ - text?: string; + text?: string | null; } /** * A suggested change to a Bullet. @@ -2277,19 +2293,19 @@ export namespace docs_v1 { /** * Number of columns in the table. It is possible for a table to be non-rectangular, so some rows may have a different number of cells. */ - columns?: number; + columns?: number | null; /** * Number of rows in the table. */ - rows?: number; + rows?: number | null; /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A Table may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The contents and style of each row. */ @@ -2310,25 +2326,25 @@ export namespace docs_v1 { /** * The zero-based end index of this cell, exclusive, in UTF-16 code units. */ - endIndex?: number; + endIndex?: number | null; /** * The zero-based start index of this cell, in UTF-16 code units. */ - startIndex?: number; + startIndex?: number | null; /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A TableCell may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested changes to the table cell style, keyed by suggestion ID. */ suggestedTableCellStyleChanges?: { [key: string]: Schema$SuggestedTableCellStyle; - }; + } | null; /** * The style of the cell. */ @@ -2345,7 +2361,7 @@ export namespace docs_v1 { /** * The dash style of the border. */ - dashStyle?: string; + dashStyle?: string | null; /** * The width of the border. */ @@ -2358,11 +2374,11 @@ export namespace docs_v1 { /** * The zero-based column index. For example, the second column in the table has a column index of 1. */ - columnIndex?: number; + columnIndex?: number | null; /** * The zero-based row index. For example, the second row in the table has a row index of 1. */ - rowIndex?: number; + rowIndex?: number | null; /** * The location where the table starts in the document. */ @@ -2395,11 +2411,11 @@ export namespace docs_v1 { /** * The column span of the cell. This property is read-only. */ - columnSpan?: number; + columnSpan?: number | null; /** * The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. */ - contentAlignment?: string; + contentAlignment?: string | null; /** * The bottom padding of the cell. */ @@ -2419,7 +2435,7 @@ export namespace docs_v1 { /** * The row span of the cell. This property is read-only. */ - rowSpan?: number; + rowSpan?: number | null; } /** * A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there is a new suggested value. @@ -2428,51 +2444,51 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to background_color. */ - backgroundColorSuggested?: boolean; + backgroundColorSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_bottom. */ - borderBottomSuggested?: boolean; + borderBottomSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_left. */ - borderLeftSuggested?: boolean; + borderLeftSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_right. */ - borderRightSuggested?: boolean; + borderRightSuggested?: boolean | null; /** * Indicates if there was a suggested change to border_top. */ - borderTopSuggested?: boolean; + borderTopSuggested?: boolean | null; /** * Indicates if there was a suggested change to column_span. */ - columnSpanSuggested?: boolean; + columnSpanSuggested?: boolean | null; /** * Indicates if there was a suggested change to content_alignment. */ - contentAlignmentSuggested?: boolean; + contentAlignmentSuggested?: boolean | null; /** * Indicates if there was a suggested change to padding_bottom. */ - paddingBottomSuggested?: boolean; + paddingBottomSuggested?: boolean | null; /** * Indicates if there was a suggested change to padding_left. */ - paddingLeftSuggested?: boolean; + paddingLeftSuggested?: boolean | null; /** * Indicates if there was a suggested change to padding_right. */ - paddingRightSuggested?: boolean; + paddingRightSuggested?: boolean | null; /** * Indicates if there was a suggested change to padding_top. */ - paddingTopSuggested?: boolean; + paddingTopSuggested?: boolean | null; /** * Indicates if there was a suggested change to row_span. */ - rowSpanSuggested?: boolean; + rowSpanSuggested?: boolean | null; } /** * The properties of a column in a table. @@ -2485,7 +2501,7 @@ export namespace docs_v1 { /** * The width type of the column. */ - widthType?: string; + widthType?: string | null; } /** * A StructuralElement representing a table of contents. @@ -2498,11 +2514,11 @@ export namespace docs_v1 { /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; } /** * A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with table cell location = (table_start_location, row = 0, column = 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ] @@ -2511,11 +2527,11 @@ export namespace docs_v1 { /** * The column span of the table range. */ - columnSpan?: number; + columnSpan?: number | null; /** * The row span of the table range. */ - rowSpan?: number; + rowSpan?: number | null; /** * The cell location where the table range starts. */ @@ -2528,25 +2544,25 @@ export namespace docs_v1 { /** * The zero-based end index of this row, exclusive, in UTF-16 code units. */ - endIndex?: number; + endIndex?: number | null; /** * The zero-based start index of this row, in UTF-16 code units. */ - startIndex?: number; + startIndex?: number | null; /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A TableRow may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested style changes to this row, keyed by suggestion ID. */ suggestedTableRowStyleChanges?: { [key: string]: Schema$SuggestedTableRowStyle; - }; + } | null; /** * The contents and style of each cell in this row. It is possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. */ @@ -2572,7 +2588,7 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to min_row_height. */ - minRowHeightSuggested?: boolean; + minRowHeightSuggested?: boolean | null; } /** * Styles that apply to a table. @@ -2590,7 +2606,7 @@ export namespace docs_v1 { /** * The alignment of this tab stop. If unset, the value defaults to START. */ - alignment?: string; + alignment?: string | null; /** * The offset between this tab stop and the start margin. */ @@ -2603,19 +2619,21 @@ export namespace docs_v1 { /** * The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. */ - content?: string; + content?: string | null; /** * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ - suggestedDeletionIds?: string[]; + suggestedDeletionIds?: string[] | null; /** * The suggested insertion IDs. A TextRun may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ - suggestedInsertionIds?: string[]; + suggestedInsertionIds?: string[] | null; /** * The suggested text style changes to this run, keyed by suggestion ID. */ - suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; + suggestedTextStyleChanges?: { + [key: string]: Schema$SuggestedTextStyle; + } | null; /** * The text style of this run. */ @@ -2632,11 +2650,11 @@ export namespace docs_v1 { /** * The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. */ - baselineOffset?: string; + baselineOffset?: string | null; /** * Whether or not the text is rendered as bold. */ - bold?: boolean; + bold?: boolean | null; /** * The size of the text's font. */ @@ -2648,7 +2666,7 @@ export namespace docs_v1 { /** * Whether or not the text is italicized. */ - italic?: boolean; + italic?: boolean | null; /** * The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABCx/123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. */ @@ -2656,15 +2674,15 @@ export namespace docs_v1 { /** * Whether or not the text is in small capital letters. */ - smallCaps?: boolean; + smallCaps?: boolean | null; /** * Whether or not the text is struck through. */ - strikethrough?: boolean; + strikethrough?: boolean | null; /** * Whether or not the text is underlined. */ - underline?: boolean; + underline?: boolean | null; /** * The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. */ @@ -2677,47 +2695,47 @@ export namespace docs_v1 { /** * Indicates if there was a suggested change to background_color. */ - backgroundColorSuggested?: boolean; + backgroundColorSuggested?: boolean | null; /** * Indicates if there was a suggested change to baseline_offset. */ - baselineOffsetSuggested?: boolean; + baselineOffsetSuggested?: boolean | null; /** * Indicates if there was a suggested change to bold. */ - boldSuggested?: boolean; + boldSuggested?: boolean | null; /** * Indicates if there was a suggested change to font_size. */ - fontSizeSuggested?: boolean; + fontSizeSuggested?: boolean | null; /** * Indicates if there was a suggested change to foreground_color. */ - foregroundColorSuggested?: boolean; + foregroundColorSuggested?: boolean | null; /** * Indicates if there was a suggested change to italic. */ - italicSuggested?: boolean; + italicSuggested?: boolean | null; /** * Indicates if there was a suggested change to link. */ - linkSuggested?: boolean; + linkSuggested?: boolean | null; /** * Indicates if there was a suggested change to small_caps. */ - smallCapsSuggested?: boolean; + smallCapsSuggested?: boolean | null; /** * Indicates if there was a suggested change to strikethrough. */ - strikethroughSuggested?: boolean; + strikethroughSuggested?: boolean | null; /** * Indicates if there was a suggested change to underline. */ - underlineSuggested?: boolean; + underlineSuggested?: boolean | null; /** * Indicates if there was a suggested change to weighted_font_family. */ - weightedFontFamilySuggested?: boolean; + weightedFontFamilySuggested?: boolean | null; } /** * Unmerges cells in a Table. @@ -2739,7 +2757,7 @@ export namespace docs_v1 { /** * The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`. */ - fields?: string; + fields?: string | null; } /** * Update the styling of all paragraphs that overlap with the given range. @@ -2748,7 +2766,7 @@ export namespace docs_v1 { /** * The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The styles to set on the paragraphs. Certain paragraph style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of ParagraphStyle for more information. */ @@ -2765,7 +2783,7 @@ export namespace docs_v1 { /** * The fields that should be updated. At least one field must be specified. The root `tableCellStyle` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the table cell background color, set `fields` to `"backgroundColor"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The style to set on the table cells. When updating borders, if a cell shares a border with an adjacent cell, the corresponding border property of the adjacent cell is updated as well. Borders that are merged and invisible are not updated. Since updating a border shared by adjacent cells in the same request can cause conflicting border updates, border updates are applied in the following order: - `border_right` - `border_left` - `border_bottom` - `border_top` */ @@ -2786,11 +2804,11 @@ export namespace docs_v1 { /** * The list of zero-based column indices whose property should be updated. If no indices are specified, all columns will be updated. */ - columnIndices?: number[]; + columnIndices?: number[] | null; /** * The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `"width"`. */ - fields?: string; + fields?: string | null; /** * The table column properties to update. If the value of `table_column_properties#width` is less than 5 points (5/72 inch), a 400 bad request error is returned. */ @@ -2807,11 +2825,11 @@ export namespace docs_v1 { /** * The fields that should be updated. At least one field must be specified. The root `tableRowStyle` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `"min_row_height"`. */ - fields?: string; + fields?: string | null; /** * The list of zero-based row indices whose style should be updated. If no indices are specified, all rows will be updated. */ - rowIndices?: number[]; + rowIndices?: number[] | null; /** * The styles to be set on the rows. */ @@ -2828,7 +2846,7 @@ export namespace docs_v1 { /** * The fields that should be updated. At least one field must be specified. The root `text_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `"bold"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The range of text to style. The range may be extended to include adjacent newlines. If the range fully contains a paragraph belonging to a list, the paragraph's bullet is also updated with the matching text style. Ranges cannot be inserted inside a relative UpdateTextStyleRequest. */ @@ -2845,11 +2863,11 @@ export namespace docs_v1 { /** * The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. */ - fontFamily?: string; + fontFamily?: string | null; /** * The weight of the font. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. The rendered weight is determined by a combination of the `weight` and the text style's resolved `bold` value, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. */ - weight?: number; + weight?: number | null; } /** * Provides control over how write requests are executed. @@ -2858,11 +2876,11 @@ export namespace docs_v1 { /** * The revision ID of the document that the write request will be applied to. If this is not the latest revision of the document, the request will not be processed and will return a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied. */ - requiredRevisionId?: string; + requiredRevisionId?: string | null; /** * The target revision ID of the document that the write request will be applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request will be transformed against the collaborator changes. This results in a new revision of the document which incorporates both the changes in the request and the collaborator changes, and the Docs server will resolve conflicting changes. When using `target_revision_id`, the API client can be thought of as another collaborator of the document. The target revision ID may only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request will not be processed and will return a 400 bad request error and the request should be retried after reading the latest version of the document. In most cases a `revision_id` will remain valid for use as a target revision for several minutes after it is read, but for frequently-edited documents this window may be shorter. */ - targetRevisionId?: string; + targetRevisionId?: string | null; } export class Resource$Documents { diff --git a/src/apis/domainsrdap/v1.ts b/src/apis/domainsrdap/v1.ts index d8bbb9a66a5..59d8e00648b 100644 --- a/src/apis/domainsrdap/v1.ts +++ b/src/apis/domainsrdap/v1.ts @@ -134,15 +134,15 @@ export namespace domainsrdap_v1 { /** * The HTTP Content-Type header value specifying the content type of the body. */ - contentType?: string; + contentType?: string | null; /** * The HTTP request/response body as raw binary. */ - data?: string; + data?: string | null; /** * Application specific response metadata. Must be set in the first response for streaming APIs. */ - extensions?: Array<{[key: string]: any}>; + extensions?: Array<{[key: string]: any}> | null; } /** * Links object defined in [section 4.2 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.2). @@ -151,31 +151,31 @@ export namespace domainsrdap_v1 { /** * Target URL of a link. Example: "http://example.com/previous". */ - href?: string; + href?: string | null; /** * Language code of a link. Example: "en". */ - hreflang?: string; + hreflang?: string | null; /** * Media type of the link destination. Example: "screen". */ - media?: string; + media?: string | null; /** * Relation type of a link. Example: "previous". */ - rel?: string; + rel?: string | null; /** * Title of this link. Example: "title". */ - title?: string; + title?: string | null; /** * Content type of the link. Example: "application/json". */ - type?: string; + type?: string | null; /** * URL giving context for the link. Example: "http://example.com/current". */ - value?: string; + value?: string | null; } /** * Notices object defined in [section 4.3 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.3). @@ -184,7 +184,7 @@ export namespace domainsrdap_v1 { /** * Description of the notice. */ - description?: string[]; + description?: string[] | null; /** * Link to a document containing more information. */ @@ -192,11 +192,11 @@ export namespace domainsrdap_v1 { /** * Title of a notice. Example: "Terms of Service". */ - title?: string; + title?: string | null; /** * Type values defined in [section 10.2.1 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a whole response: "result set truncated due to authorization", "result set truncated due to excessive load", "result set truncated due to unexplainable reasons". */ - type?: string; + type?: string | null; } /** * Response to a general RDAP query. @@ -205,11 +205,11 @@ export namespace domainsrdap_v1 { /** * Error description. */ - description?: string[]; + description?: string[] | null; /** * Error HTTP code. Example: "501". */ - errorCode?: number; + errorCode?: number | null; /** * HTTP response with content type set to "application/json+rdap". */ @@ -217,7 +217,7 @@ export namespace domainsrdap_v1 { /** * Error language code. Error response info fields are defined in [section 6 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6). */ - lang?: string; + lang?: string | null; /** * Notices applying to this response. */ @@ -225,11 +225,11 @@ export namespace domainsrdap_v1 { /** * RDAP conformance level. */ - rdapConformance?: string[]; + rdapConformance?: string[] | null; /** * Error title. */ - title?: string; + title?: string | null; } export class Resource$Autnum { diff --git a/src/apis/doubleclickbidmanager/v1.ts b/src/apis/doubleclickbidmanager/v1.ts index 55785bcfa90..8963a89cfb1 100644 --- a/src/apis/doubleclickbidmanager/v1.ts +++ b/src/apis/doubleclickbidmanager/v1.ts @@ -114,19 +114,19 @@ export namespace doubleclickbidmanager_v1 { /** * File specification (column names, types, order) in which the line items will be returned. Default to EWF. */ - fileSpec?: string; + fileSpec?: string | null; /** * Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned. */ - filterIds?: string[]; + filterIds?: string[] | null; /** * Filter type used to filter line items to fetch. */ - filterType?: string; + filterType?: string | null; /** * Format in which the line items will be returned. Default to CSV. */ - format?: string; + format?: string | null; } /** * Download line items response. @@ -135,7 +135,7 @@ export namespace doubleclickbidmanager_v1 { /** * Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format. */ - lineItems?: string; + lineItems?: string | null; } /** * Request to fetch stored inventory sources, campaigns, insertion orders, line items, TrueView ad groups and ads. @@ -144,19 +144,19 @@ export namespace doubleclickbidmanager_v1 { /** * File types that will be returned. If INVENTORY_SOURCE is requested, no other file types may be requested. Acceptable values are: - "AD" - "AD_GROUP" - "CAMPAIGN" - "INSERTION_ORDER" - "INVENTORY_SOURCE" - "LINE_ITEM" */ - fileTypes?: string[]; + fileTypes?: string[] | null; /** * The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified. */ - filterIds?: string[]; + filterIds?: string[] | null; /** * Filter type used to filter entities to fetch. PARTNER_ID and INVENTORY_SOURCE_ID may only be used when downloading inventory sources. */ - filterType?: string; + filterType?: string | null; /** * SDF Version (column names, types, order) in which the entities will be returned. Default to 3.1. */ - version?: string; + version?: string | null; } /** * Download response. @@ -165,24 +165,24 @@ export namespace doubleclickbidmanager_v1 { /** * Retrieved ad groups in SDF format. */ - adGroups?: string; + adGroups?: string | null; /** * Retrieved ads in SDF format. */ - ads?: string; + ads?: string | null; /** * Retrieved campaigns in SDF format. */ - campaigns?: string; + campaigns?: string | null; /** * Retrieved insertion orders in SDF format. */ - insertionOrders?: string; - inventorySources?: string; + insertionOrders?: string | null; + inventorySources?: string | null; /** * Retrieved line items in SDF format. */ - lineItems?: string; + lineItems?: string | null; } /** * Filter used to match traffic data in your report. @@ -191,11 +191,11 @@ export namespace doubleclickbidmanager_v1 { /** * Filter type. */ - type?: string; + type?: string | null; /** * Filter value. */ - value?: string; + value?: string | null; } /** * List queries response. @@ -204,7 +204,7 @@ export namespace doubleclickbidmanager_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse". */ - kind?: string; + kind?: string | null; /** * Retrieved queries. */ @@ -217,7 +217,7 @@ export namespace doubleclickbidmanager_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listReportsResponse". */ - kind?: string; + kind?: string | null; /** * Retrieved reports. */ @@ -234,19 +234,19 @@ export namespace doubleclickbidmanager_v1 { /** * Data is grouped by the filters listed in this field. */ - groupBys?: string[]; + groupBys?: string[] | null; /** * Deprecated. This field is no longer in use. */ - includeInviteData?: boolean; + includeInviteData?: boolean | null; /** * Metrics to include as columns in your report. */ - metrics?: string[]; + metrics?: string[] | null; /** * Report type. */ - type?: string; + type?: string | null; } /** * Represents a query. @@ -255,7 +255,7 @@ export namespace doubleclickbidmanager_v1 { /** * Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". */ - kind?: string; + kind?: string | null; /** * Query metadata. */ @@ -267,15 +267,15 @@ export namespace doubleclickbidmanager_v1 { /** * Query ID. */ - queryId?: string; + queryId?: string | null; /** * The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise. */ - reportDataEndTimeMs?: string; + reportDataEndTimeMs?: string | null; /** * The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise. */ - reportDataStartTimeMs?: string; + reportDataStartTimeMs?: string | null; /** * Information on how often and when to run a query. */ @@ -283,7 +283,7 @@ export namespace doubleclickbidmanager_v1 { /** * Canonical timezone code for report data time. Defaults to America/New_York. */ - timezoneCode?: string; + timezoneCode?: string | null; } /** * Query metadata. @@ -292,47 +292,47 @@ export namespace doubleclickbidmanager_v1 { /** * Range of report data. */ - dataRange?: string; + dataRange?: string | null; /** * Format of the generated report. */ - format?: string; + format?: string | null; /** * The path to the location in Google Cloud Storage where the latest report is stored. */ - googleCloudStoragePathForLatestReport?: string; + googleCloudStoragePathForLatestReport?: string | null; /** * The path in Google Drive for the latest report. */ - googleDrivePathForLatestReport?: string; + googleDrivePathForLatestReport?: string | null; /** * The time when the latest report started to run. */ - latestReportRunTimeMs?: string; + latestReportRunTimeMs?: string | null; /** * Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English. */ - locale?: string; + locale?: string | null; /** * Number of reports that have been generated for the query. */ - reportCount?: number; + reportCount?: number | null; /** * Whether the latest report is currently running. */ - running?: boolean; + running?: boolean | null; /** * Whether to send an email notification when a report is ready. Default to false. */ - sendNotification?: boolean; + sendNotification?: boolean | null; /** * List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. */ - shareEmailAddress?: string[]; + shareEmailAddress?: string[] | null; /** * Query title. It is used to name the reports generated from this query. */ - title?: string; + title?: string | null; } /** * Information on how frequently and when to run a query. @@ -341,19 +341,19 @@ export namespace doubleclickbidmanager_v1 { /** * Datetime to periodically run the query until. */ - endTimeMs?: string; + endTimeMs?: string | null; /** * How often the query is run. */ - frequency?: string; + frequency?: string | null; /** * Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports. */ - nextRunMinuteOfDay?: number; + nextRunMinuteOfDay?: number | null; /** * Canonical timezone code for report generation time. Defaults to America/New_York. */ - nextRunTimezoneCode?: string; + nextRunTimezoneCode?: string | null; } /** * Represents a report. @@ -379,7 +379,7 @@ export namespace doubleclickbidmanager_v1 { /** * Error code that shows why the report was not created. */ - errorCode?: string; + errorCode?: string | null; } /** * Key used to identify a report. @@ -388,11 +388,11 @@ export namespace doubleclickbidmanager_v1 { /** * Query ID. */ - queryId?: string; + queryId?: string | null; /** * Report ID. */ - reportId?: string; + reportId?: string | null; } /** * Report metadata. @@ -401,15 +401,15 @@ export namespace doubleclickbidmanager_v1 { /** * The path to the location in Google Cloud Storage where the report is stored. */ - googleCloudStoragePath?: string; + googleCloudStoragePath?: string | null; /** * The ending time for the data that is shown in the report. */ - reportDataEndTimeMs?: string; + reportDataEndTimeMs?: string | null; /** * The starting time for the data that is shown in the report. */ - reportDataStartTimeMs?: string; + reportDataStartTimeMs?: string | null; /** * Report status. */ @@ -426,15 +426,15 @@ export namespace doubleclickbidmanager_v1 { /** * The time when this report either completed successfully or failed. */ - finishTimeMs?: string; + finishTimeMs?: string | null; /** * The file type of the report. */ - format?: string; + format?: string | null; /** * The state of the report. */ - state?: string; + state?: string | null; } /** * Represents the upload status of a row in the request. @@ -443,27 +443,27 @@ export namespace doubleclickbidmanager_v1 { /** * Whether the stored entity is changed as a result of upload. */ - changed?: boolean; + changed?: boolean | null; /** * Entity Id. */ - entityId?: string; + entityId?: string | null; /** * Entity name. */ - entityName?: string; + entityName?: string | null; /** * Reasons why the entity can't be uploaded. */ - errors?: string[]; + errors?: string[] | null; /** * Whether the entity is persisted. */ - persisted?: boolean; + persisted?: boolean | null; /** * Row number. */ - rowNumber?: number; + rowNumber?: number | null; } /** * Request to run a stored query to generate a report. @@ -472,19 +472,19 @@ export namespace doubleclickbidmanager_v1 { /** * Report data range used to generate the report. */ - dataRange?: string; + dataRange?: string | null; /** * The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise. */ - reportDataEndTimeMs?: string; + reportDataEndTimeMs?: string | null; /** * The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise. */ - reportDataStartTimeMs?: string; + reportDataStartTimeMs?: string | null; /** * Canonical timezone code for report data time. Defaults to America/New_York. */ - timezoneCode?: string; + timezoneCode?: string | null; } /** * Request to upload line items. @@ -493,15 +493,15 @@ export namespace doubleclickbidmanager_v1 { /** * Set to true to get upload status without actually persisting the line items. */ - dryRun?: boolean; + dryRun?: boolean | null; /** * Format the line items are in. Default to CSV. */ - format?: string; + format?: string | null; /** * Line items in CSV to upload. Refer to Entity Write File Format for more information on file format. */ - lineItems?: string; + lineItems?: string | null; } /** * Upload line items response. @@ -519,7 +519,7 @@ export namespace doubleclickbidmanager_v1 { /** * Reasons why upload can't be completed. */ - errors?: string[]; + errors?: string[] | null; /** * Per-row upload status. */ diff --git a/src/apis/doubleclicksearch/v2.ts b/src/apis/doubleclicksearch/v2.ts index 32dfcb380cf..e1b51810b6e 100644 --- a/src/apis/doubleclicksearch/v2.ts +++ b/src/apis/doubleclicksearch/v2.ts @@ -112,27 +112,27 @@ export namespace doubleclicksearch_v2 { /** * DS advertiser ID. */ - advertiserId?: string; + advertiserId?: string | null; /** * DS agency ID. */ - agencyId?: string; + agencyId?: string | null; /** * The time by which all conversions have been uploaded, in epoch millis UTC. */ - availabilityTimestamp?: string; + availabilityTimestamp?: string | null; /** * The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). */ - segmentationId?: string; + segmentationId?: string | null; /** * The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). */ - segmentationName?: string; + segmentationName?: string | null; /** * The segmentation type that this availability is for (its default value is FLOODLIGHT). */ - segmentationType?: string; + segmentationType?: string | null; } /** * A conversion containing data relevant to DoubleClick Search. @@ -141,59 +141,59 @@ export namespace doubleclicksearch_v2 { /** * DS ad group ID. */ - adGroupId?: string; + adGroupId?: string | null; /** * DS ad ID. */ - adId?: string; + adId?: string | null; /** * DS advertiser ID. */ - advertiserId?: string; + advertiserId?: string | null; /** * DS agency ID. */ - agencyId?: string; + agencyId?: string | null; /** * Available to advertisers only after contacting DoubleClick Search customer support. */ - attributionModel?: string; + attributionModel?: string | null; /** * DS campaign ID. */ - campaignId?: string; + campaignId?: string | null; /** * Sales channel for the product. Acceptable values are: - "local": a physical store - "online": an online store */ - channel?: string; + channel?: string | null; /** * DS click ID for the conversion. */ - clickId?: string; + clickId?: string | null; /** * For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. */ - conversionId?: string; + conversionId?: string | null; /** * The time at which the conversion was last modified, in epoch millis UTC. */ - conversionModifiedTimestamp?: string; + conversionModifiedTimestamp?: string | null; /** * The time at which the conversion took place, in epoch millis UTC. */ - conversionTimestamp?: string; + conversionTimestamp?: string | null; /** * Available to advertisers only after contacting DoubleClick Search customer support. */ - countMillis?: string; + countMillis?: string | null; /** * DS criterion (keyword) ID. */ - criterionId?: string; + criterionId?: string | null; /** * The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. */ - currencyCode?: string; + currencyCode?: string | null; /** * Custom dimensions for the conversion, which can be used to filter data in a report. */ @@ -205,71 +205,71 @@ export namespace doubleclicksearch_v2 { /** * The type of device on which the conversion occurred. */ - deviceType?: string; + deviceType?: string | null; /** * ID that DoubleClick Search generates for each conversion. */ - dsConversionId?: string; + dsConversionId?: string | null; /** * DS engine account ID. */ - engineAccountId?: string; + engineAccountId?: string | null; /** * The Floodlight order ID provided by the advertiser for the conversion. */ - floodlightOrderId?: string; + floodlightOrderId?: string | null; /** * ID that DS generates and uses to uniquely identify the inventory account that contains the product. */ - inventoryAccountId?: string; + inventoryAccountId?: string | null; /** * The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. */ - productCountry?: string; + productCountry?: string | null; /** * DS product group ID. */ - productGroupId?: string; + productGroupId?: string | null; /** * The product ID (SKU). */ - productId?: string; + productId?: string | null; /** * The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. */ - productLanguage?: string; + productLanguage?: string | null; /** * The quantity of this conversion, in millis. */ - quantityMillis?: string; + quantityMillis?: string | null; /** * The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. */ - revenueMicros?: string; + revenueMicros?: string | null; /** * The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). */ - segmentationId?: string; + segmentationId?: string | null; /** * The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). */ - segmentationName?: string; + segmentationName?: string | null; /** * The segmentation type of this conversion (for example, FLOODLIGHT). */ - segmentationType?: string; + segmentationType?: string | null; /** * The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. */ - state?: string; + state?: string | null; /** * The ID of the local store for which the product was advertised. Applicable only when the channel is "local". */ - storeId?: string; + storeId?: string | null; /** * The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). */ - type?: string; + type?: string | null; } /** * A list of conversions. @@ -282,7 +282,7 @@ export namespace doubleclicksearch_v2 { /** * Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. */ - kind?: string; + kind?: string | null; } /** * A message containing the custome dimension. @@ -291,11 +291,11 @@ export namespace doubleclicksearch_v2 { /** * Custom dimension name. */ - name?: string; + name?: string | null; /** * Custom dimension value. */ - value?: string; + value?: string | null; } /** * A message containing the custome metric. @@ -304,11 +304,11 @@ export namespace doubleclicksearch_v2 { /** * Custom metric name. */ - name?: string; + name?: string | null; /** * Custom metric numeric value. */ - value?: number; + value?: number | null; } /** * A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files. @@ -317,19 +317,19 @@ export namespace doubleclicksearch_v2 { /** * Asynchronous report only. Contains a list of generated report files once the report has successfully completed. */ - files?: Array<{byteCount?: string; url?: string}>; + files?: Array<{byteCount?: string; url?: string}> | null; /** * Asynchronous report only. Id of the report. */ - id?: string; + id?: string | null; /** * Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded. */ - isReportReady?: boolean; + isReportReady?: boolean | null; /** * Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report. */ - kind?: string; + kind?: string | null; /** * The request that created the report. Optional fields not specified in the original request are filled with default values. */ @@ -337,7 +337,7 @@ export namespace doubleclicksearch_v2 { /** * The number of report rows generated by the report, not including headers. */ - rowCount?: number; + rowCount?: number | null; /** * Synchronous report only. Generated report rows. */ @@ -345,11 +345,11 @@ export namespace doubleclicksearch_v2 { /** * The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the statisticsCurrency field of the report request. */ - statisticsCurrencyCode?: string; + statisticsCurrencyCode?: string | null; /** * If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset. */ - statisticsTimeZone?: string; + statisticsTimeZone?: string | null; } /** * A request object used to create a DoubleClick Search report. @@ -358,43 +358,43 @@ export namespace doubleclicksearch_v2 { /** * Name of a DoubleClick Search column to include in the report. */ - columnName?: string; + columnName?: string | null; /** * Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report. */ - customDimensionName?: string; + customDimensionName?: string | null; /** * Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. */ - customMetricName?: string; + customMetricName?: string | null; /** * Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. */ - endDate?: string; + endDate?: string | null; /** * Synchronous report only. Set to true to group by this column. Defaults to false. */ - groupByColumn?: boolean; + groupByColumn?: boolean | null; /** * Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. */ - headerText?: string; + headerText?: string | null; /** * The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". */ - platformSource?: string; + platformSource?: string | null; /** * Returns metrics only for a specific type of product activity. Accepted values are: - "sold": returns metrics only for products that were sold - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold */ - productReportPerspective?: string; + productReportPerspective?: string | null; /** * Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. */ - savedColumnName?: string; + savedColumnName?: string | null; /** * Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. */ - startDate?: string; + startDate?: string | null; } /** * A request object used to create a DoubleClick Search report. @@ -407,7 +407,7 @@ export namespace doubleclicksearch_v2 { /** * Format that the report should be returned in. Currently csv or tsv is supported. */ - downloadFormat?: string; + downloadFormat?: string | null; /** * A list of filters to be applied to the report. The maximum number of filters per request is 300. */ @@ -415,23 +415,26 @@ export namespace doubleclicksearch_v2 { column?: Schema$ReportApiColumnSpec; operator?: string; values?: any[]; - }>; + }> | null; /** * Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead. */ - includeDeletedEntities?: boolean; + includeDeletedEntities?: boolean | null; /** * Determines if removed entities should be included in the report. Defaults to false. */ - includeRemovedEntities?: boolean; + includeRemovedEntities?: boolean | null; /** * Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive. */ - maxRowsPerFile?: number; + maxRowsPerFile?: number | null; /** * Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows. The maximum number of orderings per request is 300. */ - orderBy?: Array<{column?: Schema$ReportApiColumnSpec; sortOrder?: string}>; + orderBy?: Array<{ + column?: Schema$ReportApiColumnSpec; + sortOrder?: string; + }> | null; /** * The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required. */ @@ -443,23 +446,23 @@ export namespace doubleclicksearch_v2 { campaignId?: string; engineAccountId?: string; keywordId?: string; - }; + } | null; /** * Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type. */ - reportType?: string; + reportType?: string | null; /** * Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000. */ - rowCount?: number; + rowCount?: number | null; /** * Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0. */ - startRow?: number; + startRow?: number | null; /** * Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower). */ - statisticsCurrency?: string; + statisticsCurrency?: string | null; /** * If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range. */ @@ -468,11 +471,11 @@ export namespace doubleclicksearch_v2 { changedMetricsSinceTimestamp?: string; endDate?: string; startDate?: string; - }; + } | null; /** * If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false. */ - verifySingleTimeZone?: boolean; + verifySingleTimeZone?: boolean | null; } /** * A row in a DoubleClick Search report. @@ -485,15 +488,15 @@ export namespace doubleclicksearch_v2 { /** * Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn. */ - kind?: string; + kind?: string | null; /** * The name of the saved column. */ - savedColumnName?: string; + savedColumnName?: string | null; /** * The type of data this saved column will produce. */ - type?: string; + type?: string | null; } /** * A list of saved columns. Advertisers create saved columns to report on Floodlight activities, Google Analytics goals, or custom KPIs. To request reports with saved columns, you'll need the saved column names that are available from this list. @@ -506,7 +509,7 @@ export namespace doubleclicksearch_v2 { /** * Identifies this as a SavedColumnList resource. Value: the fixed string doubleclicksearch#savedColumnList. */ - kind?: string; + kind?: string | null; } /** * The request to update availability. diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 8e0607a6dea..6d59dc449ae 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -139,19 +139,19 @@ export namespace drive_v2 { additionalRoleInfo?: Array<{ roleSets?: Array<{additionalRoles?: string[]; primaryRole?: string}>; type?: string; - }>; + }> | null; /** * Whether the user can create shared drives. */ - canCreateDrives?: boolean; + canCreateDrives?: boolean | null; /** * Deprecated - use canCreateDrives instead. */ - canCreateTeamDrives?: boolean; + canCreateTeamDrives?: boolean | null; /** * The domain sharing policy for the current user. Possible values are: - allowed - allowedWithWarning - incomingOnly - disallowed */ - domainSharingPolicy?: string; + domainSharingPolicy?: string | null; /** * A list of themes that are supported for shared drives. */ @@ -159,91 +159,94 @@ export namespace drive_v2 { backgroundImageLink?: string; colorRgb?: string; id?: string; - }>; + }> | null; /** * The ETag of the item. */ - etag?: string; + etag?: string | null; /** * The allowable export formats. */ - exportFormats?: Array<{source?: string; targets?: string[]}>; + exportFormats?: Array<{source?: string; targets?: string[]}> | null; /** * List of additional features enabled on this account. */ - features?: Array<{featureName?: string; featureRate?: number}>; + features?: Array<{featureName?: string; featureRate?: number}> | null; /** * The palette of allowable folder colors as RGB hex strings. */ - folderColorPalette?: string[]; + folderColorPalette?: string[] | null; /** * The allowable import formats. */ - importFormats?: Array<{source?: string; targets?: string[]}>; + importFormats?: Array<{source?: string; targets?: string[]}> | null; /** * A boolean indicating whether the authenticated app is installed by the authenticated user. */ - isCurrentAppInstalled?: boolean; + isCurrentAppInstalled?: boolean | null; /** * This is always drive#about. */ - kind?: string; + kind?: string | null; /** * The user's language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/). */ - languageCode?: string; + languageCode?: string | null; /** * The largest change id. */ - largestChangeId?: string; + largestChangeId?: string | null; /** * List of max upload sizes for each file type. The most specific type takes precedence. */ - maxUploadSizes?: Array<{size?: string; type?: string}>; + maxUploadSizes?: Array<{size?: string; type?: string}> | null; /** * The name of the current user. */ - name?: string; + name?: string | null; /** * The current user's ID as visible in the permissions collection. */ - permissionId?: string; + permissionId?: string | null; /** * The amount of storage quota used by different Google services. */ - quotaBytesByService?: Array<{bytesUsed?: string; serviceName?: string}>; + quotaBytesByService?: Array<{ + bytesUsed?: string; + serviceName?: string; + }> | null; /** * The total number of quota bytes. */ - quotaBytesTotal?: string; + quotaBytesTotal?: string | null; /** * The number of quota bytes used by Google Drive. */ - quotaBytesUsed?: string; + quotaBytesUsed?: string | null; /** * The number of quota bytes used by all Google apps (Drive, Picasa, etc.). */ - quotaBytesUsedAggregate?: string; + quotaBytesUsedAggregate?: string | null; /** * The number of quota bytes used by trashed items. */ - quotaBytesUsedInTrash?: string; + quotaBytesUsedInTrash?: string | null; /** * The type of the user's storage quota. Possible values are: - LIMITED - UNLIMITED */ - quotaType?: string; + quotaType?: string | null; /** * The number of remaining change ids, limited to no more than 2500. */ - remainingChangeIds?: string; + remainingChangeIds?: string | null; /** * The id of the root folder. */ - rootFolderId?: string; + rootFolderId?: string | null; /** * A link back to this item. */ - selfLink?: string; + selfLink?: string | null; /** * Deprecated - use driveThemes instead. */ @@ -251,7 +254,7 @@ export namespace drive_v2 { backgroundImageLink?: string; colorRgb?: string; id?: string; - }>; + }> | null; /** * The authenticated user. */ @@ -264,99 +267,99 @@ export namespace drive_v2 { /** * Whether the app is authorized to access data on the user's Drive. */ - authorized?: boolean; + authorized?: boolean | null; /** * The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in. */ - createInFolderTemplate?: string; + createInFolderTemplate?: string | null; /** * The url to create a new file with this app. */ - createUrl?: string; + createUrl?: string | null; /** * Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive. */ - hasDriveWideScope?: boolean; + hasDriveWideScope?: boolean | null; /** * The various icons for the app. */ - icons?: Array<{category?: string; iconUrl?: string; size?: number}>; + icons?: Array<{category?: string; iconUrl?: string; size?: number}> | null; /** * The ID of the app. */ - id?: string; + id?: string | null; /** * Whether the app is installed. */ - installed?: boolean; + installed?: boolean | null; /** * This is always drive#app. */ - kind?: string; + kind?: string | null; /** * A long description of the app. */ - longDescription?: string; + longDescription?: string | null; /** * The name of the app. */ - name?: string; + name?: string | null; /** * The type of object this app creates (e.g. Chart). If empty, the app name should be used instead. */ - objectType?: string; + objectType?: string | null; /** * The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation. */ - openUrlTemplate?: string; + openUrlTemplate?: string | null; /** * The list of primary file extensions. */ - primaryFileExtensions?: string[]; + primaryFileExtensions?: string[] | null; /** * The list of primary mime types. */ - primaryMimeTypes?: string[]; + primaryMimeTypes?: string[] | null; /** * The ID of the product listing for this app. */ - productId?: string; + productId?: string | null; /** * A link to the product listing for this app. */ - productUrl?: string; + productUrl?: string | null; /** * The list of secondary file extensions. */ - secondaryFileExtensions?: string[]; + secondaryFileExtensions?: string[] | null; /** * The list of secondary mime types. */ - secondaryMimeTypes?: string[]; + secondaryMimeTypes?: string[] | null; /** * A short description of the app. */ - shortDescription?: string; + shortDescription?: string | null; /** * Whether this app supports creating new objects. */ - supportsCreate?: boolean; + supportsCreate?: boolean | null; /** * Whether this app supports importing Google Docs. */ - supportsImport?: boolean; + supportsImport?: boolean | null; /** * Whether this app supports opening more than one file. */ - supportsMultiOpen?: boolean; + supportsMultiOpen?: boolean | null; /** * Whether this app supports creating new files when offline. */ - supportsOfflineCreate?: boolean; + supportsOfflineCreate?: boolean | null; /** * Whether the app is selected as the default handler for the types it supports. */ - useByDefault?: boolean; + useByDefault?: boolean | null; } /** * A list of third-party applications which the user has installed or given access to Google Drive. @@ -365,11 +368,11 @@ export namespace drive_v2 { /** * List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest). */ - defaultAppIds?: string[]; + defaultAppIds?: string[] | null; /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * The list of apps. */ @@ -377,11 +380,11 @@ export namespace drive_v2 { /** * This is always drive#appList. */ - kind?: string; + kind?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * Representation of a change to a file or shared drive. @@ -390,11 +393,11 @@ export namespace drive_v2 { /** * The type of the change. Possible values are file and drive. */ - changeType?: string; + changeType?: string | null; /** * Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. */ - deleted?: boolean; + deleted?: boolean | null; /** * The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. */ @@ -402,7 +405,7 @@ export namespace drive_v2 { /** * The ID of the shared drive associated with this change. */ - driveId?: string; + driveId?: string | null; /** * The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. */ @@ -410,23 +413,23 @@ export namespace drive_v2 { /** * The ID of the file associated with this change. */ - fileId?: string; + fileId?: string | null; /** * The ID of the change. */ - id?: string; + id?: string | null; /** * This is always drive#change. */ - kind?: string; + kind?: string | null; /** * The time of this modification. */ - modificationDate?: string; + modificationDate?: string | null; /** * A link back to this change. */ - selfLink?: string; + selfLink?: string | null; /** * Deprecated - use drive instead. */ @@ -434,11 +437,11 @@ export namespace drive_v2 { /** * Deprecated - use driveId instead. */ - teamDriveId?: string; + teamDriveId?: string | null; /** * Deprecated - use changeType instead. */ - type?: string; + type?: string | null; } /** * A list of changes for a user. @@ -447,7 +450,7 @@ export namespace drive_v2 { /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -455,27 +458,27 @@ export namespace drive_v2 { /** * This is always drive#changeList. */ - kind?: string; + kind?: string | null; /** * The current largest change ID. */ - largestChangeId?: string; + largestChangeId?: string | null; /** * The starting page token for future changes. This will be present only if the end of the current changes list has been reached. */ - newStartPageToken?: string; + newStartPageToken?: string | null; /** * A link to the next page of changes. */ - nextLink?: string; + nextLink?: string | null; /** * The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * An notification channel used to watch for resource changes. @@ -484,43 +487,43 @@ export namespace drive_v2 { /** * The address where notifications are delivered for this channel. */ - address?: string; + address?: string | null; /** * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ - expiration?: string; + expiration?: string | null; /** * A UUID or similar unique string that identifies this channel. */ - id?: string; + id?: string | null; /** * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ - kind?: string; + kind?: string | null; /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: {[key: string]: string}; + params?: {[key: string]: string} | null; /** * A Boolean value to indicate whether payload is wanted. Optional. */ - payload?: boolean; + payload?: boolean | null; /** * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ - resourceId?: string; + resourceId?: string | null; /** * A version-specific identifier for the watched resource. */ - resourceUri?: string; + resourceUri?: string | null; /** * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ - token?: string; + token?: string | null; /** * The type of delivery mechanism used for this channel. */ - type?: string; + type?: string | null; } /** * A list of children of a file. @@ -529,7 +532,7 @@ export namespace drive_v2 { /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -537,19 +540,19 @@ export namespace drive_v2 { /** * This is always drive#childList. */ - kind?: string; + kind?: string | null; /** * A link to the next page of children. */ - nextLink?: string; + nextLink?: string | null; /** * The page token for the next page of children. This will be absent if the end of the children list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * A reference to a folder's child. @@ -558,19 +561,19 @@ export namespace drive_v2 { /** * A link to the child. */ - childLink?: string; + childLink?: string | null; /** * The ID of the child. */ - id?: string; + id?: string | null; /** * This is always drive#childReference. */ - kind?: string; + kind?: string | null; /** * A link back to this reference. */ - selfLink?: string; + selfLink?: string | null; } /** * A comment on a file in Google Drive. @@ -579,7 +582,7 @@ export namespace drive_v2 { /** * A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. */ - anchor?: string; + anchor?: string | null; /** * The user who wrote this comment. */ @@ -587,43 +590,43 @@ export namespace drive_v2 { /** * The ID of the comment. */ - commentId?: string; + commentId?: string | null; /** * The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. */ - content?: string; + content?: string | null; /** * The context of the file which is being commented on. */ - context?: {type?: string; value?: string}; + context?: {type?: string; value?: string} | null; /** * The date when this comment was first created. */ - createdDate?: string; + createdDate?: string | null; /** * Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. */ - deleted?: boolean; + deleted?: boolean | null; /** * The file which this comment is addressing. */ - fileId?: string; + fileId?: string | null; /** * The title of the file which this comment is addressing. */ - fileTitle?: string; + fileTitle?: string | null; /** * HTML formatted content for this comment. */ - htmlContent?: string; + htmlContent?: string | null; /** * This is always drive#comment. */ - kind?: string; + kind?: string | null; /** * The date when this comment or any of its replies were last modified. */ - modifiedDate?: string; + modifiedDate?: string | null; /** * Replies to this post. */ @@ -631,11 +634,11 @@ export namespace drive_v2 { /** * A link back to this comment. */ - selfLink?: string; + selfLink?: string | null; /** * The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - "open" - The comment is still open. - "resolved" - The comment has been resolved by one of its replies. */ - status?: string; + status?: string | null; } /** * A list of comments on a file in Google Drive. @@ -648,19 +651,19 @@ export namespace drive_v2 { /** * This is always drive#commentList. */ - kind?: string; + kind?: string | null; /** * A link to the next page of comments. */ - nextLink?: string; + nextLink?: string | null; /** * The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * A comment on a file in Google Drive. @@ -673,35 +676,35 @@ export namespace drive_v2 { /** * The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). */ - content?: string; + content?: string | null; /** * The date when this reply was first created. */ - createdDate?: string; + createdDate?: string | null; /** * Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. */ - deleted?: boolean; + deleted?: boolean | null; /** * HTML formatted content for this reply. */ - htmlContent?: string; + htmlContent?: string | null; /** * This is always drive#commentReply. */ - kind?: string; + kind?: string | null; /** * The date when this reply was last modified. */ - modifiedDate?: string; + modifiedDate?: string | null; /** * The ID of the reply. */ - replyId?: string; + replyId?: string | null; /** * The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - "resolve" - To resolve a comment. - "reopen" - To reopen (un-resolve) a comment. */ - verb?: string; + verb?: string | null; } /** * A list of replies to a comment on a file in Google Drive. @@ -714,19 +717,19 @@ export namespace drive_v2 { /** * This is always drive#commentReplyList. */ - kind?: string; + kind?: string | null; /** * A link to the next page of replies. */ - nextLink?: string; + nextLink?: string | null; /** * The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * Representation of a shared drive. @@ -740,11 +743,11 @@ export namespace drive_v2 { width?: number; xCoordinate?: number; yCoordinate?: number; - }; + } | null; /** * A short-lived link to this shared drive's background image. */ - backgroundImageLink?: string; + backgroundImageLink?: string | null; /** * Capabilities the current user has on this shared drive. */ @@ -767,31 +770,31 @@ export namespace drive_v2 { canRenameDrive?: boolean; canShare?: boolean; canTrashChildren?: boolean; - }; + } | null; /** * The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. */ - colorRgb?: string; + colorRgb?: string | null; /** * The time at which the shared drive was created (RFC 3339 date-time). */ - createdDate?: string; + createdDate?: string | null; /** * Whether the shared drive is hidden from default view. */ - hidden?: boolean; + hidden?: boolean | null; /** * The ID of this shared drive which is also the ID of the top level folder of this shared drive. */ - id?: string; + id?: string | null; /** * This is always drive#drive */ - kind?: string; + kind?: string | null; /** * The name of this shared drive. */ - name?: string; + name?: string | null; /** * A set of restrictions that apply to this shared drive or items inside this shared drive. */ @@ -800,11 +803,11 @@ export namespace drive_v2 { copyRequiresWriterPermission?: boolean; domainUsersOnly?: boolean; driveMembersOnly?: boolean; - }; + } | null; /** * The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ - themeId?: string; + themeId?: string | null; } /** * A list of shared drives. @@ -817,11 +820,11 @@ export namespace drive_v2 { /** * This is always drive#driveList */ - kind?: string; + kind?: string | null; /** * The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The metadata for a file. @@ -830,19 +833,19 @@ export namespace drive_v2 { /** * A link for opening the file in a relevant Google editor or viewer. */ - alternateLink?: string; + alternateLink?: string | null; /** * Whether this file is in the Application Data folder. */ - appDataContents?: boolean; + appDataContents?: boolean | null; /** * Deprecated: use capabilities/canComment. */ - canComment?: boolean; + canComment?: boolean | null; /** * Deprecated: use capabilities/canReadRevisions. */ - canReadRevisions?: boolean; + canReadRevisions?: boolean | null; /** * Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. */ @@ -877,91 +880,91 @@ export namespace drive_v2 { canTrash?: boolean; canTrashChildren?: boolean; canUntrash?: boolean; - }; + } | null; /** * Deprecated: use capabilities/canCopy. */ - copyable?: boolean; + copyable?: boolean | null; /** * Whether the options to copy, print, or download this file, should be disabled for readers and commenters. */ - copyRequiresWriterPermission?: boolean; + copyRequiresWriterPermission?: boolean | null; /** * Create time for this file (formatted RFC 3339 timestamp). */ - createdDate?: string; + createdDate?: string | null; /** * A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. */ - defaultOpenWithLink?: string; + defaultOpenWithLink?: string | null; /** * A short description of the file. */ - description?: string; + description?: string | null; /** * Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ - downloadUrl?: string; + downloadUrl?: string | null; /** * ID of the shared drive the file resides in. Only populated for items in shared drives. */ - driveId?: string; + driveId?: string | null; /** * Deprecated: use capabilities/canEdit. */ - editable?: boolean; + editable?: boolean | null; /** * A link for embedding the file. */ - embedLink?: string; + embedLink?: string | null; /** * ETag of the file. */ - etag?: string; + etag?: string | null; /** * Whether this file has been explicitly trashed, as opposed to recursively trashed. */ - explicitlyTrashed?: boolean; + explicitlyTrashed?: boolean | null; /** * Links for exporting Google Docs to specific formats. */ - exportLinks?: {[key: string]: string}; + exportLinks?: {[key: string]: string} | null; /** * The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ - fileExtension?: string; + fileExtension?: string | null; /** * The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ - fileSize?: string; + fileSize?: string | null; /** * Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. */ - folderColorRgb?: string; + folderColorRgb?: string | null; /** * The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ - fullFileExtension?: string; + fullFileExtension?: string | null; /** * Whether any users are granted file access directly on this file. This field is only populated for items in shared drives. */ - hasAugmentedPermissions?: boolean; + hasAugmentedPermissions?: boolean | null; /** * Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. */ - hasThumbnail?: boolean; + hasThumbnail?: boolean | null; /** * The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ - headRevisionId?: string; + headRevisionId?: string | null; /** * A link to the file's icon. */ - iconLink?: string; + iconLink?: string | null; /** * The ID of the file. */ - id?: string; + id?: string | null; /** * Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. */ @@ -987,19 +990,19 @@ export namespace drive_v2 { subjectDistance?: number; whiteBalance?: string; width?: number; - }; + } | null; /** * Indexable text attributes for the file (can only be written) */ - indexableText?: {text?: string}; + indexableText?: {text?: string} | null; /** * Whether the file was created or opened by the requesting app. */ - isAppAuthorized?: boolean; + isAppAuthorized?: boolean | null; /** * The type of file. This is always drive#file. */ - kind?: string; + kind?: string | null; /** * A group of labels for the file. */ @@ -1010,7 +1013,7 @@ export namespace drive_v2 { starred?: boolean; trashed?: boolean; viewed?: boolean; - }; + } | null; /** * The last user to modify this file. */ @@ -1018,47 +1021,47 @@ export namespace drive_v2 { /** * Name of the last user to modify this file. */ - lastModifyingUserName?: string; + lastModifyingUserName?: string | null; /** * Last time this file was viewed by the user (formatted RFC 3339 timestamp). */ - lastViewedByMeDate?: string; + lastViewedByMeDate?: string | null; /** * Deprecated. */ - markedViewedByMeDate?: string; + markedViewedByMeDate?: string | null; /** * An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ - md5Checksum?: string; + md5Checksum?: string | null; /** * The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. */ - mimeType?: string; + mimeType?: string | null; /** * Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. */ - modifiedByMeDate?: string; + modifiedByMeDate?: string | null; /** * Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. */ - modifiedDate?: string; + modifiedDate?: string | null; /** * A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. */ - openWithLinks?: {[key: string]: string}; + openWithLinks?: {[key: string]: string} | null; /** * The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. */ - originalFilename?: string; + originalFilename?: string | null; /** * Whether the file is owned by the current user. Not populated for items in shared drives. */ - ownedByMe?: boolean; + ownedByMe?: boolean | null; /** * Name(s) of the owner(s) of this file. Not populated for items in shared drives. */ - ownerNames?: string[]; + ownerNames?: string[] | null; /** * The owner(s) of this file. Not populated for items in shared drives. */ @@ -1070,7 +1073,7 @@ export namespace drive_v2 { /** * List of permission IDs for users with access to this file. */ - permissionIds?: string[]; + permissionIds?: string[] | null; /** * The list of permissions for users with access to this file. Not populated for items in shared drives. */ @@ -1082,23 +1085,23 @@ export namespace drive_v2 { /** * The number of quota bytes used by this file. */ - quotaBytesUsed?: string; + quotaBytesUsed?: string | null; /** * A link back to this file. */ - selfLink?: string; + selfLink?: string | null; /** * Deprecated: use capabilities/canShare. */ - shareable?: boolean; + shareable?: boolean | null; /** * Whether the file has been shared. Not populated for items in shared drives. */ - shared?: boolean; + shared?: boolean | null; /** * Time at which this file was shared with the user (formatted RFC 3339 timestamp). */ - sharedWithMeDate?: string; + sharedWithMeDate?: string | null; /** * User that shared the item with the current user, if available. */ @@ -1106,31 +1109,31 @@ export namespace drive_v2 { /** * The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. */ - spaces?: string[]; + spaces?: string[] | null; /** * Deprecated - use driveId instead. */ - teamDriveId?: string; + teamDriveId?: string | null; /** * A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. */ - thumbnail?: {image?: string; mimeType?: string}; + thumbnail?: {image?: string; mimeType?: string} | null; /** * A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. */ - thumbnailLink?: string; + thumbnailLink?: string | null; /** * The thumbnail version for use in thumbnail cache invalidation. */ - thumbnailVersion?: string; + thumbnailVersion?: string | null; /** * The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. */ - title?: string; + title?: string | null; /** * The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. */ - trashedDate?: string; + trashedDate?: string | null; /** * If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. */ @@ -1142,7 +1145,7 @@ export namespace drive_v2 { /** * A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. */ - version?: string; + version?: string | null; /** * Metadata about video media. This will only be present for video types. */ @@ -1150,19 +1153,19 @@ export namespace drive_v2 { durationMillis?: string; height?: number; width?: number; - }; + } | null; /** * A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. */ - webContentLink?: string; + webContentLink?: string | null; /** * A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. */ - webViewLink?: string; + webViewLink?: string | null; /** * Whether writers can share the document with other users. Not populated for items in shared drives. */ - writersCanShare?: boolean; + writersCanShare?: boolean | null; } /** * A list of files. @@ -1171,11 +1174,11 @@ export namespace drive_v2 { /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive". */ - incompleteSearch?: boolean; + incompleteSearch?: boolean | null; /** * The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -1183,19 +1186,19 @@ export namespace drive_v2 { /** * This is always drive#fileList. */ - kind?: string; + kind?: string | null; /** * A link to the next page of files. */ - nextLink?: string; + nextLink?: string | null; /** * The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * A list of generated IDs which can be provided in insert requests @@ -1204,15 +1207,15 @@ export namespace drive_v2 { /** * The IDs generated for the requesting user in the specified space. */ - ids?: string[]; + ids?: string[] | null; /** * This is always drive#generatedIds */ - kind?: string; + kind?: string | null; /** * The type of file that can be created with these IDs. */ - space?: string; + space?: string | null; } /** * A list of a file's parents. @@ -1221,7 +1224,7 @@ export namespace drive_v2 { /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * The list of parents. */ @@ -1229,11 +1232,11 @@ export namespace drive_v2 { /** * This is always drive#parentList. */ - kind?: string; + kind?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * A reference to a file's parent. @@ -1242,23 +1245,23 @@ export namespace drive_v2 { /** * The ID of the parent. */ - id?: string; + id?: string | null; /** * Whether or not the parent is the root folder. */ - isRoot?: boolean; + isRoot?: boolean | null; /** * This is always drive#parentReference. */ - kind?: string; + kind?: string | null; /** * A link to the parent. */ - parentLink?: string; + parentLink?: string | null; /** * A link back to this reference. */ - selfLink?: string; + selfLink?: string | null; } /** * A permission for a file. @@ -1267,43 +1270,43 @@ export namespace drive_v2 { /** * Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. */ - additionalRoles?: string[]; + additionalRoles?: string[] | null; /** * Deprecated. */ - authKey?: string; + authKey?: string | null; /** * Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. */ - deleted?: boolean; + deleted?: boolean | null; /** * The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. */ - domain?: string; + domain?: string | null; /** * The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. */ - emailAddress?: string; + emailAddress?: string | null; /** * The ETag of the permission. */ - etag?: string; + etag?: string | null; /** * The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests */ - expirationDate?: string; + expirationDate?: string | null; /** * The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. */ - id?: string; + id?: string | null; /** * This is always drive#permission. */ - kind?: string; + kind?: string | null; /** * The name for this permission. */ - name?: string; + name?: string | null; /** * Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. */ @@ -1313,19 +1316,19 @@ export namespace drive_v2 { inheritedFrom?: string; permissionType?: string; role?: string; - }>; + }> | null; /** * A link to the profile photo, if available. */ - photoLink?: string; + photoLink?: string | null; /** * The primary role for this user. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - reader */ - role?: string; + role?: string | null; /** * A link back to this permission. */ - selfLink?: string; + selfLink?: string | null; /** * Deprecated - use permissionDetails instead. */ @@ -1335,19 +1338,19 @@ export namespace drive_v2 { inheritedFrom?: string; role?: string; teamDrivePermissionType?: string; - }>; + }> | null; /** * The account type. Allowed values are: - user - group - domain - anyone */ - type?: string; + type?: string | null; /** * The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. */ - value?: string; + value?: string | null; /** * Whether the link is required for this permission. */ - withLink?: boolean; + withLink?: boolean | null; } /** * An ID for a user or group as seen in Permission items. @@ -1356,11 +1359,11 @@ export namespace drive_v2 { /** * The permission ID. */ - id?: string; + id?: string | null; /** * This is always drive#permissionId. */ - kind?: string; + kind?: string | null; } /** * A list of permissions associated with a file. @@ -1369,7 +1372,7 @@ export namespace drive_v2 { /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * The list of permissions. */ @@ -1377,15 +1380,15 @@ export namespace drive_v2 { /** * This is always drive#permissionList. */ - kind?: string; + kind?: string | null; /** * The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: - Maximum of 100 properties total per file - Maximum of 30 private properties per app - Maximum of 30 public properties - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. @@ -1394,27 +1397,27 @@ export namespace drive_v2 { /** * ETag of the property. */ - etag?: string; + etag?: string | null; /** * The key of this property. */ - key?: string; + key?: string | null; /** * This is always drive#property. */ - kind?: string; + kind?: string | null; /** * The link back to this property. */ - selfLink?: string; + selfLink?: string | null; /** * The value of this property. */ - value?: string; + value?: string | null; /** * The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) */ - visibility?: string; + visibility?: string | null; } /** * A collection of properties, key-value pairs that are either public or private to an application. @@ -1423,7 +1426,7 @@ export namespace drive_v2 { /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * The list of properties. */ @@ -1431,11 +1434,11 @@ export namespace drive_v2 { /** * This is always drive#propertyList. */ - kind?: string; + kind?: string | null; /** * The link back to this list. */ - selfLink?: string; + selfLink?: string | null; } /** * A revision of a file. @@ -1444,27 +1447,27 @@ export namespace drive_v2 { /** * Short term download URL for the file. This will only be populated on files with content stored in Drive. */ - downloadUrl?: string; + downloadUrl?: string | null; /** * The ETag of the revision. */ - etag?: string; + etag?: string | null; /** * Links for exporting Google Docs to specific formats. */ - exportLinks?: {[key: string]: string}; + exportLinks?: {[key: string]: string} | null; /** * The size of the revision in bytes. This will only be populated on files with content stored in Drive. */ - fileSize?: string; + fileSize?: string | null; /** * The ID of the revision. */ - id?: string; + id?: string | null; /** * This is always drive#revision. */ - kind?: string; + kind?: string | null; /** * The last user to modify this revision. */ @@ -1472,47 +1475,47 @@ export namespace drive_v2 { /** * Name of the last user to modify this revision. */ - lastModifyingUserName?: string; + lastModifyingUserName?: string | null; /** * An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive. */ - md5Checksum?: string; + md5Checksum?: string | null; /** * The MIME type of the revision. */ - mimeType?: string; + mimeType?: string | null; /** * Last time this revision was modified (formatted RFC 3339 timestamp). */ - modifiedDate?: string; + modifiedDate?: string | null; /** * The original filename when this revision was created. This will only be populated on files with content stored in Drive. */ - originalFilename?: string; + originalFilename?: string | null; /** * Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. */ - pinned?: boolean; + pinned?: boolean | null; /** * Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs. */ - publishAuto?: boolean; + publishAuto?: boolean | null; /** * Whether this revision is published. This is only populated and can only be modified for Google Docs. */ - published?: boolean; + published?: boolean | null; /** * A link to the published revision. */ - publishedLink?: string; + publishedLink?: string | null; /** * Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs. */ - publishedOutsideDomain?: boolean; + publishedOutsideDomain?: boolean | null; /** * A link back to this revision. */ - selfLink?: string; + selfLink?: string | null; } /** * A list of revisions of a file. @@ -1521,7 +1524,7 @@ export namespace drive_v2 { /** * The ETag of the list. */ - etag?: string; + etag?: string | null; /** * The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -1529,25 +1532,25 @@ export namespace drive_v2 { /** * This is always drive#revisionList. */ - kind?: string; + kind?: string | null; /** * The page token for the next page of revisions. This field will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A link back to this list. */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$StartPageToken { /** * Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken". */ - kind?: string; + kind?: string | null; /** * The starting page token for listing changes. */ - startPageToken?: string; + startPageToken?: string | null; } /** * Deprecated: use the drive collection instead. @@ -1561,11 +1564,11 @@ export namespace drive_v2 { width?: number; xCoordinate?: number; yCoordinate?: number; - }; + } | null; /** * A short-lived link to this Team Drive's background image. */ - backgroundImageLink?: string; + backgroundImageLink?: string | null; /** * Capabilities the current user has on this Team Drive. */ @@ -1589,27 +1592,27 @@ export namespace drive_v2 { canRenameTeamDrive?: boolean; canShare?: boolean; canTrashChildren?: boolean; - }; + } | null; /** * The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. */ - colorRgb?: string; + colorRgb?: string | null; /** * The time at which the Team Drive was created (RFC 3339 date-time). */ - createdDate?: string; + createdDate?: string | null; /** * The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. */ - id?: string; + id?: string | null; /** * This is always drive#teamDrive */ - kind?: string; + kind?: string | null; /** * The name of this Team Drive. */ - name?: string; + name?: string | null; /** * A set of restrictions that apply to this Team Drive or items inside this Team Drive. */ @@ -1618,11 +1621,11 @@ export namespace drive_v2 { copyRequiresWriterPermission?: boolean; domainUsersOnly?: boolean; teamMembersOnly?: boolean; - }; + } | null; /** * The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ - themeId?: string; + themeId?: string | null; } /** * A list of Team Drives. @@ -1635,11 +1638,11 @@ export namespace drive_v2 { /** * This is always drive#teamDriveList */ - kind?: string; + kind?: string | null; /** * The page token for the next page of Team Drives. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Information about a Drive user. @@ -1648,27 +1651,27 @@ export namespace drive_v2 { /** * A plain text displayable name for this user. */ - displayName?: string; + displayName?: string | null; /** * The email address of the user. */ - emailAddress?: string; + emailAddress?: string | null; /** * Whether this user is the same as the authenticated user for whom the request was made. */ - isAuthenticatedUser?: boolean; + isAuthenticatedUser?: boolean | null; /** * This is always drive#user. */ - kind?: string; + kind?: string | null; /** * The user's ID as visible in the permissions collection. */ - permissionId?: string; + permissionId?: string | null; /** * The user's profile picture. */ - picture?: {url?: string}; + picture?: {url?: string} | null; } export class Resource$About { diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index c0a0f9d48b1..35f0fd9672a 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -126,15 +126,15 @@ export namespace drive_v3 { /** * Whether the user has installed the requesting app. */ - appInstalled?: boolean; + appInstalled?: boolean | null; /** * Whether the user can create shared drives. */ - canCreateDrives?: boolean; + canCreateDrives?: boolean | null; /** * Deprecated - use canCreateDrives instead. */ - canCreateTeamDrives?: boolean; + canCreateTeamDrives?: boolean | null; /** * A list of themes that are supported for shared drives. */ @@ -142,31 +142,31 @@ export namespace drive_v3 { backgroundImageLink?: string; colorRgb?: string; id?: string; - }>; + }> | null; /** * A map of source MIME type to possible targets for all supported exports. */ - exportFormats?: {[key: string]: string[]}; + exportFormats?: {[key: string]: string[]} | null; /** * The currently supported folder colors as RGB hex strings. */ - folderColorPalette?: string[]; + folderColorPalette?: string[] | null; /** * A map of source MIME type to possible targets for all supported imports. */ - importFormats?: {[key: string]: string[]}; + importFormats?: {[key: string]: string[]} | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#about". */ - kind?: string; + kind?: string | null; /** * A map of maximum import sizes by MIME type, in bytes. */ - maxImportSizes?: {[key: string]: string}; + maxImportSizes?: {[key: string]: string} | null; /** * The maximum upload size in bytes. */ - maxUploadSize?: string; + maxUploadSize?: string | null; /** * The user's storage quota limits and usage. All fields are measured in bytes. */ @@ -175,7 +175,7 @@ export namespace drive_v3 { usage?: string; usageInDrive?: string; usageInDriveTrash?: string; - }; + } | null; /** * Deprecated - use driveThemes instead. */ @@ -183,7 +183,7 @@ export namespace drive_v3 { backgroundImageLink?: string; colorRgb?: string; id?: string; - }>; + }> | null; /** * The authenticated user. */ @@ -196,7 +196,7 @@ export namespace drive_v3 { /** * The type of the change. Possible values are file and drive. */ - changeType?: string; + changeType?: string | null; /** * The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. */ @@ -204,7 +204,7 @@ export namespace drive_v3 { /** * The ID of the shared drive associated with this change. */ - driveId?: string; + driveId?: string | null; /** * The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. */ @@ -212,15 +212,15 @@ export namespace drive_v3 { /** * The ID of the file which has changed. */ - fileId?: string; + fileId?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#change". */ - kind?: string; + kind?: string | null; /** * Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. */ - removed?: boolean; + removed?: boolean | null; /** * Deprecated - use drive instead. */ @@ -228,15 +228,15 @@ export namespace drive_v3 { /** * Deprecated - use driveId instead. */ - teamDriveId?: string; + teamDriveId?: string | null; /** * The time of this change (RFC 3339 date-time). */ - time?: string; + time?: string | null; /** * Deprecated - use changeType instead. */ - type?: string; + type?: string | null; } /** * A list of changes for a user. @@ -249,15 +249,15 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#changeList". */ - kind?: string; + kind?: string | null; /** * The starting page token for future changes. This will be present only if the end of the current changes list has been reached. */ - newStartPageToken?: string; + newStartPageToken?: string | null; /** * The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An notification channel used to watch for resource changes. @@ -266,43 +266,43 @@ export namespace drive_v3 { /** * The address where notifications are delivered for this channel. */ - address?: string; + address?: string | null; /** * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ - expiration?: string; + expiration?: string | null; /** * A UUID or similar unique string that identifies this channel. */ - id?: string; + id?: string | null; /** * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ - kind?: string; + kind?: string | null; /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: {[key: string]: string}; + params?: {[key: string]: string} | null; /** * A Boolean value to indicate whether payload is wanted. Optional. */ - payload?: boolean; + payload?: boolean | null; /** * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ - resourceId?: string; + resourceId?: string | null; /** * A version-specific identifier for the watched resource. */ - resourceUri?: string; + resourceUri?: string | null; /** * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ - token?: string; + token?: string | null; /** * The type of delivery mechanism used for this channel. */ - type?: string; + type?: string | null; } /** * A comment on a file. @@ -311,7 +311,7 @@ export namespace drive_v3 { /** * A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. */ - anchor?: string; + anchor?: string | null; /** * The user who created the comment. */ @@ -319,35 +319,35 @@ export namespace drive_v3 { /** * The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed. */ - content?: string; + content?: string | null; /** * The time at which the comment was created (RFC 3339 date-time). */ - createdTime?: string; + createdTime?: string | null; /** * Whether the comment has been deleted. A deleted comment has no content. */ - deleted?: boolean; + deleted?: boolean | null; /** * The content of the comment with HTML formatting. */ - htmlContent?: string; + htmlContent?: string | null; /** * The ID of the comment. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#comment". */ - kind?: string; + kind?: string | null; /** * The last time the comment or any of its replies was modified (RFC 3339 date-time). */ - modifiedTime?: string; + modifiedTime?: string | null; /** * The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. */ - quotedFileContent?: {mimeType?: string; value?: string}; + quotedFileContent?: {mimeType?: string; value?: string} | null; /** * The full list of replies to the comment in chronological order. */ @@ -355,7 +355,7 @@ export namespace drive_v3 { /** * Whether the comment has been resolved by one of its replies. */ - resolved?: boolean; + resolved?: boolean | null; } /** * A list of comments on a file. @@ -368,11 +368,11 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#commentList". */ - kind?: string; + kind?: string | null; /** * The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Representation of a shared drive. @@ -386,11 +386,11 @@ export namespace drive_v3 { width?: number; xCoordinate?: number; yCoordinate?: number; - }; + } | null; /** * A short-lived link to this shared drive's background image. */ - backgroundImageLink?: string; + backgroundImageLink?: string | null; /** * Capabilities the current user has on this shared drive. */ @@ -413,31 +413,31 @@ export namespace drive_v3 { canRenameDrive?: boolean; canShare?: boolean; canTrashChildren?: boolean; - }; + } | null; /** * The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. */ - colorRgb?: string; + colorRgb?: string | null; /** * The time at which the shared drive was created (RFC 3339 date-time). */ - createdTime?: string; + createdTime?: string | null; /** * Whether the shared drive is hidden from default view. */ - hidden?: boolean; + hidden?: boolean | null; /** * The ID of this shared drive which is also the ID of the top level folder of this shared drive. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#drive". */ - kind?: string; + kind?: string | null; /** * The name of this shared drive. */ - name?: string; + name?: string | null; /** * A set of restrictions that apply to this shared drive or items inside this shared drive. */ @@ -446,11 +446,11 @@ export namespace drive_v3 { copyRequiresWriterPermission?: boolean; domainUsersOnly?: boolean; driveMembersOnly?: boolean; - }; + } | null; /** * The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ - themeId?: string; + themeId?: string | null; } /** * A list of shared drives. @@ -463,11 +463,11 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#driveList". */ - kind?: string; + kind?: string | null; /** * The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The metadata for a file. @@ -476,7 +476,7 @@ export namespace drive_v3 { /** * A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests. */ - appProperties?: {[key: string]: string}; + appProperties?: {[key: string]: string} | null; /** * Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. */ @@ -511,70 +511,70 @@ export namespace drive_v3 { canTrash?: boolean; canTrashChildren?: boolean; canUntrash?: boolean; - }; + } | null; /** * Additional information about the content of the file. These fields are never populated in responses. */ contentHints?: { indexableText?: string; thumbnail?: {image?: string; mimeType?: string}; - }; + } | null; /** * Whether the options to copy, print, or download this file, should be disabled for readers and commenters. */ - copyRequiresWriterPermission?: boolean; + copyRequiresWriterPermission?: boolean | null; /** * The time at which the file was created (RFC 3339 date-time). */ - createdTime?: string; + createdTime?: string | null; /** * A short description of the file. */ - description?: string; + description?: string | null; /** * ID of the shared drive the file resides in. Only populated for items in shared drives. */ - driveId?: string; + driveId?: string | null; /** * Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder. */ - explicitlyTrashed?: boolean; + explicitlyTrashed?: boolean | null; /** * Links for exporting Google Docs to specific formats. */ - exportLinks?: {[key: string]: string}; + exportLinks?: {[key: string]: string} | null; /** * The final component of fullFileExtension. This is only available for files with binary content in Google Drive. */ - fileExtension?: string; + fileExtension?: string | null; /** * The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead. */ - folderColorRgb?: string; + folderColorRgb?: string | null; /** * The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension. */ - fullFileExtension?: string; + fullFileExtension?: string | null; /** * Whether any users are granted file access directly on this file. This field is only populated for shared drive files. */ - hasAugmentedPermissions?: boolean; + hasAugmentedPermissions?: boolean | null; /** * Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. */ - hasThumbnail?: boolean; + hasThumbnail?: boolean | null; /** * The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. */ - headRevisionId?: string; + headRevisionId?: string | null; /** * A static, unauthenticated link to the file's icon. */ - iconLink?: string; + iconLink?: string | null; /** * The ID of the file. */ - id?: string; + id?: string | null; /** * Additional metadata about image media, if available. */ @@ -600,15 +600,15 @@ export namespace drive_v3 { time?: string; whiteBalance?: string; width?: number; - }; + } | null; /** * Whether the file was created or opened by the requesting app. */ - isAppAuthorized?: boolean; + isAppAuthorized?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#file". */ - kind?: string; + kind?: string | null; /** * The last user to modify the file. */ @@ -616,35 +616,35 @@ export namespace drive_v3 { /** * The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. */ - md5Checksum?: string; + md5Checksum?: string | null; /** * The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource. */ - mimeType?: string; + mimeType?: string | null; /** * Whether the file has been modified by this user. */ - modifiedByMe?: boolean; + modifiedByMe?: boolean | null; /** * The last time the file was modified by the user (RFC 3339 date-time). */ - modifiedByMeTime?: string; + modifiedByMeTime?: string | null; /** * The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. */ - modifiedTime?: string; + modifiedTime?: string | null; /** * The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. */ - name?: string; + name?: string | null; /** * The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive. */ - originalFilename?: string; + originalFilename?: string | null; /** * Whether the user owns the file. Not populated for items in shared drives. */ - ownedByMe?: boolean; + ownedByMe?: boolean | null; /** * The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives. */ @@ -652,11 +652,11 @@ export namespace drive_v3 { /** * The IDs of the parent folders which contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list. */ - parents?: string[]; + parents?: string[] | null; /** * List of permission IDs for users with access to this file. */ - permissionIds?: string[]; + permissionIds?: string[] | null; /** * The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. */ @@ -664,19 +664,19 @@ export namespace drive_v3 { /** * A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled. */ - quotaBytesUsed?: string; + quotaBytesUsed?: string | null; /** * Whether the file has been shared. Not populated for items in shared drives. */ - shared?: boolean; + shared?: boolean | null; /** * The time at which the file was shared with the user, if applicable (RFC 3339 date-time). */ - sharedWithMeTime?: string; + sharedWithMeTime?: string | null; /** * The user who shared the file with the requesting user, if applicable. */ @@ -684,35 +684,35 @@ export namespace drive_v3 { /** * The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive. */ - size?: string; + size?: string | null; /** * The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. */ - spaces?: string[]; + spaces?: string[] | null; /** * Whether the user has starred the file. */ - starred?: boolean; + starred?: boolean | null; /** * Deprecated - use driveId instead. */ - teamDriveId?: string; + teamDriveId?: string | null; /** * A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. */ - thumbnailLink?: string; + thumbnailLink?: string | null; /** * The thumbnail version for use in thumbnail cache invalidation. */ - thumbnailVersion?: string; + thumbnailVersion?: string | null; /** * Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. */ - trashed?: boolean; + trashed?: boolean | null; /** * The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. */ - trashedTime?: string; + trashedTime?: string | null; /** * If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. */ @@ -720,7 +720,7 @@ export namespace drive_v3 { /** * A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user. */ - version?: string; + version?: string | null; /** * Additional metadata about video media. This may not be available immediately upon upload. */ @@ -728,31 +728,31 @@ export namespace drive_v3 { durationMillis?: string; height?: number; width?: number; - }; + } | null; /** * Whether the file has been viewed by this user. */ - viewedByMe?: boolean; + viewedByMe?: boolean | null; /** * The last time the file was viewed by the user (RFC 3339 date-time). */ - viewedByMeTime?: string; + viewedByMeTime?: string | null; /** * Deprecated - use copyRequiresWriterPermission instead. */ - viewersCanCopyContent?: boolean; + viewersCanCopyContent?: boolean | null; /** * A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. */ - webContentLink?: string; + webContentLink?: string | null; /** * A link for opening the file in a relevant Google editor or viewer in a browser. */ - webViewLink?: string; + webViewLink?: string | null; /** * Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. */ - writersCanShare?: boolean; + writersCanShare?: boolean | null; } /** * A list of files. @@ -765,15 +765,15 @@ export namespace drive_v3 { /** * Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "user" or "drive". */ - incompleteSearch?: boolean; + incompleteSearch?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#fileList". */ - kind?: string; + kind?: string | null; /** * The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A list of generated file IDs which can be provided in create requests. @@ -782,15 +782,15 @@ export namespace drive_v3 { /** * The IDs generated for the requesting user in the specified space. */ - ids?: string[]; + ids?: string[] | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds". */ - kind?: string; + kind?: string | null; /** * The type of file that can be created with these IDs. */ - space?: string; + space?: string | null; } /** * A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy. @@ -799,35 +799,35 @@ export namespace drive_v3 { /** * Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. */ - allowFileDiscovery?: boolean; + allowFileDiscovery?: boolean | null; /** * Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. */ - deleted?: boolean; + deleted?: boolean | null; /** * A displayable name for users, groups or domains. */ - displayName?: string; + displayName?: string | null; /** * The domain to which this permission refers. */ - domain?: string; + domain?: string | null; /** * The email address of the user or group to which this permission refers. */ - emailAddress?: string; + emailAddress?: string | null; /** * The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future */ - expirationTime?: string; + expirationTime?: string | null; /** * The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#permission". */ - kind?: string; + kind?: string | null; /** * Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. */ @@ -836,15 +836,15 @@ export namespace drive_v3 { inheritedFrom?: string; permissionType?: string; role?: string; - }>; + }> | null; /** * A link to the user's profile photo, if available. */ - photoLink?: string; + photoLink?: string | null; /** * The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader */ - role?: string; + role?: string | null; /** * Deprecated - use permissionDetails instead. */ @@ -853,11 +853,11 @@ export namespace drive_v3 { inheritedFrom?: string; role?: string; teamDrivePermissionType?: string; - }>; + }> | null; /** * The type of the grantee. Valid values are: - user - group - domain - anyone */ - type?: string; + type?: string | null; } /** * A list of permissions for a file. @@ -866,11 +866,11 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#permissionList". */ - kind?: string; + kind?: string | null; /** * The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -883,7 +883,7 @@ export namespace drive_v3 { /** * The action the reply performed to the parent comment. Valid values are: - resolve - reopen */ - action?: string; + action?: string | null; /** * The user who created the reply. */ @@ -891,31 +891,31 @@ export namespace drive_v3 { /** * The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified. */ - content?: string; + content?: string | null; /** * The time at which the reply was created (RFC 3339 date-time). */ - createdTime?: string; + createdTime?: string | null; /** * Whether the reply has been deleted. A deleted reply has no content. */ - deleted?: boolean; + deleted?: boolean | null; /** * The content of the reply with HTML formatting. */ - htmlContent?: string; + htmlContent?: string | null; /** * The ID of the reply. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#reply". */ - kind?: string; + kind?: string | null; /** * The last time the reply was modified (RFC 3339 date-time). */ - modifiedTime?: string; + modifiedTime?: string | null; } /** * A list of replies to a comment on a file. @@ -924,11 +924,11 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#replyList". */ - kind?: string; + kind?: string | null; /** * The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -941,19 +941,19 @@ export namespace drive_v3 { /** * Links for exporting Google Docs to specific formats. */ - exportLinks?: {[key: string]: string}; + exportLinks?: {[key: string]: string} | null; /** * The ID of the revision. */ - id?: string; + id?: string | null; /** * Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive. */ - keepForever?: boolean; + keepForever?: boolean | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#revision". */ - kind?: string; + kind?: string | null; /** * The last user to modify this revision. */ @@ -961,35 +961,35 @@ export namespace drive_v3 { /** * The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive. */ - md5Checksum?: string; + md5Checksum?: string | null; /** * The MIME type of the revision. */ - mimeType?: string; + mimeType?: string | null; /** * The last time the revision was modified (RFC 3339 date-time). */ - modifiedTime?: string; + modifiedTime?: string | null; /** * The original filename used to create this revision. This is only applicable to files with binary content in Drive. */ - originalFilename?: string; + originalFilename?: string | null; /** * Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs. */ - publishAuto?: boolean; + publishAuto?: boolean | null; /** * Whether this revision is published. This is only applicable to Google Docs. */ - published?: boolean; + published?: boolean | null; /** * Whether this revision is published outside the domain. This is only applicable to Google Docs. */ - publishedOutsideDomain?: boolean; + publishedOutsideDomain?: boolean | null; /** * The size of the revision's content in bytes. This is only applicable to files with binary content in Drive. */ - size?: string; + size?: string | null; } /** * A list of revisions of a file. @@ -998,11 +998,11 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#revisionList". */ - kind?: string; + kind?: string | null; /** * The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -1012,11 +1012,11 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken". */ - kind?: string; + kind?: string | null; /** * The starting page token for listing changes. */ - startPageToken?: string; + startPageToken?: string | null; } /** * Deprecated: use the drive collection instead. @@ -1030,11 +1030,11 @@ export namespace drive_v3 { width?: number; xCoordinate?: number; yCoordinate?: number; - }; + } | null; /** * A short-lived link to this Team Drive's background image. */ - backgroundImageLink?: string; + backgroundImageLink?: string | null; /** * Capabilities the current user has on this Team Drive. */ @@ -1058,27 +1058,27 @@ export namespace drive_v3 { canRenameTeamDrive?: boolean; canShare?: boolean; canTrashChildren?: boolean; - }; + } | null; /** * The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. */ - colorRgb?: string; + colorRgb?: string | null; /** * The time at which the Team Drive was created (RFC 3339 date-time). */ - createdTime?: string; + createdTime?: string | null; /** * The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". */ - kind?: string; + kind?: string | null; /** * The name of this Team Drive. */ - name?: string; + name?: string | null; /** * A set of restrictions that apply to this Team Drive or items inside this Team Drive. */ @@ -1087,11 +1087,11 @@ export namespace drive_v3 { copyRequiresWriterPermission?: boolean; domainUsersOnly?: boolean; teamMembersOnly?: boolean; - }; + } | null; /** * The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ - themeId?: string; + themeId?: string | null; } /** * A list of Team Drives. @@ -1100,11 +1100,11 @@ export namespace drive_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList". */ - kind?: string; + kind?: string | null; /** * The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ @@ -1117,27 +1117,27 @@ export namespace drive_v3 { /** * A plain text displayable name for this user. */ - displayName?: string; + displayName?: string | null; /** * The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. */ - emailAddress?: string; + emailAddress?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "drive#user". */ - kind?: string; + kind?: string | null; /** * Whether this user is the requesting user. */ - me?: boolean; + me?: boolean | null; /** * The user's ID as visible in Permission resources. */ - permissionId?: string; + permissionId?: string | null; /** * A link to the user's profile photo, if available. */ - photoLink?: string; + photoLink?: string | null; } export class Resource$About { diff --git a/src/apis/driveactivity/v2.ts b/src/apis/driveactivity/v2.ts index 4ea0ec3d49c..3de818f4225 100644 --- a/src/apis/driveactivity/v2.ts +++ b/src/apis/driveactivity/v2.ts @@ -140,7 +140,7 @@ export namespace driveactivity_v2 { /** * The action occurred at this specific time. */ - timestamp?: string; + timestamp?: string | null; } /** * Data describing the type and additional information of an action. @@ -235,7 +235,7 @@ export namespace driveactivity_v2 { /** * The reference type corresponding to this event. */ - type?: string; + type?: string | null; } /** * A comment with an assignment. @@ -244,7 +244,7 @@ export namespace driveactivity_v2 { /** * The sub-type of this event. */ - subtype?: string; + subtype?: string | null; } /** * A change about comments on an object. @@ -313,7 +313,7 @@ export namespace driveactivity_v2 { /** * The type of Data Leak Prevention (DLP) change. */ - type?: string; + type?: string | null; } /** * An object was deleted. @@ -322,7 +322,7 @@ export namespace driveactivity_v2 { /** * The type of delete action taken. */ - type?: string; + type?: string | null; } /** * A user whose account has since been deleted. @@ -335,11 +335,11 @@ export namespace driveactivity_v2 { /** * An opaque string used to identify this domain. */ - legacyId?: string; + legacyId?: string | null; /** * The name of the domain, e.g. "google.com". */ - name?: string; + name?: string | null; } /** * Information about a shared drive. @@ -348,7 +348,7 @@ export namespace driveactivity_v2 { /** * The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection ID for this resource name. */ - name?: string; + name?: string | null; /** * The root of this shared drive. */ @@ -356,7 +356,7 @@ export namespace driveactivity_v2 { /** * The title of the shared drive. */ - title?: string; + title?: string | null; } /** * A single Drive activity comprising one or more Actions by one or more Actors on one or more Targets. Some Action groupings occur spontaneously, such as moving an item into a shared folder triggering a permission change. Other groupings of related Actions, such as multiple Actors editing one item or moving multiple files into a new folder, are controlled by the selection of a ConsolidationStrategy in the QueryDriveActivityRequest. @@ -385,7 +385,7 @@ export namespace driveactivity_v2 { /** * The activity occurred at this specific time. */ - timestamp?: string; + timestamp?: string | null; } /** * A Drive item which is a file. @@ -398,7 +398,7 @@ export namespace driveactivity_v2 { /** * The type of Drive folder. */ - type?: string; + type?: string | null; } /** * A Drive item, such as a file or folder. @@ -423,11 +423,11 @@ export namespace driveactivity_v2 { /** * The MIME type of the Drive item. See https://developers.google.com/drive/v3/web/mime-types. */ - mimeType?: string; + mimeType?: string | null; /** * The target Drive item. The format is "items/ITEM_ID". */ - name?: string; + name?: string | null; /** * Information about the owner of this Drive item. */ @@ -435,7 +435,7 @@ export namespace driveactivity_v2 { /** * The title of the Drive item. */ - title?: string; + title?: string | null; } /** * A lightweight reference to a Drive item, such as a file or folder. @@ -446,7 +446,7 @@ export namespace driveactivity_v2 { */ driveFile?: Schema$DriveFile; /** - * The Drive item is a folder. + * The Drive item is a folder. Includes information about the type of folder. */ driveFolder?: Schema$DriveFolder; /** @@ -460,11 +460,11 @@ export namespace driveactivity_v2 { /** * The target Drive item. The format is "items/ITEM_ID". */ - name?: string; + name?: string | null; /** * The title of the Drive item. */ - title?: string; + title?: string | null; } /** * A lightweight reference to a shared drive. @@ -473,11 +473,11 @@ export namespace driveactivity_v2 { /** * The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection ID for this resource name. */ - name?: string; + name?: string | null; /** * The title of the shared drive. */ - title?: string; + title?: string | null; } /** * An empty message indicating an object was edited. @@ -494,15 +494,15 @@ export namespace driveactivity_v2 { /** * The comment in the discussion thread. This identifier is an opaque string compatible with the Drive API; see https://developers.google.com/drive/v3/reference/comments/get */ - legacyCommentId?: string; + legacyCommentId?: string | null; /** * The discussion thread to which the comment was added. This identifier is an opaque string compatible with the Drive API and references the first comment in a discussion; see https://developers.google.com/drive/v3/reference/comments/get */ - legacyDiscussionId?: string; + legacyDiscussionId?: string | null; /** * The link to the discussion thread containing this comment, for example, "https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID". */ - linkToDiscussion?: string; + linkToDiscussion?: string | null; /** * The Drive item containing this comment. */ @@ -515,7 +515,7 @@ export namespace driveactivity_v2 { /** * This field is deprecated; please see `DriveFolder.type` instead. */ - type?: string; + type?: string | null; } /** * Information about a group. @@ -524,11 +524,11 @@ export namespace driveactivity_v2 { /** * The email address of the group. */ - email?: string; + email?: string | null; /** * The title of the group. */ - title?: string; + title?: string | null; } /** * Information about an impersonation, where an admin acts on behalf of an end user. Information about the acting admin is not currently available. @@ -546,11 +546,11 @@ export namespace driveactivity_v2 { /** * True if this is the user making the request. */ - isCurrentUser?: boolean; + isCurrentUser?: boolean | null; /** * The identifier for this user that can be used with the People API to get more information. The format is "people/ACCOUNT_ID". See https://developers.google.com/people/. */ - personName?: string; + personName?: string | null; } /** * A strategy which consolidates activities using the grouping rules from the legacy V1 Activity API. Similar actions occurring within a window of time can be grouped across multiple targets (such as moving a set of files at once) or multiple actors (such as several users editing the same item). Grouping rules for this strategy are specific to each type of action. @@ -605,7 +605,7 @@ export namespace driveactivity_v2 { /** * If true, the item can be discovered (e.g. in the user's "Shared with me" collection) without needing a link to the item. */ - allowDiscovery?: boolean; + allowDiscovery?: boolean | null; /** * If set, this permission applies to anyone, even logged out users. */ @@ -621,7 +621,7 @@ export namespace driveactivity_v2 { /** * Indicates the <a href="/drive/web/manage-sharing#roles">Google Drive permissions role</a>. The role determines a user's ability to read, write, and comment on items. */ - role?: string; + role?: string | null; /** * The user to whom this permission applies. */ @@ -647,7 +647,7 @@ export namespace driveactivity_v2 { /** * The sub-type of this event. */ - subtype?: string; + subtype?: string | null; } /** * The request message for querying Drive activity. @@ -656,7 +656,7 @@ export namespace driveactivity_v2 { /** * Return activities for this Drive folder and all children and descendants. The format is "items/ITEM_ID". */ - ancestorName?: string; + ancestorName?: string | null; /** * Details on how to consolidate related actions that make up the activity. If not set, then related actions will not be consolidated. */ @@ -664,19 +664,19 @@ export namespace driveactivity_v2 { /** * The filtering for items returned from this query request. The format of the filter string is a sequence of expressions, joined by an optional "AND", where each expression is of the form "field operator value". Supported fields: - <tt>time</tt>: Uses numerical operators on date values either in terms of milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples: - <tt>time > 1452409200000 AND time <= 1492812924310</tt> - <tt>time >= "2016-01-10T01:02:03-05:00"</tt> - <tt>detail.action_detail_case</tt>: Uses the "has" operator (:) and either a singular value or a list of allowed action types enclosed in parentheses. Examples: - <tt>detail.action_detail_case: RENAME</tt> - <tt>detail.action_detail_case:(CREATE UPLOAD)</tt> - <tt>-detail.action_detail_case:MOVE</tt> */ - filter?: string; + filter?: string | null; /** * Return activities for this Drive item. The format is "items/ITEM_ID". */ - itemName?: string; + itemName?: string | null; /** * The requested number of activity to return. If not set, a default value will be used. */ - pageSize?: number; + pageSize?: number | null; /** * The next_page_token value returned from a previous QueryDriveActivity request, if any. */ - pageToken?: string; + pageToken?: string | null; } /** * Response message for querying Drive activity. @@ -689,7 +689,7 @@ export namespace driveactivity_v2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An object was renamed. @@ -698,11 +698,11 @@ export namespace driveactivity_v2 { /** * The new title of the drive object. */ - newTitle?: string; + newTitle?: string | null; /** * The previous title of the drive object. */ - oldTitle?: string; + oldTitle?: string | null; } /** * A deleted object was restored. @@ -711,7 +711,7 @@ export namespace driveactivity_v2 { /** * The type of restore action taken. */ - type?: string; + type?: string | null; } /** * Information about restriction policy changes to a feature. @@ -720,11 +720,11 @@ export namespace driveactivity_v2 { /** * The feature which had a change in restriction policy. */ - feature?: string; + feature?: string | null; /** * The restriction in place after the change. */ - newRestriction?: string; + newRestriction?: string | null; } /** * Information about settings changes. @@ -742,7 +742,7 @@ export namespace driveactivity_v2 { /** * The sub-type of this event. */ - subtype?: string; + subtype?: string | null; } /** * Event triggered by system operations instead of end users. @@ -751,7 +751,7 @@ export namespace driveactivity_v2 { /** * The type of the system event that may triggered activity. */ - type?: string; + type?: string | null; } /** * Information about the target of activity. @@ -798,7 +798,7 @@ export namespace driveactivity_v2 { /** * This field is deprecated; please see `Drive.name` instead. */ - name?: string; + name?: string | null; /** * This field is deprecated; please see `Drive.root` instead. */ @@ -806,7 +806,7 @@ export namespace driveactivity_v2 { /** * This field is deprecated; please see `Drive.title` instead. */ - title?: string; + title?: string | null; } /** * This item is deprecated; please see `DriveReference` instead. @@ -815,11 +815,11 @@ export namespace driveactivity_v2 { /** * This field is deprecated; please see `DriveReference.name` instead. */ - name?: string; + name?: string | null; /** * This field is deprecated; please see `DriveReference.title` instead. */ - title?: string; + title?: string | null; } /** * Information about time ranges. @@ -828,11 +828,11 @@ export namespace driveactivity_v2 { /** * The end of the time range. */ - endTime?: string; + endTime?: string | null; /** * The start of the time range. */ - startTime?: string; + startTime?: string | null; } /** * A user about whom nothing is currently known. diff --git a/src/apis/factchecktools/v1alpha1.ts b/src/apis/factchecktools/v1alpha1.ts index b9d8bc203d5..46b8c9659a7 100644 --- a/src/apis/factchecktools/v1alpha1.ts +++ b/src/apis/factchecktools/v1alpha1.ts @@ -126,11 +126,11 @@ export namespace factchecktools_v1alpha1 { /** * A person or organization stating the claim. For instance, "John Doe". */ - claimant?: string; + claimant?: string | null; /** * The date that the claim was made. */ - claimDate?: string; + claimDate?: string | null; /** * One or more reviews of this claim (namely, a fact-checking article). */ @@ -138,7 +138,7 @@ export namespace factchecktools_v1alpha1 { /** * The claim text. For instance, "Crime has doubled in the last 2 years." */ - text?: string; + text?: string | null; } /** * Information about the claim author. @@ -147,19 +147,19 @@ export namespace factchecktools_v1alpha1 { /** * Corresponds to `ClaimReview.itemReviewed.author.image`. */ - imageUrl?: string; + imageUrl?: string | null; /** * Corresponds to `ClaimReview.itemReviewed.author.jobTitle`. */ - jobTitle?: string; + jobTitle?: string | null; /** * A person or organization stating the claim. For instance, "John Doe".<br> Corresponds to `ClaimReview.itemReviewed.author.name`. */ - name?: string; + name?: string | null; /** * Corresponds to `ClaimReview.itemReviewed.author.sameAs`. */ - sameAs?: string; + sameAs?: string | null; } /** * Information about the claim rating. @@ -168,27 +168,27 @@ export namespace factchecktools_v1alpha1 { /** * For numeric ratings, the best value possible in the scale from worst to best.<br> Corresponds to `ClaimReview.reviewRating.bestRating`. */ - bestRating?: number; + bestRating?: number | null; /** * Corresponds to `ClaimReview.reviewRating.image`. */ - imageUrl?: string; + imageUrl?: string | null; /** * Corresponds to `ClaimReview.reviewRating.ratingExplanation`. */ - ratingExplanation?: string; + ratingExplanation?: string | null; /** * A numeric rating of this claim, in the range worstRating — bestRating inclusive.<br> Corresponds to `ClaimReview.reviewRating.ratingValue`. */ - ratingValue?: number; + ratingValue?: number | null; /** * The truthfulness rating as a human-readible short word or phrase.<br> Corresponds to `ClaimReview.reviewRating.alternateName`. */ - textualRating?: string; + textualRating?: string | null; /** * For numeric ratings, the worst value possible in the scale from worst to best.<br> Corresponds to `ClaimReview.reviewRating.worstRating`. */ - worstRating?: number; + worstRating?: number | null; } /** * Information about a claim review. @@ -197,7 +197,7 @@ export namespace factchecktools_v1alpha1 { /** * The language this review was written in. For instance, "en" or "de". */ - languageCode?: string; + languageCode?: string | null; /** * The publisher of this claim review. */ @@ -205,19 +205,19 @@ export namespace factchecktools_v1alpha1 { /** * The date the claim was reviewed. */ - reviewDate?: string; + reviewDate?: string | null; /** * Textual rating. For instance, "Mostly false". */ - textualRating?: string; + textualRating?: string | null; /** * The title of this claim review, if it can be determined. */ - title?: string; + title?: string | null; /** * The URL of this claim review. */ - url?: string; + url?: string | null; } /** * Information about the claim review author. @@ -226,11 +226,11 @@ export namespace factchecktools_v1alpha1 { /** * Corresponds to `ClaimReview.author.image`. */ - imageUrl?: string; + imageUrl?: string | null; /** * Name of the organization that is publishing the fact check.<br> Corresponds to `ClaimReview.author.name`. */ - name?: string; + name?: string | null; } /** * Fields for an individual `ClaimReview` element. Except for sub-messages that group fields together, each of these fields correspond those in https://schema.org/ClaimReview. We list the precise mapping for each field. @@ -239,7 +239,7 @@ export namespace factchecktools_v1alpha1 { /** * A list of links to works in which this claim appears, aside from the one specified in `claim_first_appearance`.<br> Corresponds to `ClaimReview.itemReviewed[@type=Claim].appearance.url`. */ - claimAppearances?: string[]; + claimAppearances?: string[] | null; /** * Info about the author of this claim. */ @@ -247,19 +247,19 @@ export namespace factchecktools_v1alpha1 { /** * The date when the claim was made or entered public discourse.<br> Corresponds to `ClaimReview.itemReviewed.datePublished`. */ - claimDate?: string; + claimDate?: string | null; /** * A link to a work in which this claim first appears.<br> Corresponds to `ClaimReview.itemReviewed[@type=Claim].firstAppearance.url`. */ - claimFirstAppearance?: string; + claimFirstAppearance?: string | null; /** * The location where this claim was made.<br> Corresponds to `ClaimReview.itemReviewed.name`. */ - claimLocation?: string; + claimLocation?: string | null; /** * A short summary of the claim being evaluated.<br> Corresponds to `ClaimReview.claimReviewed`. */ - claimReviewed?: string; + claimReviewed?: string | null; /** * Info about the rating of this claim review. */ @@ -267,7 +267,7 @@ export namespace factchecktools_v1alpha1 { /** * This field is optional, and will default to the page URL. We provide this field to allow you the override the default value, but the only permitted override is the page URL plus an optional anchor link ("page jump").<br> Corresponds to `ClaimReview.url` */ - url?: string; + url?: string | null; } /** * Holds one or more instances of `ClaimReview` markup for a webpage. @@ -284,19 +284,19 @@ export namespace factchecktools_v1alpha1 { /** * The name of this `ClaimReview` markup page resource, in the form of `pages/{page_id}`. Except for update requests, this field is output-only and should not be set by the user. */ - name?: string; + name?: string | null; /** * The URL of the page associated with this `ClaimReview` markup. While every individual `ClaimReview` has its own URL field, semantically this is a page-level field, and each `ClaimReview` on this page will use this value unless individually overridden.<br> Corresponds to `ClaimReview.url` */ - pageUrl?: string; + pageUrl?: string | null; /** * The date when the fact check was published. Similar to the URL, semantically this is a page-level field, and each `ClaimReview` on this page will contain the same value.<br> Corresponds to `ClaimReview.datePublished` */ - publishDate?: string; + publishDate?: string | null; /** * The version ID for this markup. Except for update requests, this field is output-only and should not be set by the user. */ - versionId?: string; + versionId?: string | null; } /** * Response from searching fact-checked claims. @@ -309,7 +309,7 @@ export namespace factchecktools_v1alpha1 { /** * The next pagination token in the Search response. It should be used as the `page_token` for the following request. An empty value means no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response from listing `ClaimReview` markup. @@ -322,7 +322,7 @@ export namespace factchecktools_v1alpha1 { /** * The next pagination token in the Search response. It should be used as the `page_token` for the following request. An empty value means no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Information about the publisher. @@ -331,11 +331,11 @@ export namespace factchecktools_v1alpha1 { /** * The name of this publisher. For instance, "Awesome Fact Checks". */ - name?: string; + name?: string | null; /** * Host-level site name, without the protocol or "www" prefix. For instance, "awesomefactchecks.com". This value of this field is based purely on the claim review URL. */ - site?: string; + site?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. diff --git a/src/apis/fcm/v1.ts b/src/apis/fcm/v1.ts index 26f20e568ae..58a1d15a473 100644 --- a/src/apis/fcm/v1.ts +++ b/src/apis/fcm/v1.ts @@ -124,11 +124,11 @@ export namespace fcm_v1 { /** * An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed. A maximum of 4 different collapse keys is allowed at any given time. */ - collapseKey?: string; + collapseKey?: string | null; /** * Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. */ - data?: {[key: string]: string}; + data?: {[key: string]: string} | null; /** * Options for features provided by the FCM SDK for Android. */ @@ -140,15 +140,15 @@ export namespace fcm_v1 { /** * Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://goo.gl/GjONJv). */ - priority?: string; + priority?: string | null; /** * Package name of the application where the registration token must match in order to receive the message. */ - restrictedPackageName?: string; + restrictedPackageName?: string | null; /** * How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. */ - ttl?: string; + ttl?: string | null; } /** * Options for features provided by the FCM SDK for Android. @@ -157,7 +157,7 @@ export namespace fcm_v1 { /** * Label associated with the message's analytics data. */ - analyticsLabel?: string; + analyticsLabel?: string | null; } /** * Notification to send to android devices. @@ -166,51 +166,51 @@ export namespace fcm_v1 { /** * The notification's body text. If present, it will override google.firebase.fcm.v1.Notification.body. */ - body?: string; + body?: string | null; /** * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. */ - bodyLocArgs?: string[]; + bodyLocArgs?: string[] | null; /** * The key to the body string in the app's string resources to use to localize the body text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. */ - bodyLocKey?: string; + bodyLocKey?: string | null; /** * The [notification's channel id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest. */ - channelId?: string; + channelId?: string | null; /** * The action associated with a user click on the notification. If specified, an activity with a matching intent filter is launched when a user clicks on the notification. */ - clickAction?: string; + clickAction?: string | null; /** * The notification's icon color, expressed in #rrggbb format. */ - color?: string; + color?: string | null; /** * If set to true, use the Android framework's default LED light settings for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). If `default_light_settings` is set to true and `light_settings` is also set, the user-specified `light_settings` is used instead of the default value. */ - defaultLightSettings?: boolean; + defaultLightSettings?: boolean | null; /** * If set to true, use the Android framework's default sound for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). */ - defaultSound?: boolean; + defaultSound?: boolean | null; /** * If set to true, use the Android framework's default vibrate pattern for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). If `default_vibrate_timings` is set to true and `vibrate_timings` is also set, the default value is used instead of the user-specified `vibrate_timings`. */ - defaultVibrateTimings?: boolean; + defaultVibrateTimings?: boolean | null; /** * Set the time that the event in the notification occurred. Notifications in the panel are sorted by this time. A point in time is represented using [protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Timestamp). */ - eventTime?: string; + eventTime?: string | null; /** * The notification's icon. Sets the notification icon to myicon for drawable resource myicon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest. */ - icon?: string; + icon?: string | null; /** * Contains the URL of an image that is going to be displayed in a notification. If present, it will override google.firebase.fcm.v1.Notification.image. */ - image?: string; + image?: string | null; /** * Settings to control the notification's LED blinking rate and color if LED is available on the device. The total blinking time is controlled by the OS. */ @@ -218,51 +218,51 @@ export namespace fcm_v1 { /** * Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See [Wear OS guides](https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging) */ - localOnly?: boolean; + localOnly?: boolean | null; /** * Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https://developer.android.com/training/notify-user/badges). For example, this might be useful if you're using just one notification to represent multiple new messages but you want the count here to represent the number of total new messages. If zero or unspecified, systems that support badging use the default, which is to increment a number displayed on the long-press menu each time a new notification arrives. */ - notificationCount?: number; + notificationCount?: number | null; /** * Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The effect of setting the same priorities may differ slightly on different platforms. Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. */ - notificationPriority?: string; + notificationPriority?: string | null; /** * The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/. */ - sound?: string; + sound?: string | null; /** * When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it. */ - sticky?: boolean; + sticky?: boolean | null; /** * Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer. */ - tag?: string; + tag?: string | null; /** * Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (`Lollipop`), sets the text that is displayed in the status bar when the notification first arrives. */ - ticker?: string; + ticker?: string | null; /** * The notification's title. If present, it will override google.firebase.fcm.v1.Notification.title. */ - title?: string; + title?: string | null; /** * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. */ - titleLocArgs?: string[]; + titleLocArgs?: string[] | null; /** * The key to the title string in the app's string resources to use to localize the title text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. */ - titleLocKey?: string; + titleLocKey?: string | null; /** * Set the vibration pattern to use. Pass in an array of [protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) to turn on or off the vibrator. The first value indicates the `Duration` to wait before turning the vibrator on. The next value indicates the `Duration` to keep the vibrator on. Subsequent values alternate between `Duration` to turn the vibrator off and to turn the vibrator on. If `vibrate_timings` is set and `default_vibrate_timings` is set to `true`, the default value is used instead of the user-specified `vibrate_timings`. */ - vibrateTimings?: string[]; + vibrateTimings?: string[] | null; /** * Set the [Notification.visibility](https://developer.android.com/reference/android/app/Notification.html#visibility) of the notification. */ - visibility?: string; + visibility?: string | null; } /** * [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. @@ -275,11 +275,11 @@ export namespace fcm_v1 { /** * HTTP request headers defined in Apple Push Notification Service. Refer to [APNs request headers](https://goo.gl/C6Yhia) for supported headers, e.g. "apns-priority": "10". */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * APNs payload as a JSON object, including both `aps` dictionary and custom payload. See [Payload Key Reference](https://goo.gl/32Pl5W). If present, it overrides google.firebase.fcm.v1.Notification.title and google.firebase.fcm.v1.Notification.body. */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; } /** * Options for features provided by the FCM SDK for iOS. @@ -288,11 +288,11 @@ export namespace fcm_v1 { /** * Label associated with the message's analytics data. */ - analyticsLabel?: string; + analyticsLabel?: string | null; /** * Contains the URL of an image that is going to be displayed in a notification. If present, it will override google.firebase.fcm.v1.Notification.image. */ - image?: string; + image?: string | null; } /** * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... @@ -301,19 +301,19 @@ export namespace fcm_v1 { /** * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ - alpha?: number; + alpha?: number | null; /** * The amount of blue in the color as a value in the interval [0, 1]. */ - blue?: number; + blue?: number | null; /** * The amount of green in the color as a value in the interval [0, 1]. */ - green?: number; + green?: number | null; /** * The amount of red in the color as a value in the interval [0, 1]. */ - red?: number; + red?: number | null; } /** * Platform independent options for features provided by the FCM SDKs. @@ -322,7 +322,7 @@ export namespace fcm_v1 { /** * Label associated with the message's analytics data. */ - analyticsLabel?: string; + analyticsLabel?: string | null; } /** * Settings to control notification LED. @@ -335,11 +335,11 @@ export namespace fcm_v1 { /** * Required. Along with `light_on_duration `, define the blink rate of LED flashes. Resolution defined by [proto.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) */ - lightOffDuration?: string; + lightOffDuration?: string | null; /** * Required. Along with `light_off_duration`, define the blink rate of LED flashes. Resolution defined by [proto.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) */ - lightOnDuration?: string; + lightOnDuration?: string | null; } /** * Message to send by Firebase Cloud Messaging Service. @@ -356,11 +356,11 @@ export namespace fcm_v1 { /** * Condition to send a message to, e.g. "'foo' in topics && 'bar' in topics". */ - condition?: string; + condition?: string | null; /** * Input only. Arbitrary key/value payload. */ - data?: {[key: string]: string}; + data?: {[key: string]: string} | null; /** * Input only. Template for FCM SDK feature options to use across all platforms. */ @@ -368,7 +368,7 @@ export namespace fcm_v1 { /** * Output Only. The identifier of the message sent, in the format of `projects/x/messages/{message_id}`. */ - name?: string; + name?: string | null; /** * Input only. Basic notification template to use across all platforms. */ @@ -376,11 +376,11 @@ export namespace fcm_v1 { /** * Registration token to send a message to. */ - token?: string; + token?: string | null; /** * Topic name to send a message to, e.g. "weather". Note: "/topics/" prefix should not be provided. */ - topic?: string; + topic?: string | null; /** * Input only. [Webpush protocol](https://tools.ietf.org/html/rfc8030) options. */ @@ -393,15 +393,15 @@ export namespace fcm_v1 { /** * The notification's body text. */ - body?: string; + body?: string | null; /** * Contains the URL of an image that is going to be downloaded on the device and displayed in a notification. JPEG, PNG, BMP have full support across platforms. Animated GIF and video only work on iOS. WebP and HEIF have varying levels of support across platforms and platform versions. Android has 1MB image size limit. Quota usage and implications/costs for hosting image on Firebase Storage: https://firebase.google.com/pricing */ - image?: string; + image?: string | null; /** * The notification's title. */ - title?: string; + title?: string | null; } /** * Request to send a message to specified target. @@ -414,7 +414,7 @@ export namespace fcm_v1 { /** * Flag for testing the request without actually delivering the message. */ - validateOnly?: boolean; + validateOnly?: boolean | null; } /** * [Webpush protocol](https://tools.ietf.org/html/rfc8030) options. @@ -423,7 +423,7 @@ export namespace fcm_v1 { /** * Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. */ - data?: {[key: string]: string}; + data?: {[key: string]: string} | null; /** * Options for features provided by the FCM SDK for Web. */ @@ -431,11 +431,11 @@ export namespace fcm_v1 { /** * HTTP headers defined in webpush protocol. Refer to [Webpush protocol](https://tools.ietf.org/html/rfc8030#section-5) for supported headers, e.g. "TTL": "15". */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * Web Notification options as a JSON object. Supports Notification instance properties as defined in [Web Notification API](https://developer.mozilla.org/en-US/docs/Web/API/Notification). If present, "title" and "body" fields override [google.firebase.fcm.v1.Notification.title] and [google.firebase.fcm.v1.Notification.body]. */ - notification?: {[key: string]: any}; + notification?: {[key: string]: any} | null; } /** * Options for features provided by the FCM SDK for Web. @@ -444,7 +444,7 @@ export namespace fcm_v1 { /** * The link to open when the user clicks on the notification. For all URL values, HTTPS is required. */ - link?: string; + link?: string | null; } export class Resource$Projects { diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 82df3292237..c0fc4607688 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -132,11 +132,11 @@ export namespace file_v1 { /** * File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. */ - capacityGb?: string; + capacityGb?: string | null; /** * The name of the file share (must be 16 characters or less). */ - name?: string; + name?: string | null; } /** * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", }, "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } ``` @@ -145,33 +145,33 @@ export namespace file_v1 { /** * consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances. */ - consumerDefinedName?: string; + consumerDefinedName?: string | null; /** * Output only. Timestamp when the resource was created. */ - createTime?: string; + createTime?: string | null; /** * Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. */ - maintenancePolicyNames?: {[key: string]: string}; + maintenancePolicyNames?: {[key: string]: string} | null; /** * The MaintenanceSchedule contains the scheduling information of published maintenance schedule. */ maintenanceSchedules?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule; - }; + } | null; /** * Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` */ - name?: string; + name?: string | null; /** * Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata. */ - producerMetadata?: {[key: string]: string}; + producerMetadata?: {[key: string]: string} | null; /** * Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata. */ @@ -181,7 +181,7 @@ export namespace file_v1 { */ rolloutMetadata?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; - }; + } | null; /** * Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. */ @@ -189,19 +189,19 @@ export namespace file_v1 { /** * Software versions that are used to deploy this instance. This can be mutated by rollout services. */ - softwareVersions?: {[key: string]: string}; + softwareVersions?: {[key: string]: string} | null; /** * Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use). */ - state?: string; + state?: string | null; /** * Output only. ID of the associated GCP tenant project. See go/get-instance-metadata. */ - tenantProjectId?: string; + tenantProjectId?: string | null; /** * Output only. Timestamp when the resource was last modified. */ - updateTime?: string; + updateTime?: string | null; } /** * Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule @@ -210,15 +210,15 @@ export namespace file_v1 { /** * Can this scheduled update be rescheduled? By default, it's true and API needs to do explicitly check whether it's set, if it's set as false explicitly, it's false */ - canReschedule?: boolean; + canReschedule?: boolean | null; /** * The scheduled end time for the maintenance. */ - endTime?: string; + endTime?: string | null; /** * The scheduled start time for the maintenance. */ - startTime?: string; + startTime?: string | null; } /** * Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information. @@ -231,11 +231,11 @@ export namespace file_v1 { /** * The location of the node, if different from instance location. */ - location?: string; + location?: string | null; /** * The id of the node. This should be equal to SaasInstanceNode.node_id. */ - nodeId?: string; + nodeId?: string | null; } /** * NotificationMetadata is the notification state for an instance. @@ -244,19 +244,19 @@ export namespace file_v1 { /** * Whether the instance update has been rescheduled. */ - rescheduled?: boolean; + rescheduled?: boolean | null; /** * The scheduled end time for the maintenance window during which update can be performed on the instance. */ - scheduledEndTime?: string; + scheduledEndTime?: string | null; /** * The scheduled start time for the maintenance window during which update can be performed on the instance. */ - scheduledStartTime?: string; + scheduledStartTime?: string | null; /** * The target release to be applied to the instance. */ - targetRelease?: string; + targetRelease?: string | null; } /** * Describes provisioned dataplane resources. @@ -265,11 +265,11 @@ export namespace file_v1 { /** * Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'. */ - resourceType?: string; + resourceType?: string | null; /** * URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)". */ - resourceUrl?: string; + resourceUrl?: string | null; } /** * RolloutMetadata for an actuation instance. It maps to a single RolloutType. @@ -282,11 +282,11 @@ export namespace file_v1 { /** * The last Release that has been applied to the instance. */ - releaseName?: string; + releaseName?: string | null; /** * The last rollout that has been applied to the instance. */ - rolloutName?: string; + rolloutName?: string | null; } /** * SloExclusion represents an excusion in SLI calculation applies to all SLOs. @@ -295,19 +295,19 @@ export namespace file_v1 { /** * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. */ - exclusionDuration?: string; + exclusionDuration?: string | null; /** * Start time of the exclusion. No alignment (e.g. to a full minute) needed. */ - exclusionStartTime?: string; + exclusionStartTime?: 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. */ - reason?: string; + reason?: string | null; /** * 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; + sliName?: string | null; } /** * SloMetadata contains resources required for proper SLO classification of the instance. @@ -324,7 +324,7 @@ export namespace file_v1 { /** * Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. */ - tier?: string; + tier?: string | null; } /** * A Cloud Filestore instance. @@ -333,15 +333,15 @@ export namespace file_v1 { /** * Output only. The time when the instance was created. */ - createTime?: string; + createTime?: string | null; /** * Optional. A description of the instance (2048 characters or less). */ - description?: string; + description?: string | null; /** * Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. */ - etag?: string; + etag?: string | null; /** * File system shares on the instance. For this version, only a single file share is supported. */ @@ -349,11 +349,11 @@ export namespace file_v1 { /** * Resource labels to represent user provided metadata. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. */ - name?: string; + name?: string | null; /** * VPC networks to which the instance is connected. For this version, only a single network is supported. */ @@ -361,15 +361,15 @@ export namespace file_v1 { /** * Output only. The instance state. */ - state?: string; + state?: string | null; /** * Output only. Additional information about the instance state, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * The service tier of the instance. */ - tier?: string; + tier?: string | null; } /** * ListInstancesResponse is the result of ListInstancesRequest. @@ -382,11 +382,11 @@ export namespace file_v1 { /** * The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -399,7 +399,7 @@ export namespace file_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -408,7 +408,7 @@ export namespace file_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -421,23 +421,23 @@ export namespace file_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Network configuration for the instance. @@ -446,19 +446,19 @@ export namespace file_v1 { /** * Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}. */ - ipAddresses?: string[]; + ipAddresses?: string[] | null; /** * Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. */ - modes?: string[]; + modes?: string[] | null; /** * The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. */ - network?: string; + network?: string | null; /** * A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. */ - reservedIpRange?: string; + reservedIpRange?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -467,7 +467,7 @@ export namespace file_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -475,15 +475,15 @@ export namespace file_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Represents the metadata of the long-running operation. @@ -492,31 +492,31 @@ export namespace file_v1 { /** * [Output only] API version used to start the operation. */ - apiVersion?: string; + apiVersion?: string | null; /** * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ - cancelRequested?: boolean; + cancelRequested?: boolean | null; /** * [Output only] The time the operation was created. */ - createTime?: string; + createTime?: string | null; /** * [Output only] The time the operation finished running. */ - endTime?: string; + endTime?: string | null; /** * [Output only] Human-readable status of the operation, if any. */ - statusDetail?: string; + statusDetail?: string | null; /** * [Output only] Server-defined resource path for the target of the operation. */ - target?: string; + target?: string | null; /** * [Output only] Name of the verb executed by the operation. */ - verb?: string; + verb?: 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). @@ -525,15 +525,15 @@ export namespace file_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 1a2e9fc0868..0cc5e3c96b8 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -132,11 +132,11 @@ export namespace file_v1beta1 { /** * File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. */ - capacityGb?: string; + capacityGb?: string | null; /** * The name of the file share (must be 16 characters or less). */ - name?: string; + name?: string | null; } /** * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", }, "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } ``` @@ -145,33 +145,33 @@ export namespace file_v1beta1 { /** * consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances. */ - consumerDefinedName?: string; + consumerDefinedName?: string | null; /** * Output only. Timestamp when the resource was created. */ - createTime?: string; + createTime?: string | null; /** * Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. */ - maintenancePolicyNames?: {[key: string]: string}; + maintenancePolicyNames?: {[key: string]: string} | null; /** * The MaintenanceSchedule contains the scheduling information of published maintenance schedule. */ maintenanceSchedules?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule; - }; + } | null; /** * Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` */ - name?: string; + name?: string | null; /** * Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata. */ - producerMetadata?: {[key: string]: string}; + producerMetadata?: {[key: string]: string} | null; /** * Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata. */ @@ -181,7 +181,7 @@ export namespace file_v1beta1 { */ rolloutMetadata?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; - }; + } | null; /** * Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. */ @@ -189,19 +189,19 @@ export namespace file_v1beta1 { /** * Software versions that are used to deploy this instance. This can be mutated by rollout services. */ - softwareVersions?: {[key: string]: string}; + softwareVersions?: {[key: string]: string} | null; /** * Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use). */ - state?: string; + state?: string | null; /** * Output only. ID of the associated GCP tenant project. See go/get-instance-metadata. */ - tenantProjectId?: string; + tenantProjectId?: string | null; /** * Output only. Timestamp when the resource was last modified. */ - updateTime?: string; + updateTime?: string | null; } /** * Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule @@ -210,15 +210,15 @@ export namespace file_v1beta1 { /** * Can this scheduled update be rescheduled? By default, it's true and API needs to do explicitly check whether it's set, if it's set as false explicitly, it's false */ - canReschedule?: boolean; + canReschedule?: boolean | null; /** * The scheduled end time for the maintenance. */ - endTime?: string; + endTime?: string | null; /** * The scheduled start time for the maintenance. */ - startTime?: string; + startTime?: string | null; } /** * Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information. @@ -231,11 +231,11 @@ export namespace file_v1beta1 { /** * The location of the node, if different from instance location. */ - location?: string; + location?: string | null; /** * The id of the node. This should be equal to SaasInstanceNode.node_id. */ - nodeId?: string; + nodeId?: string | null; } /** * NotificationMetadata is the notification state for an instance. @@ -244,19 +244,19 @@ export namespace file_v1beta1 { /** * Whether the instance update has been rescheduled. */ - rescheduled?: boolean; + rescheduled?: boolean | null; /** * The scheduled end time for the maintenance window during which update can be performed on the instance. */ - scheduledEndTime?: string; + scheduledEndTime?: string | null; /** * The scheduled start time for the maintenance window during which update can be performed on the instance. */ - scheduledStartTime?: string; + scheduledStartTime?: string | null; /** * The target release to be applied to the instance. */ - targetRelease?: string; + targetRelease?: string | null; } /** * Describes provisioned dataplane resources. @@ -265,11 +265,11 @@ export namespace file_v1beta1 { /** * Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'. */ - resourceType?: string; + resourceType?: string | null; /** * URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)". */ - resourceUrl?: string; + resourceUrl?: string | null; } /** * RolloutMetadata for an actuation instance. It maps to a single RolloutType. @@ -282,11 +282,11 @@ export namespace file_v1beta1 { /** * The last Release that has been applied to the instance. */ - releaseName?: string; + releaseName?: string | null; /** * The last rollout that has been applied to the instance. */ - rolloutName?: string; + rolloutName?: string | null; } /** * SloExclusion represents an excusion in SLI calculation applies to all SLOs. @@ -295,19 +295,19 @@ export namespace file_v1beta1 { /** * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. */ - exclusionDuration?: string; + exclusionDuration?: string | null; /** * Start time of the exclusion. No alignment (e.g. to a full minute) needed. */ - exclusionStartTime?: string; + exclusionStartTime?: 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. */ - reason?: string; + reason?: string | null; /** * 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; + sliName?: string | null; } /** * SloMetadata contains resources required for proper SLO classification of the instance. @@ -324,7 +324,7 @@ export namespace file_v1beta1 { /** * Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. */ - tier?: string; + tier?: string | null; } /** * A Cloud Filestore instance. @@ -333,15 +333,15 @@ export namespace file_v1beta1 { /** * Output only. The time when the instance was created. */ - createTime?: string; + createTime?: string | null; /** * Optional. A description of the instance (2048 characters or less). */ - description?: string; + description?: string | null; /** * Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. */ - etag?: string; + etag?: string | null; /** * File system shares on the instance. For this version, only a single file share is supported. */ @@ -349,11 +349,11 @@ export namespace file_v1beta1 { /** * Resource labels to represent user provided metadata. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. */ - name?: string; + name?: string | null; /** * VPC networks to which the instance is connected. For this version, only a single network is supported. */ @@ -361,15 +361,15 @@ export namespace file_v1beta1 { /** * Output only. The instance state. */ - state?: string; + state?: string | null; /** * Output only. Additional information about the instance state, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * The service tier of the instance. */ - tier?: string; + tier?: string | null; } /** * ListInstancesResponse is the result of ListInstancesRequest. @@ -382,11 +382,11 @@ export namespace file_v1beta1 { /** * The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -399,7 +399,7 @@ export namespace file_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -408,7 +408,7 @@ export namespace file_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -421,23 +421,23 @@ export namespace file_v1beta1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * Network configuration for the instance. @@ -446,19 +446,19 @@ export namespace file_v1beta1 { /** * Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}. */ - ipAddresses?: string[]; + ipAddresses?: string[] | null; /** * Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. */ - modes?: string[]; + modes?: string[] | null; /** * The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. */ - network?: string; + network?: string | null; /** * A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. */ - reservedIpRange?: string; + reservedIpRange?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -467,7 +467,7 @@ export namespace file_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -475,15 +475,15 @@ export namespace file_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Represents the metadata of the long-running operation. @@ -492,31 +492,31 @@ export namespace file_v1beta1 { /** * [Output only] API version used to start the operation. */ - apiVersion?: string; + apiVersion?: string | null; /** * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ - cancelRequested?: boolean; + cancelRequested?: boolean | null; /** * [Output only] The time the operation was created. */ - createTime?: string; + createTime?: string | null; /** * [Output only] The time the operation finished running. */ - endTime?: string; + endTime?: string | null; /** * [Output only] Human-readable status of the operation, if any. */ - statusDetail?: string; + statusDetail?: string | null; /** * [Output only] Server-defined resource path for the target of the operation. */ - target?: string; + target?: string | null; /** * [Output only] Name of the verb executed by the operation. */ - verb?: string; + verb?: 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). @@ -525,15 +525,15 @@ export namespace file_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index 0f23d54cc45..d91fe38cf43 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -128,43 +128,43 @@ export namespace firebase_v1beta1 { /** * Deprecated. Instead, to set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to your project. <br> <br>The ID of the project's default GCP resource location. The location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). */ - locationId?: string; + locationId?: string | null; /** * Deprecated. Instead, to link your Project with a Google Analytics account, call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add Firebase resources to your Project. <br> <br>The region code (CLDR) that the account will use for Firebase Analytics data. <br>For example: US, GB, or DE <br> <br>In Java, use `com.google.i18n.identifiers.RegionCode`. */ - regionCode?: string; + regionCode?: string | null; /** * Deprecated. Instead, to link your Project with a Google Analytics account, call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add Firebase resources to your Project. <br> <br>The time zone that the account will use for Firebase Analytics data. <br>For example: America/Los_Angeles or Africa/Abidjan */ - timeZone?: string; + timeZone?: string | null; } export interface Schema$AddGoogleAnalyticsRequest { /** * The ID for the existing [Google Analytics account](http://www.google.com/analytics/) that you want to link with your `FirebaseProject`. <br> <br>Specifying this field will provision a new Google Analytics property in your Google Analytics account and associate the new property with your `FirebaseProject`. */ - analyticsAccountId?: string; + analyticsAccountId?: string | null; /** * The ID for the existing Google Analytics property that you want to associate with your `FirebaseProject`. */ - analyticsPropertyId?: string; + analyticsPropertyId?: string | null; } export interface Schema$AdminSdkConfig { /** * The default Firebase Realtime Database URL. */ - databaseURL?: string; + databaseURL?: string | null; /** * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. */ - locationId?: string; + locationId?: string | null; /** * Immutable. The globally unique, user-assigned project ID of the parent Project. */ - projectId?: string; + projectId?: string | null; /** * The default Cloud Storage for Firebase storage bucket name. */ - storageBucket?: string; + storageBucket?: string | null; } export interface Schema$AnalyticsDetails { /** @@ -183,11 +183,11 @@ export namespace firebase_v1beta1 { /** * The display name of the Google Analytics property associated with the specified `FirebaseProject`. */ - displayName?: string; + displayName?: string | null; /** * The globally unique, Google-assigned identifier of the Google Analytics property associated with the specified `FirebaseProject`. <br> <br>If you called [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link your `FirebaseProject` with a Google Analytics account, the value in this `id` field is the same as the ID of the property either specified or provisioned with that call to `AddGoogleAnalytics`. */ - id?: string; + id?: string | null; } /** * Details of a Firebase App for Android. @@ -196,23 +196,23 @@ export namespace firebase_v1beta1 { /** * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. */ - appId?: string; + appId?: string | null; /** * The user-assigned display name of the App. */ - displayName?: string; + displayName?: string | null; /** * The fully qualified resource name of the App, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code> */ - name?: string; + name?: string | null; /** * The canonical package name of the Android App as would appear in the Google Play Developer Console. */ - packageName?: string; + packageName?: string | null; /** * The globally unique, user-assigned ID of the parent Project for the App. */ - projectId?: string; + projectId?: string | null; } /** * Configuration metadata of a single Firebase App for Android. @@ -221,11 +221,11 @@ export namespace firebase_v1beta1 { /** * The contents of the JSON configuration file. */ - configFileContents?: string; + configFileContents?: string | null; /** * The filename that the configuration artifact is typically saved as. <br>For example: `google-services.json` */ - configFilename?: string; + configFilename?: string | null; } /** * The default resources associated with a `FirebaseProject`. @@ -234,19 +234,19 @@ export namespace firebase_v1beta1 { /** * The default Firebase Hosting site name, in the format: <br><code><var>projectId</var></code> <br>Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: <br><code>myproject123-a5c16</code> */ - hostingSite?: string; + hostingSite?: string | null; /** * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. */ - locationId?: string; + locationId?: string | null; /** * The default Firebase Realtime Database instance name, in the format: <br><code><var>projectId</var></code> <br>Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: <br><code>myproject123-a5c16</code> */ - realtimeDatabaseInstance?: string; + realtimeDatabaseInstance?: string | null; /** * The default Cloud Storage for Firebase storage bucket, in the format: <br><code><var>projectId</var>.appspot.com</code> */ - storageBucket?: string; + storageBucket?: 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 `{}`. @@ -256,7 +256,7 @@ export namespace firebase_v1beta1 { /** * The ID of the default GCP resource location for the Project. The location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). */ - locationId?: string; + locationId?: string | null; } /** * A high-level summary of an App. @@ -265,19 +265,19 @@ export namespace firebase_v1beta1 { /** * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. */ - appId?: string; + appId?: string | null; /** * The user-assigned display name of the Firebase App. */ - displayName?: string; + displayName?: string | null; /** * The fully qualified resource name of the Firebase App, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var> </code> */ - name?: string; + name?: string | null; /** * The platform of the Firebase App. */ - platform?: string; + platform?: string | null; } /** * A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and Google Cloud Platform (GCP) resources. <br> <br>You can create a new `FirebaseProject` in the [Firebase console](https://console.firebase.google.com/), or you can add Firebase resources to an existing [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) by calling AddFirebase. <br> <br>A `FirebaseProject` is actually also a GCP `Project`, so a `FirebaseProject` uses underlying GCP identifiers (most importantly, `projectId`) as its own for easy interop with GCP APIs. @@ -286,19 +286,19 @@ export namespace firebase_v1beta1 { /** * The user-assigned display name of the Project. */ - displayName?: string; + displayName?: string | null; /** * The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var></code> */ - name?: string; + name?: string | null; /** * Immutable. The globally unique, user-assigned ID of the Project. */ - projectId?: string; + projectId?: string | null; /** * The globally unique, Google-assigned identifier of the Project. */ - projectNumber?: string; + projectNumber?: string | null; /** * The default Firebase resources associated with the Project. */ @@ -311,27 +311,27 @@ export namespace firebase_v1beta1 { /** * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. */ - appId?: string; + appId?: string | null; /** * The automatically generated Apple ID assigned to the App by Apple in the iOS App Store. */ - appStoreId?: string; + appStoreId?: string | null; /** * The canonical bundle ID of the iOS App as it would appear in the iOS AppStore. */ - bundleId?: string; + bundleId?: string | null; /** * The user-assigned display name of the App. */ - displayName?: string; + displayName?: string | null; /** * The fully qualified resource name of the App, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> */ - name?: string; + name?: string | null; /** * The globally unique, user-assigned ID of the parent Project for the App. */ - projectId?: string; + projectId?: string | null; } /** * Configuration metadata of a single Firebase App for iOS. @@ -340,11 +340,11 @@ export namespace firebase_v1beta1 { /** * The content of the XML configuration file. */ - configFileContents?: string; + configFileContents?: string | null; /** * The filename that the configuration artifact is typically saved as. <br>For example: `GoogleService-Info.plist` */ - configFilename?: string; + configFilename?: string | null; } export interface Schema$ListAndroidAppsResponse { /** @@ -354,7 +354,7 @@ export namespace firebase_v1beta1 { /** * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent call to `ListAndroidApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListAvailableLocationsResponse { /** @@ -364,13 +364,13 @@ export namespace firebase_v1beta1 { /** * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results and all available locations have been listed. <br> <br>This token can be used in a subsequent call to `ListAvailableLocations` to find more locations. <br> <br>Page tokens are short-lived and should not be persisted. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListAvailableProjectsResponse { /** * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent calls to `ListAvailableProjects` to find the next group of GCP `Projects`. <br> <br>Page tokens are short-lived and should not be persisted. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of GCP `Projects` which can have Firebase resources added to them. */ @@ -380,7 +380,7 @@ export namespace firebase_v1beta1 { /** * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent calls to `ListFirebaseProjects` to find the next group of Projects. <br> <br>Page tokens are short-lived and should not be persisted. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * One page of the list of Projects that are accessible to the caller. */ @@ -394,7 +394,7 @@ export namespace firebase_v1beta1 { /** * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent call to `ListIosApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListShaCertificatesResponse { /** @@ -410,7 +410,7 @@ export namespace firebase_v1beta1 { /** * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent call to `ListWebApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A GCP resource location that can be selected for a Project. @@ -419,7 +419,7 @@ export namespace firebase_v1beta1 { /** * The ID of the default GCP resource location. It must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). */ - locationId?: string; + locationId?: string | null; } /** * This is proto2's version of MessageSet. @@ -432,7 +432,7 @@ export namespace firebase_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -440,15 +440,15 @@ export namespace firebase_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A reference to a Google Cloud Platform (GCP) `Project`. @@ -457,21 +457,21 @@ export namespace firebase_v1beta1 { /** * The user-assigned display name of the GCP `Project`, for example: <code>My App</code> */ - displayName?: string; + displayName?: string | null; /** * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br> Not all projects will have this field populated. If it is not populated, it means that the project does not yet have a default GCP resource location. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to your project. */ - locationId?: string; + locationId?: string | null; /** * The resource name of the GCP `Project` to which Firebase resources can be added, in the format: <br><code>projects/<var>projectId</var></code> */ - project?: string; + project?: string | null; } export interface Schema$RemoveAnalyticsRequest { /** * Optional. The ID of the Google Analytics property associated with the specified `FirebaseProject`. <ul> <li>If not set, then the Google Analytics property that is currently associated with the specified `FirebaseProject` is removed.</li> <li>If set, and the specified `FirebaseProject` is currently associated with a <em>different</em> Google Analytics property, then the response is a `412 Precondition Failed` error.</li> </ul> */ - analyticsPropertyId?: string; + analyticsPropertyId?: string | null; } export interface Schema$SearchFirebaseAppsResponse { /** @@ -481,7 +481,7 @@ export namespace firebase_v1beta1 { /** * If the result list is too large to fit in a single response, then a token is returned. <br> <br>This token can be used in a subsequent calls to `SearchFirebaseApps` to find the next group of Apps. <br>If the string is empty, then this response is the last page of results. <br>Page tokens are short-lived and should not be persisted. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A SHA-1 or SHA-256 certificate associated with the AndroidApp. @@ -490,15 +490,15 @@ export namespace firebase_v1beta1 { /** * The SHA certificate type. */ - certType?: string; + certType?: string | null; /** * The fully qualified resource name of the `sha-key`, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>/sha/<var>shaId</var></code> */ - name?: string; + name?: string | null; /** * The certificate hash for the App. */ - shaHash?: string; + shaHash?: 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). @@ -507,15 +507,15 @@ export namespace firebase_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Wire-format for a Status object @@ -524,15 +524,15 @@ export namespace firebase_v1beta1 { /** * The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing. */ - canonicalCode?: number; + canonicalCode?: number | null; /** * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto */ - code?: number; + code?: number | null; /** * Detail message */ - message?: string; + message?: string | null; /** * message_set associates an arbitrary proto message with the status. */ @@ -544,7 +544,7 @@ export namespace firebase_v1beta1 { /** * The following are usually only present when code != 0 Space to which this status belongs */ - space?: string; + space?: string | null; } /** * A mapping of a Firebase App to a Google Analytics data stream @@ -553,11 +553,11 @@ export namespace firebase_v1beta1 { /** * The fully qualified resource name of the Firebase App associated with the Google Analytics data stream, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code> */ - app?: string; + app?: string | null; /** * The unique Google-assigned identifier of the Google Analytics data stream associated with the Firebase App. <br> <br>Learn more about Google Analytics data streams in the [Analytics documentation](https://support.google.com/analytics/answer/9303323). */ - streamId?: string; + streamId?: string | null; } /** * Message that groups a protocol type_id (as defined by MessageSet), with an encoded message of that type. Its use is similar to MessageSet, except it represents a single (type, encoded message) instead of a set. To fill for known protocol type: MyProtocolMsg proto; TypedMessage typed_msg; typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID); proto.AppendToCord(typed_msg.mutable_message()); To fill for unknown protocol type: ProtocolMessage proto; TypedMessage typed_msg; typed_msg.set_type_id(proto.GetMapper()->type_id()); proto.AppendToCord(typed_msg.mutable_message()); @@ -566,11 +566,11 @@ export namespace firebase_v1beta1 { /** * Message bytes. */ - message?: string; + message?: string | null; /** * Identifier for the type. */ - typeId?: number; + typeId?: number | null; } /** * Details of a Firebase App for the web. @@ -579,23 +579,23 @@ export namespace firebase_v1beta1 { /** * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. */ - appId?: string; + appId?: string | null; /** * The fully qualified URLs where the App is hosted. */ - appUrls?: string[]; + appUrls?: string[] | null; /** * The user-assigned display name of the App. */ - displayName?: string; + displayName?: string | null; /** * The fully qualified resource name of the App, for example: <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> */ - name?: string; + name?: string | null; /** * The globally unique, user-assigned ID of the parent Project for the App. */ - projectId?: string; + projectId?: string | null; } /** * Configuration metadata of a single Firebase App for the web. @@ -604,35 +604,35 @@ export namespace firebase_v1beta1 { /** * The API key associated with the web App. */ - apiKey?: string; + apiKey?: string | null; /** * Immutable. The globally unique, Firebase-assigned identifier of the App. */ - appId?: string; + appId?: string | null; /** * The domain Firebase Auth configures for OAuth redirects, in the format: <br><code><var>projectId</var>.firebaseapp.com</code> */ - authDomain?: string; + authDomain?: string | null; /** * The default Firebase Realtime Database URL. */ - databaseURL?: string; + databaseURL?: string | null; /** * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. */ - locationId?: string; + locationId?: string | null; /** * The sender ID for use with Firebase Cloud Messaging. */ - messagingSenderId?: string; + messagingSenderId?: string | null; /** * Immutable. The globally unique, user-assigned project ID of the parent Project for the App. */ - projectId?: string; + projectId?: string | null; /** * The default Cloud Storage for Firebase storage bucket name. */ - storageBucket?: string; + storageBucket?: string | null; } export class Resource$Availableprojects { diff --git a/src/apis/firebasedynamiclinks/v1.ts b/src/apis/firebasedynamiclinks/v1.ts index 49a6b71abe2..15c99a56c22 100644 --- a/src/apis/firebasedynamiclinks/v1.ts +++ b/src/apis/firebasedynamiclinks/v1.ts @@ -141,19 +141,19 @@ export namespace firebasedynamiclinks_v1 { /** * Link to open on Android if the app is not installed. */ - androidFallbackLink?: string; + androidFallbackLink?: string | null; /** * If specified, this overrides the ‘link’ parameter on Android. */ - androidLink?: string; + androidLink?: string | null; /** * Minimum version code for the Android app. If the installed app’s version code is lower, then the user is taken to the Play Store. */ - androidMinPackageVersionCode?: string; + androidMinPackageVersionCode?: string | null; /** * Android package name of the app. */ - androidPackageName?: string; + androidPackageName?: string | null; } /** * Request to create a managed Short Dynamic Link. @@ -166,15 +166,15 @@ export namespace firebasedynamiclinks_v1 { /** * Full long Dynamic Link URL with desired query parameters specified. For example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). */ - longDynamicLink?: string; + longDynamicLink?: string | null; /** * Link name to associate with the link. It's used for marketer to identify manually-created links in the Firebase console (https://console.firebase.google.com/). Links must be named to be tracked. */ - name?: string; + name?: string | null; /** * Google SDK version. Version takes the form "$major.$minor.$patch" */ - sdkVersion?: string; + sdkVersion?: string | null; /** * Short Dynamic Link suffix. Optional. */ @@ -191,7 +191,7 @@ export namespace firebasedynamiclinks_v1 { /** * Preview link to show the link flow chart. (debug info.) */ - previewLink?: string; + previewLink?: string | null; /** * Information about potential warnings on link creation. */ @@ -208,11 +208,11 @@ export namespace firebasedynamiclinks_v1 { /** * Full long Dynamic Link URL with desired query parameters specified. For example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). */ - longDynamicLink?: string; + longDynamicLink?: string | null; /** * Google SDK version. Version takes the form "$major.$minor.$patch" */ - sdkVersion?: string; + sdkVersion?: string | null; /** * Short Dynamic Link suffix. Optional. */ @@ -225,11 +225,11 @@ export namespace firebasedynamiclinks_v1 { /** * Preview link to show the link flow chart. (debug info.) */ - previewLink?: string; + previewLink?: string | null; /** * Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz */ - shortLink?: string; + shortLink?: string | null; /** * Information about potential warnings on link creation. */ @@ -242,7 +242,7 @@ export namespace firebasedynamiclinks_v1 { /** * Link to open on desktop. */ - desktopFallbackLink?: string; + desktopFallbackLink?: string | null; } /** * Signals associated with the device making the request. @@ -251,31 +251,31 @@ export namespace firebasedynamiclinks_v1 { /** * Device model name. */ - deviceModelName?: string; + deviceModelName?: string | null; /** * Device language code setting. */ - languageCode?: string; + languageCode?: string | null; /** * Device language code setting obtained by executing JavaScript code in WebView. */ - languageCodeFromWebview?: string; + languageCodeFromWebview?: string | null; /** * Device language code raw setting. iOS does returns language code in different format than iOS WebView. For example WebView returns en_US, but iOS returns en-US. Field below will return raw value returned by iOS. */ - languageCodeRaw?: string; + languageCodeRaw?: string | null; /** * Device display resolution height. */ - screenResolutionHeight?: string; + screenResolutionHeight?: string | null; /** * Device display resolution width. */ - screenResolutionWidth?: string; + screenResolutionWidth?: string | null; /** * Device timezone setting. */ - timezone?: string; + timezone?: string | null; } /** * Dynamic Link event stat. @@ -284,15 +284,15 @@ export namespace firebasedynamiclinks_v1 { /** * The number of times this event occurred. */ - count?: string; + count?: string | null; /** * Link event. */ - event?: string; + event?: string | null; /** * Requested platform. */ - platform?: string; + platform?: string | null; } /** * Information about a Dynamic Link. @@ -313,11 +313,11 @@ export namespace firebasedynamiclinks_v1 { /** * E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing */ - domainUriPrefix?: string; + domainUriPrefix?: string | null; /** * Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl [Learn more](https://firebase.google.com/docs/dynamic-links/android/receive) on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix. */ - dynamicLinkDomain?: string; + dynamicLinkDomain?: string | null; /** * iOS related information. See iOS related parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). */ @@ -325,7 +325,7 @@ export namespace firebasedynamiclinks_v1 { /** * The link your app will open, You can specify any URL your app can handle. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or HTTPS scheme. See 'link' parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). Required. */ - link?: string; + link?: string | null; /** * Information of navigation behavior of a Firebase Dynamic Links. */ @@ -351,15 +351,15 @@ export namespace firebasedynamiclinks_v1 { /** * The warning code. */ - warningCode?: string; + warningCode?: string | null; /** * The document describing the warning, and helps resolve. */ - warningDocumentLink?: string; + warningDocumentLink?: string | null; /** * The warning message to help developers improve their requests. */ - warningMessage?: string; + warningMessage?: string | null; } /** * Request for iSDK to execute strong match flow for post-install attribution. This is meant for iOS requests only. Requests from other platforms will not be honored. @@ -368,11 +368,11 @@ export namespace firebasedynamiclinks_v1 { /** * App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match. */ - appInstallationTime?: string; + appInstallationTime?: string | null; /** * APP bundle ID. */ - bundleId?: string; + bundleId?: string | null; /** * Device information. */ @@ -380,23 +380,23 @@ export namespace firebasedynamiclinks_v1 { /** * iOS version, ie: 9.3.5. Consider adding "build". */ - iosVersion?: string; + iosVersion?: string | null; /** * App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link. */ - retrievalMethod?: string; + retrievalMethod?: string | null; /** * Google SDK version. Version takes the form "$major.$minor.$patch" */ - sdkVersion?: string; + sdkVersion?: string | null; /** * Possible unique matched link that server need to check before performing fingerprint match. If passed link is short server need to expand the link. If link is long server need to vslidate the link. */ - uniqueMatchLinkToCheck?: string; + uniqueMatchLinkToCheck?: string | null; /** * Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie. */ - visualStyle?: string; + visualStyle?: string | null; } /** * Response for iSDK to execute strong match flow for post-install attribution. @@ -405,67 +405,67 @@ export namespace firebasedynamiclinks_v1 { /** * The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this. */ - appMinimumVersion?: string; + appMinimumVersion?: string | null; /** * The confidence of the returned attribution. */ - attributionConfidence?: string; + attributionConfidence?: string | null; /** * The deep-link attributed post-install via one of several techniques (fingerprint, copy unique). */ - deepLink?: string; + deepLink?: string | null; /** * User-agent specific custom-scheme URIs for iSDK to open. This will be set according to the user-agent tha the click was originally made in. There is no Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com */ - externalBrowserDestinationLink?: string; + externalBrowserDestinationLink?: string | null; /** * The link to navigate to update the app if min version is not met. This is either (in order): 1) fallback link (from ?ifl= parameter, if specified by developer) or 2) AppStore URL (from ?isi= parameter, if specified), or 3) the payload link (from required link= parameter). */ - fallbackLink?: string; + fallbackLink?: string | null; /** * Invitation ID attributed post-install via one of several techniques (fingerprint, copy unique). */ - invitationId?: string; + invitationId?: string | null; /** * Instruction for iSDK to attemmpt to perform strong match. For instance, if browser does not support/allow cookie or outside of support browsers, this will be false. */ - isStrongMatchExecutable?: boolean; + isStrongMatchExecutable?: boolean | null; /** * Describes why match failed, ie: "discarded due to low confidence". This message will be publicly visible. */ - matchMessage?: string; + matchMessage?: string | null; /** * Entire FDL (short or long) attributed post-install via one of several techniques (fingerprint, copy unique). */ - requestedLink?: string; + requestedLink?: string | null; /** * Which IP version the request was made from. */ - requestIpVersion?: string; + requestIpVersion?: string | null; /** * The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. Parameters from this should not be used directly (ie: server can default utm_[campaign|medium|source] to a value when requested_link lack them, server determine the best fallback_link when requested_link specifies >1 fallback links). */ - resolvedLink?: string; + resolvedLink?: string | null; /** * Scion campaign value to be propagated by iSDK to Scion at post-install. */ - utmCampaign?: string; + utmCampaign?: string | null; /** * Scion content value to be propagated by iSDK to Scion at app-reopen. */ - utmContent?: string; + utmContent?: string | null; /** * Scion medium value to be propagated by iSDK to Scion at post-install. */ - utmMedium?: string; + utmMedium?: string | null; /** * Scion source value to be propagated by iSDK to Scion at post-install. */ - utmSource?: string; + utmSource?: string | null; /** * Scion term value to be propagated by iSDK to Scion at app-reopen. */ - utmTerm?: string; + utmTerm?: string | null; } /** * Request for iSDK to get reopen attribution for app universal link open deeplinking. This endpoint is meant for only iOS requests. @@ -474,15 +474,15 @@ export namespace firebasedynamiclinks_v1 { /** * APP bundle ID. */ - bundleId?: string; + bundleId?: string | null; /** * FDL link to be verified from an app universal link open. The FDL link can be one of: 1) short FDL. e.g. <app_code>.page.link/<ddl_id>, or 2) long FDL. e.g. <app_code>.page.link/?{query params}, or 3) Invite FDL. e.g. <app_code>.page.link/i/<invite_id_or_alias> */ - requestedLink?: string; + requestedLink?: string | null; /** * Google SDK version. Version takes the form "$major.$minor.$patch" */ - sdkVersion?: string; + sdkVersion?: string | null; } /** * Response for iSDK to get reopen attribution for app universal link open deeplinking. This endpoint is meant for only iOS requests. @@ -491,39 +491,39 @@ export namespace firebasedynamiclinks_v1 { /** * The deep-link attributed the app universal link open. For both regular FDL links and invite FDL links. */ - deepLink?: string; + deepLink?: string | null; /** * Optional invitation ID, for only invite typed requested FDL links. */ - invitationId?: string; + invitationId?: string | null; /** * FDL input value of the "&imv=" parameter, minimum app version to be returned to Google Firebase SDK running on iOS-9. */ - iosMinAppVersion?: string; + iosMinAppVersion?: string | null; /** * The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. */ - resolvedLink?: string; + resolvedLink?: string | null; /** * Scion campaign value to be propagated by iSDK to Scion at app-reopen. */ - utmCampaign?: string; + utmCampaign?: string | null; /** * Scion content value to be propagated by iSDK to Scion at app-reopen. */ - utmContent?: string; + utmContent?: string | null; /** * Scion medium value to be propagated by iSDK to Scion at app-reopen. */ - utmMedium?: string; + utmMedium?: string | null; /** * Scion source value to be propagated by iSDK to Scion at app-reopen. */ - utmSource?: string; + utmSource?: string | null; /** * Scion term value to be propagated by iSDK to Scion at app-reopen. */ - utmTerm?: string; + utmTerm?: string | null; } /** * Parameters for Google Play Campaign Measurements. [Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params) @@ -532,27 +532,27 @@ export namespace firebasedynamiclinks_v1 { /** * [AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en); used to measure Google AdWords ads. This value is generated dynamically and should never be modified. */ - gclid?: string; + gclid?: string | null; /** * Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign. */ - utmCampaign?: string; + utmCampaign?: string | null; /** * Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL. */ - utmContent?: string; + utmContent?: string | null; /** * Campaign medium; used to identify a medium such as email or cost-per-click. */ - utmMedium?: string; + utmMedium?: string | null; /** * Campaign source; used to identify a search engine, newsletter, or other source. */ - utmSource?: string; + utmSource?: string | null; /** * Campaign term; used with paid search to supply the keywords for ads. */ - utmTerm?: string; + utmTerm?: string | null; } /** * iOS related attributes to the Dynamic Link.. @@ -561,31 +561,31 @@ export namespace firebasedynamiclinks_v1 { /** * iOS App Store ID. */ - iosAppStoreId?: string; + iosAppStoreId?: string | null; /** * iOS bundle ID of the app. */ - iosBundleId?: string; + iosBundleId?: string | null; /** * Custom (destination) scheme to use for iOS. By default, we’ll use the bundle ID as the custom scheme. Developer can override this behavior using this param. */ - iosCustomScheme?: string; + iosCustomScheme?: string | null; /** * Link to open on iOS if the app is not installed. */ - iosFallbackLink?: string; + iosFallbackLink?: string | null; /** * iPad bundle ID of the app. */ - iosIpadBundleId?: string; + iosIpadBundleId?: string | null; /** * If specified, this overrides the ios_fallback_link value on iPads. */ - iosIpadFallbackLink?: string; + iosIpadFallbackLink?: string | null; /** * iOS minimum version. */ - iosMinimumVersion?: string; + iosMinimumVersion?: string | null; } /** * Parameters for iTunes Connect App Analytics. @@ -594,19 +594,19 @@ export namespace firebasedynamiclinks_v1 { /** * Affiliate token used to create affiliate-coded links. */ - at?: string; + at?: string | null; /** * Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign. */ - ct?: string; + ct?: string | null; /** * iTune media types, including music, podcasts, audiobooks and so on. */ - mt?: string; + mt?: string | null; /** * Provider token that enables analytics for Dynamic Links from within iTunes Connect. */ - pt?: string; + pt?: string | null; } /** * Managed Short Link. @@ -615,11 +615,11 @@ export namespace firebasedynamiclinks_v1 { /** * Creation timestamp of the short link. */ - creationTime?: string; + creationTime?: string | null; /** * Attributes that have been flagged about this short url. */ - flaggedAttribute?: string[]; + flaggedAttribute?: string[] | null; /** * Full Dyamic Link info */ @@ -627,15 +627,15 @@ export namespace firebasedynamiclinks_v1 { /** * Short durable link url, for example, "https://sample.app.goo.gl/xyz123". Required. */ - link?: string; + link?: string | null; /** * Link name defined by the creator. Required. */ - linkName?: string; + linkName?: string | null; /** * Visibility status of link. */ - visibility?: string; + visibility?: string | null; } /** * Information of navigation behavior. @@ -644,7 +644,7 @@ export namespace firebasedynamiclinks_v1 { /** * If this option is on, FDL click will be forced to redirect rather than show an interstitial page. */ - enableForcedRedirect?: boolean; + enableForcedRedirect?: boolean | null; } /** * Parameters for social meta tag params. Used to set meta tag data for link previews on social sites. @@ -653,15 +653,15 @@ export namespace firebasedynamiclinks_v1 { /** * A short description of the link. Optional. */ - socialDescription?: string; + socialDescription?: string | null; /** * An image url string. Optional. */ - socialImageLink?: string; + socialImageLink?: string | null; /** * Title to be displayed. Optional. */ - socialTitle?: string; + socialTitle?: string | null; } /** * Short Dynamic Link suffix. @@ -670,11 +670,11 @@ export namespace firebasedynamiclinks_v1 { /** * Only applies to Option.CUSTOM. */ - customSuffix?: string; + customSuffix?: string | null; /** * Suffix option. */ - option?: string; + option?: string | null; } export class Resource$Managedshortlinks { diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index bc60a0fcb6d..007db771cf9 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -124,11 +124,11 @@ export namespace firebasehosting_v1beta1 { /** * The email address of the user when the user performed the action. */ - email?: string; + email?: string | null; /** * A profile image URL for the user. May not be present if the user has changed their email address or deleted their account. */ - imageUrl?: string; + imageUrl?: string | null; } /** * Represents a DNS certificate challenge. @@ -137,11 +137,11 @@ export namespace firebasehosting_v1beta1 { /** * The domain name upon which the DNS challenge must be satisfied. */ - domainName?: string; + domainName?: string | null; /** * The value that must be present as a TXT record on the domain name to satisfy the challenge. */ - token?: string; + token?: string | null; } /** * Represents an HTTP certificate challenge. @@ -150,11 +150,11 @@ export namespace firebasehosting_v1beta1 { /** * The URL path on which to serve the specified token to satisfy the certificate challenge. */ - path?: string; + path?: string | null; /** * The token to serve at the specified URL path to satisfy the certificate challenge. */ - token?: string; + token?: string | null; } /** * A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). @@ -163,11 +163,11 @@ export namespace firebasehosting_v1beta1 { /** * Optional. User-provided region where the Cloud Run service is hosted.<br> Defaults to `us-central1` if not supplied. */ - region?: string; + region?: string | null; /** * Required. User-defined ID of the Cloud Run service. */ - serviceId?: string; + serviceId?: string | null; } /** * The intended behavior and status information of a domain. @@ -176,7 +176,7 @@ export namespace firebasehosting_v1beta1 { /** * Required. The domain name of the association. */ - domainName?: string; + domainName?: string | null; /** * If set, the domain should redirect with the provided parameters. */ @@ -188,15 +188,15 @@ export namespace firebasehosting_v1beta1 { /** * Required. The site name of the association. */ - site?: string; + site?: string | null; /** * Output only. Additional status of the domain association. */ - status?: string; + status?: string | null; /** * Output only. The time at which the domain was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The current certificate provisioning status information for a domain. @@ -205,7 +205,7 @@ export namespace firebasehosting_v1beta1 { /** * The TXT records (for the certificate challenge) that were found at the last DNS fetch. */ - certChallengeDiscoveredTxt?: string[]; + certChallengeDiscoveredTxt?: string[] | null; /** * The DNS challenge for generating a certificate. */ @@ -217,23 +217,23 @@ export namespace firebasehosting_v1beta1 { /** * The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. */ - certStatus?: string; + certStatus?: string | null; /** * The IPs found at the last DNS fetch. */ - discoveredIps?: string[]; + discoveredIps?: string[] | null; /** * The time at which the last DNS fetch occurred. */ - dnsFetchTime?: string; + dnsFetchTime?: string | null; /** * The DNS record match status as of the last DNS fetch. */ - dnsStatus?: string; + dnsStatus?: string | null; /** * The list of IPs to which the domain is expected to resolve. */ - expectedIps?: string[]; + expectedIps?: string[] | null; } /** * Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. @@ -242,11 +242,11 @@ export namespace firebasehosting_v1beta1 { /** * Required. The domain name to redirect to. */ - domainName?: string; + domainName?: string | null; /** * Required. The redirect status code. */ - type?: string; + type?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -259,15 +259,15 @@ export namespace firebasehosting_v1beta1 { /** * The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. */ - glob?: string; + glob?: string | null; /** * Required. The additional headers to add to the response. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The user-supplied RE2 regular expression to match against the request URL path. */ - regex?: string; + regex?: string | null; } export interface Schema$ListDomainsResponse { /** @@ -277,13 +277,13 @@ export namespace firebasehosting_v1beta1 { /** * The pagination token, if more results exist. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListReleasesResponse { /** * If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of hashes of files that still need to be uploaded, if any exist. */ @@ -297,23 +297,23 @@ export namespace firebasehosting_v1beta1 { /** * The pagination token, if more results exist. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$PopulateVersionFilesRequest { /** * A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file. */ - files?: {[key: string]: string}; + files?: {[key: string]: string} | null; } export interface Schema$PopulateVersionFilesResponse { /** * The content hashes of the specified files that need to be uploaded to the specified endpoint. */ - uploadRequiredHashes?: string[]; + uploadRequiredHashes?: string[] | null; /** * The URL to which the files should be uploaded, in the format: <br>"https://upload-firebasehosting.googleapis.com/upload/sites/<var>site-name</var>/versions/<var>versionID</var>/files". <br>Perform a multipart `POST` of the Gzipped file contents to the URL using a forward slash and the hash of the file appended to the end. */ - uploadUrl?: string; + uploadUrl?: string | null; } /** * A [`redirect`](/docs/hosting/full-config#redirects) represents the configuration for returning an HTTP redirect response given a matching request URL path. @@ -322,19 +322,19 @@ export namespace firebasehosting_v1beta1 { /** * The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. */ - glob?: string; + glob?: string | null; /** * Required. The value to put in the HTTP location header of the response. <br>The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: <code>"glob": "/:capture*", <br>"statusCode": 301, <br>"location": "https://example.com/foo/:capture"</code> */ - location?: string; + location?: string | null; /** * The user-supplied RE2 regular expression to match against the request URL path. */ - regex?: string; + regex?: string | null; /** * Required. The status HTTP code to return in the response. It must be a valid 3xx status code. */ - statusCode?: number; + statusCode?: number | null; } /** * A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. @@ -343,15 +343,15 @@ export namespace firebasehosting_v1beta1 { /** * The deploy description when the release was created. The value can be up to 512&nbsp;characters. */ - message?: string; + message?: string | null; /** * Output only. The unique identifier for the release, in the format: <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code> This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint. */ - name?: string; + name?: string | null; /** * Output only. The time at which the version is set to be public. */ - releaseTime?: string; + releaseTime?: string | null; /** * Output only. Identifies the user who created the release. */ @@ -359,7 +359,7 @@ export namespace firebasehosting_v1beta1 { /** * Explains the reason for the release. <br>Specify a value for this field only when creating a `SITE_DISABLE` type release. */ - type?: string; + type?: string | null; /** * Output only. The configuration and content that was released. */ @@ -372,23 +372,23 @@ export namespace firebasehosting_v1beta1 { /** * The request will be forwarded to Firebase Dynamic Links. */ - dynamicLinks?: boolean; + dynamicLinks?: boolean | null; /** * The function to proxy requests to. Must match the exported function name exactly. */ - function?: string; + function?: string | null; /** * The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. */ - glob?: string; + glob?: string | null; /** * The URL path to rewrite the request to. */ - path?: string; + path?: string | null; /** * The user-supplied RE2 regular expression to match against the request URL path. */ - regex?: string; + regex?: string | null; /** * The request will be forwarded to Cloud Run. */ @@ -401,11 +401,11 @@ export namespace firebasehosting_v1beta1 { /** * How to handle well known App Association files. */ - appAssociation?: string; + appAssociation?: string | null; /** * Defines whether to drop the file extension from uploaded files. */ - cleanUrls?: boolean; + cleanUrls?: boolean | null; /** * A list of custom response headers that are added to the content if the request URL path matches the glob. */ @@ -421,7 +421,7 @@ export namespace firebasehosting_v1beta1 { /** * Defines how to handle a trailing slash in the URL path. */ - trailingSlashBehavior?: string; + trailingSlashBehavior?: string | null; } /** * A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior @@ -430,7 +430,7 @@ export namespace firebasehosting_v1beta1 { /** * The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default. */ - maxVersions?: string; + maxVersions?: string | null; } /** * A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. @@ -443,7 +443,7 @@ export namespace firebasehosting_v1beta1 { /** * Output only. The time at which the version was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. Identifies the user who created the version. */ @@ -451,7 +451,7 @@ export namespace firebasehosting_v1beta1 { /** * Output only. The time at which the version was `DELETED`. */ - deleteTime?: string; + deleteTime?: string | null; /** * Output only. Identifies the user who `DELETED` the version. */ @@ -459,11 +459,11 @@ export namespace firebasehosting_v1beta1 { /** * Output only. The total number of files associated with the version. <br>This value is calculated after a version is `FINALIZED`. */ - fileCount?: string; + fileCount?: string | null; /** * Output only. The time at which the version was `FINALIZED`. */ - finalizeTime?: string; + finalizeTime?: string | null; /** * Output only. Identifies the user who `FINALIZED` the version. */ @@ -471,19 +471,19 @@ export namespace firebasehosting_v1beta1 { /** * The labels used for extra metadata and/or filtering. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The unique identifier for a version, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint. */ - name?: string; + name?: string | null; /** * The deploy status of a version. <br> <br>For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. <br> <br>Note that if you leave the version in the `CREATED` state for more than 12&nbsp;hours, the system will automatically mark the version as `ABANDONED`. <br> <br>You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint. */ - status?: string; + status?: string | null; /** * Output only. The total stored bytesize of the version. <br>This value is calculated after a version is `FINALIZED`. */ - versionBytes?: string; + versionBytes?: string | null; } /** * A static content file that is part of a version. @@ -492,15 +492,15 @@ export namespace firebasehosting_v1beta1 { /** * The SHA256 content hash of the file. */ - hash?: string; + hash?: string | null; /** * The URI at which the file's content should display. */ - path?: string; + path?: string | null; /** * Output only. The current status of a particular file in the specified version. <br>The value will be either `pending upload` or `uploaded`. */ - status?: string; + status?: string | null; } export class Resource$Sites { diff --git a/src/apis/firebaserules/v1.ts b/src/apis/firebaserules/v1.ts index 894b15a87b2..50a14651d62 100644 --- a/src/apis/firebaserules/v1.ts +++ b/src/apis/firebaserules/v1.ts @@ -128,7 +128,7 @@ export namespace firebaserules_v1 { /** * Argument exactly matches value provided. */ - exactValue?: any; + exactValue?: any | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -141,15 +141,15 @@ export namespace firebaserules_v1 { /** * Textual Content. */ - content?: string; + content?: string | null; /** * Fingerprint (e.g. github sha) associated with the `File`. */ - fingerprint?: string; + fingerprint?: string | null; /** * File name. */ - name?: string; + name?: string | null; } /** * Represents a service-defined function call that was invoked during test execution. @@ -158,11 +158,11 @@ export namespace firebaserules_v1 { /** * The arguments that were provided to the function. */ - args?: any[]; + args?: any[] | null; /** * Name of the function invoked. */ - function?: string; + function?: string | null; } /** * Mock function definition. Mocks must refer to a function declared by the target service. The type of the function args and result will be inferred at test time. If either the arg or result values are not compatible with function type declaration, the request will be considered invalid. More than one `FunctionMock` may be provided for a given function name so long as the `Arg` matchers are distinct. There may be only one function for a given overload where all `Arg` values are `Arg.any_value`. @@ -175,7 +175,7 @@ export namespace firebaserules_v1 { /** * The name of the function. The function name must match one provided by a service declaration. */ - function?: string; + function?: string | null; /** * The mock result of the function call. */ @@ -188,27 +188,27 @@ export namespace firebaserules_v1 { /** * Executable view of the `Ruleset` referenced by the `Release`. */ - executable?: string; + executable?: string | null; /** * The Rules runtime version of the executable. */ - executableVersion?: string; + executableVersion?: string | null; /** * `Language` used to generate the executable bytes. */ - language?: string; + language?: string | null; /** * `Ruleset` name associated with the `Release` executable. */ - rulesetName?: string; + rulesetName?: string | null; /** * Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive). */ - syncTime?: string; + syncTime?: string | null; /** * Timestamp for the most recent `Release.update_time`. */ - updateTime?: string; + updateTime?: string | null; } /** * Issues include warnings, errors, and deprecation notices. @@ -217,11 +217,11 @@ export namespace firebaserules_v1 { /** * Short error description. */ - description?: string; + description?: string | null; /** * The severity of the issue. */ - severity?: string; + severity?: string | null; /** * Position of the issue in the `Source`. */ @@ -234,7 +234,7 @@ export namespace firebaserules_v1 { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of `Release` instances. */ @@ -247,7 +247,7 @@ export namespace firebaserules_v1 { /** * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of `Ruleset` instances. */ @@ -260,19 +260,19 @@ export namespace firebaserules_v1 { /** * Time the release was created. Output only. */ - createTime?: string; + createTime?: string | null; /** * Resource name for the `Release`. `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2` which affords developers a great deal of flexibility in mapping the name to the style that best fits their existing development practices. For example, a name could refer to an environment, an app, a version, or some combination of three. In the table below, for the project name `projects/foo`, the following relative release paths show how flat and structured names might be chosen to match a desired development / deployment strategy. Use Case | Flat Name | Structured Name -------------|---------------------|---------------- Environments | releases/qa | releases/qa Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa | releases/app1/v2/qa The delimiter between the release name path elements can be almost anything and it should work equally well with the release name list filter, but in many ways the structured paths provide a clearer picture of the relationship between `Release` instances. Format: `projects/{project_id}/releases/{release_id}` */ - name?: string; + name?: string | null; /** * Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. */ - rulesetName?: string; + rulesetName?: string | null; /** * Time the release was updated. Output only. */ - updateTime?: string; + updateTime?: string | null; } /** * Possible result values from the function mock invocation. @@ -285,7 +285,7 @@ export namespace firebaserules_v1 { /** * The result is an actual value. The type of the value must match that of the type declared by the service. */ - value?: any; + value?: any | null; } /** * `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time. @@ -294,11 +294,11 @@ export namespace firebaserules_v1 { /** * Time the `Ruleset` was created. Output only. */ - createTime?: string; + createTime?: string | null; /** * Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only. */ - name?: string; + name?: string | null; /** * `Source` for the `Ruleset`. */ @@ -320,15 +320,15 @@ export namespace firebaserules_v1 { /** * First column on the source line associated with the source fragment. */ - column?: number; + column?: number | null; /** * Name of the `File`. */ - fileName?: string; + fileName?: string | null; /** * Line number of the source fragment. 1-based. */ - line?: number; + line?: number | null; } /** * `TestCase` messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the `request`, `resource`, and `function_mocks` to mock a function call to a service-provided function. The `request` object represents context present at request-time. The `resource` is the value of the target resource as it appears in persistent storage before the request is executed. @@ -337,7 +337,7 @@ export namespace firebaserules_v1 { /** * Test expectation. */ - expectation?: string; + expectation?: 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. */ @@ -345,15 +345,15 @@ export namespace firebaserules_v1 { /** * Specifies whether paths (such as request.path) are encoded and how. */ - pathEncoding?: string; + pathEncoding?: string | null; /** * Request context. The exact format of the request context is service-dependent. See the appropriate service documentation for information about the supported fields and types on the request. Minimally, all services support the following fields and types: Request field | Type ---------------|----------------- auth.uid | `string` auth.token | `map<string, string>` headers | `map<string, string>` method | `string` params | `map<string, string>` path | `string` time | `google.protobuf.Timestamp` If the request value is not well-formed for the service, the request will be rejected as an invalid argument. */ - request?: any; + request?: any | null; /** * Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the `request.path` value. */ - resource?: any; + resource?: any | null; } /** * Test result message containing the state of the test as well as a description and source position for test failures. @@ -362,7 +362,7 @@ export namespace firebaserules_v1 { /** * Debug messages related to test execution issues encountered during evaluation. Debug messages may be related to too many or too few invocations of function mocks or to runtime errors that occur during evaluation. For example: ```Unable to read variable [name: "resource"]``` */ - debugMessages?: string[]; + debugMessages?: string[] | null; /** * 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 }` */ @@ -374,7 +374,7 @@ export namespace firebaserules_v1 { /** * State of the test. */ - state?: string; + state?: string | null; /** * The set of visited permission expressions for a given test. This returns the positions and evaluation results of all visited permission expressions which were relevant to the test case, e.g. ``` match /path { allow read if: <expr> } ``` For a detailed report of the intermediate evaluation states, see the `expression_reports` field */ @@ -426,7 +426,7 @@ export namespace firebaserules_v1 { /** * Specifies which fields to update. */ - updateMask?: string; + updateMask?: string | null; } /** * Store the position and access outcome for an expression visited in rules. @@ -439,7 +439,7 @@ export namespace firebaserules_v1 { /** * The evaluated value for the visited expression, e.g. true/false */ - value?: any; + value?: any | null; } export class Resource$Projects { diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index cc9dff9a509..1151656c3ba 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -133,7 +133,7 @@ export namespace firestore_v1 { /** * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ - documents?: string[]; + documents?: string[] | null; /** * The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. */ @@ -145,11 +145,11 @@ export namespace firestore_v1 { /** * Reads documents as they were at the given time. This may not be older than 60 seconds. */ - readTime?: string; + readTime?: string | null; /** * Reads documents in a transaction. */ - transaction?: string; + transaction?: string | null; } /** * The streamed response for Firestore.BatchGetDocuments. @@ -162,15 +162,15 @@ export namespace firestore_v1 { /** * A document name that was requested but does not exist. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - missing?: string; + missing?: string | null; /** * The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. */ - readTime?: string; + readTime?: string | null; /** * The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request. */ - transaction?: string; + transaction?: string | null; } /** * The request for Firestore.BeginTransaction. @@ -188,7 +188,7 @@ export namespace firestore_v1 { /** * The transaction that was started. */ - transaction?: string; + transaction?: string | null; } /** * A selection of a collection, such as `messages as m1`. @@ -197,11 +197,11 @@ export namespace firestore_v1 { /** * When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections. */ - allDescendants?: boolean; + allDescendants?: boolean | null; /** * The collection ID. When set, selects only collections with this ID. */ - collectionId?: string; + collectionId?: string | null; } /** * The request for Firestore.Commit. @@ -210,7 +210,7 @@ export namespace firestore_v1 { /** * If set, applies all writes in this transaction, and commits it. */ - transaction?: string; + transaction?: string | null; /** * The writes to apply. Always executed atomically and in order. */ @@ -223,7 +223,7 @@ export namespace firestore_v1 { /** * The time at which the commit occurred. */ - commitTime?: string; + commitTime?: string | null; /** * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ @@ -240,7 +240,7 @@ export namespace firestore_v1 { /** * The operator for combining multiple filters. */ - op?: string; + op?: string | null; } /** * A position in a query result set. @@ -249,7 +249,7 @@ export namespace firestore_v1 { /** * If the position is just before or just after the given values, relative to the sort order defined by the query. */ - before?: boolean; + before?: boolean | null; /** * The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. */ @@ -262,19 +262,19 @@ export namespace firestore_v1 { /** * Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. */ - createTime?: string; + createTime?: string | null; /** * The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. */ - fields?: {[key: string]: Schema$Value}; + fields?: {[key: string]: Schema$Value} | null; /** * The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - name?: string; + name?: string | null; /** * Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. */ - updateTime?: string; + updateTime?: string | null; } /** * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. @@ -287,11 +287,11 @@ export namespace firestore_v1 { /** * A set of target IDs for targets that no longer match this document. */ - removedTargetIds?: number[]; + removedTargetIds?: number[] | null; /** * A set of target IDs of targets that match this document. */ - targetIds?: number[]; + targetIds?: number[] | null; } /** * A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected. @@ -300,15 +300,15 @@ export namespace firestore_v1 { /** * The resource name of the Document that was deleted. */ - document?: string; + document?: string | null; /** * The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete. */ - readTime?: string; + readTime?: string | null; /** * A set of target IDs for targets that previously matched this entity. */ - removedTargetIds?: number[]; + removedTargetIds?: number[] | null; } /** * A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value. @@ -317,7 +317,7 @@ export namespace firestore_v1 { /** * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ - fieldPaths?: string[]; + fieldPaths?: string[] | null; } /** * A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected. @@ -326,15 +326,15 @@ export namespace firestore_v1 { /** * The resource name of the Document that has gone out of view. */ - document?: string; + document?: string | null; /** * The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove. */ - readTime?: string; + readTime?: string | null; /** * A set of target IDs for targets that previously matched this document. */ - removedTargetIds?: number[]; + removedTargetIds?: number[] | null; } /** * A target specified by a set of documents names. @@ -343,7 +343,7 @@ export namespace firestore_v1 { /** * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ - documents?: string[]; + documents?: string[] | null; } /** * A transformation of a document. @@ -352,7 +352,7 @@ export namespace firestore_v1 { /** * The name of the document to transform. */ - document?: string; + document?: string | null; /** * The list of transformations to apply to the fields of the document, in order. This must not be empty. */ @@ -369,11 +369,11 @@ export namespace firestore_v1 { /** * The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target. */ - count?: number; + count?: number | null; /** * The target ID to which this filter applies. */ - targetId?: number; + targetId?: number | null; } /** * A filter on a specific field. @@ -386,7 +386,7 @@ export namespace firestore_v1 { /** * The operator to filter by. */ - op?: string; + op?: string | null; /** * The value to compare to. */ @@ -396,7 +396,7 @@ export namespace firestore_v1 { * A reference to a field, such as `max(messages.time) as max_time`. */ export interface Schema$FieldReference { - fieldPath?: string; + fieldPath?: string | null; } /** * A transformation of a field of the document. @@ -409,7 +409,7 @@ export namespace firestore_v1 { /** * The path of the field. See Document.fields for the field path syntax reference. */ - fieldPath?: string; + fieldPath?: string | null; /** * Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. */ @@ -429,7 +429,7 @@ export namespace firestore_v1 { /** * Sets the field to the given server value. */ - setToServerValue?: string; + setToServerValue?: string | null; } /** * A filter. @@ -455,19 +455,19 @@ export namespace firestore_v1 { /** * Which collection ids are being exported. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The state of the export operation. */ - operationState?: string; + operationState?: string | null; /** * Where the entities are being exported to. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; /** * The progress, in bytes, of this operation. */ @@ -479,7 +479,7 @@ export namespace firestore_v1 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; } /** * The request for FirestoreAdmin.ExportDocuments. @@ -488,11 +488,11 @@ export namespace firestore_v1 { /** * Which collection ids to export. Unspecified means all collections. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; } /** * Returned in the google.longrunning.Operation response field. @@ -501,7 +501,7 @@ export namespace firestore_v1 { /** * Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; } /** * Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id. @@ -514,7 +514,7 @@ export namespace firestore_v1 { /** * A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */ - name?: string; + name?: string | null; } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField. @@ -523,11 +523,11 @@ export namespace firestore_v1 { /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` */ - field?: string; + field?: string | null; /** * A list of IndexConfigDelta, which describe the intent of this operation. */ @@ -543,11 +543,11 @@ export namespace firestore_v1 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; /** * The state of the operation. */ - state?: string; + state?: string | null; } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. @@ -556,19 +556,19 @@ export namespace firestore_v1 { /** * Which collection ids are being imported. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The location of the documents being imported. */ - inputUriPrefix?: string; + inputUriPrefix?: string | null; /** * The state of the import operation. */ - operationState?: string; + operationState?: string | null; /** * The progress, in bytes, of this operation. */ @@ -580,7 +580,7 @@ export namespace firestore_v1 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; } /** * The request for FirestoreAdmin.ImportDocuments. @@ -589,11 +589,11 @@ export namespace firestore_v1 { /** * Which collection ids to import. Unspecified means all collections included in the import. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. */ - inputUriPrefix?: string; + inputUriPrefix?: string | null; } /** * Cloud Firestore indexes enable simple and complex queries against documents in a database. @@ -606,15 +606,15 @@ export namespace firestore_v1 { /** * Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. */ - name?: string; + name?: string | null; /** * Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. */ - queryScope?: string; + queryScope?: string | null; /** * Output only. The serving state of the index. */ - state?: string; + state?: string | null; } /** * The index configuration for this field. @@ -623,7 +623,7 @@ export namespace firestore_v1 { /** * Output only. Specifies the resource name of the `Field` from which this field's index configuration is set (when `uses_ancestor_config` is true), or from which it *would* be set if this field had no index configuration (when `uses_ancestor_config` is false). */ - ancestorField?: string; + ancestorField?: string | null; /** * The indexes supported for this field. */ @@ -631,11 +631,11 @@ export namespace firestore_v1 { /** * Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`. */ - reverting?: boolean; + reverting?: boolean | null; /** * Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. */ - usesAncestorConfig?: boolean; + usesAncestorConfig?: boolean | null; } /** * Information about an index configuration change. @@ -644,7 +644,7 @@ export namespace firestore_v1 { /** * Specifies how the index is changing. */ - changeType?: string; + changeType?: string | null; /** * The index being changed. */ @@ -657,15 +657,15 @@ export namespace firestore_v1 { /** * Indicates that this field supports operations on `array_value`s. */ - arrayConfig?: string; + arrayConfig?: string | null; /** * Can be __name__. For single field indexes, this must match the name of the field or may be omitted. */ - fieldPath?: string; + fieldPath?: string | null; /** * Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. */ - order?: string; + order?: string | null; } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. @@ -674,11 +674,11 @@ export namespace firestore_v1 { /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ - index?: string; + index?: string | null; /** * The progress, in bytes, of this operation. */ @@ -690,11 +690,11 @@ export namespace firestore_v1 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; /** * The state of the operation. */ - state?: string; + state?: string | null; } /** * The response for FirestoreAdmin.ListFields. @@ -707,7 +707,7 @@ export namespace firestore_v1 { /** * A page token that may be used to request another page of results. If blank, this is the last page. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for FirestoreAdmin.ListIndexes. @@ -720,7 +720,7 @@ export namespace firestore_v1 { /** * A page token that may be used to request another page of results. If blank, this is the last page. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The metadata message for google.cloud.location.Location.metadata. @@ -733,11 +733,11 @@ export namespace firestore_v1 { /** * The amount of work completed. */ - completedWork?: string; + completedWork?: string | null; /** * The amount of work estimated. */ - estimatedWork?: string; + estimatedWork?: string | null; } /** * The request message for Operations.CancelOperation. @@ -750,7 +750,7 @@ export namespace firestore_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -763,7 +763,7 @@ export namespace firestore_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -771,15 +771,15 @@ export namespace firestore_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -788,11 +788,11 @@ export namespace firestore_v1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * The request for Firestore.ListCollectionIds. @@ -801,11 +801,11 @@ export namespace firestore_v1 { /** * The maximum number of results to return. */ - pageSize?: number; + pageSize?: number | null; /** * A page token. Must be a value from ListCollectionIdsResponse. */ - pageToken?: string; + pageToken?: string | null; } /** * The response from Firestore.ListCollectionIds. @@ -814,11 +814,11 @@ export namespace firestore_v1 { /** * The collection ids. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * A page token that may be used to continue the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for Firestore.ListDocuments. @@ -831,7 +831,7 @@ export namespace firestore_v1 { /** * The next page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A request for Firestore.Listen @@ -844,11 +844,11 @@ export namespace firestore_v1 { /** * Labels associated with this target change. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The ID of a target to remove from this stream. */ - removeTarget?: number; + removeTarget?: number | null; } /** * The response for Firestore.Listen. @@ -886,7 +886,7 @@ export namespace firestore_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -895,23 +895,23 @@ export namespace firestore_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * A map value. @@ -920,7 +920,7 @@ export namespace firestore_v1 { /** * The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. */ - fields?: {[key: string]: Schema$Value}; + fields?: {[key: string]: Schema$Value} | null; } /** * An order on a field. @@ -929,7 +929,7 @@ export namespace firestore_v1 { /** * The direction to order by. Defaults to `ASCENDING`. */ - direction?: string; + direction?: string | null; /** * The field to order by. */ @@ -942,11 +942,11 @@ export namespace firestore_v1 { /** * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ - exists?: boolean; + exists?: boolean | null; /** * When set, the target document must exist and have been last updated at that time. */ - updateTime?: string; + updateTime?: string | null; } /** * The projection of document's fields to return. @@ -964,7 +964,7 @@ export namespace firestore_v1 { /** * 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; + parent?: string | null; /** * A structured query. */ @@ -977,7 +977,7 @@ export namespace firestore_v1 { /** * Reads documents at the given time. This may not be older than 60 seconds. */ - readTime?: string; + readTime?: string | null; } /** * Options for a transaction that can be used to read and write documents. @@ -986,7 +986,7 @@ export namespace firestore_v1 { /** * An optional transaction to retry. */ - retryTransaction?: string; + retryTransaction?: string | null; } /** * The request for Firestore.Rollback. @@ -995,7 +995,7 @@ export namespace firestore_v1 { /** * The transaction to roll back. */ - transaction?: string; + transaction?: string | null; } /** * The request for Firestore.RunQuery. @@ -1008,7 +1008,7 @@ export namespace firestore_v1 { /** * Reads documents as they were at the given time. This may not be older than 60 seconds. */ - readTime?: string; + readTime?: string | null; /** * A structured query. */ @@ -1016,7 +1016,7 @@ export namespace firestore_v1 { /** * Reads documents in a transaction. */ - transaction?: string; + transaction?: string | null; } /** * The response for Firestore.RunQuery. @@ -1029,15 +1029,15 @@ export namespace firestore_v1 { /** * The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run. */ - readTime?: string; + readTime?: string | null; /** * The number of results that have been skipped due to an offset between the last response and the current response. */ - skippedResults?: number; + skippedResults?: number | null; /** * The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response. */ - transaction?: string; + transaction?: 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). @@ -1046,15 +1046,15 @@ export namespace firestore_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A Firestore query. @@ -1071,11 +1071,11 @@ export namespace firestore_v1 { /** * The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified. */ - limit?: number; + limit?: number | null; /** * The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified. */ - offset?: number; + offset?: number | null; /** * The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` */ @@ -1104,7 +1104,7 @@ export namespace firestore_v1 { /** * If the target should be removed once it is current and consistent. */ - once?: boolean; + once?: boolean | null; /** * A target specified by a query. */ @@ -1112,15 +1112,15 @@ export namespace firestore_v1 { /** * Start listening after a specific `read_time`. The client must know the state of matching documents at this time. */ - readTime?: string; + readTime?: string | null; /** * A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail. */ - resumeToken?: string; + resumeToken?: string | null; /** * The target ID that identifies the target on the stream. Must be a positive number and non-zero. */ - targetId?: number; + targetId?: number | null; } /** * Targets being watched have changed. @@ -1133,19 +1133,19 @@ export namespace firestore_v1 { /** * The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a `read_time` with `target_ids` empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` is guaranteed to be monotonically increasing. */ - readTime?: string; + readTime?: string | null; /** * A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change. */ - resumeToken?: string; + resumeToken?: string | null; /** * The type of change that occurred. */ - targetChangeType?: string; + targetChangeType?: string | null; /** * The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined. */ - targetIds?: number[]; + targetIds?: number[] | null; } /** * Options for creating a new transaction. @@ -1171,7 +1171,7 @@ export namespace firestore_v1 { /** * The unary operator to apply. */ - op?: string; + op?: string | null; } /** * A message that can hold any of the supported value types. @@ -1184,15 +1184,15 @@ export namespace firestore_v1 { /** * A boolean value. */ - booleanValue?: boolean; + booleanValue?: boolean | null; /** * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. */ - bytesValue?: string; + bytesValue?: string | null; /** * A double value. */ - doubleValue?: number; + doubleValue?: number | null; /** * A geo point value representing a point on the surface of Earth. */ @@ -1200,7 +1200,7 @@ export namespace firestore_v1 { /** * An integer value. */ - integerValue?: string; + integerValue?: string | null; /** * A map value. */ @@ -1208,19 +1208,19 @@ export namespace firestore_v1 { /** * A null value. */ - nullValue?: string; + nullValue?: string | null; /** * A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - referenceValue?: string; + referenceValue?: string | null; /** * A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. */ - stringValue?: string; + stringValue?: string | null; /** * A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. */ - timestampValue?: string; + timestampValue?: string | null; } /** * A write on a document. @@ -1233,7 +1233,7 @@ export namespace firestore_v1 { /** * A document name to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - delete?: string; + delete?: string | null; /** * Applies a transformation to a document. At most one `transform` per document is allowed in a given request. An `update` cannot follow a `transform` on the same document in a given request. */ @@ -1254,15 +1254,15 @@ export namespace firestore_v1 { /** * Labels associated with this write request. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */ - streamId?: string; + streamId?: string | null; /** * A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. */ - streamToken?: string; + streamToken?: string | null; /** * The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. */ @@ -1275,15 +1275,15 @@ export namespace firestore_v1 { /** * The time at which the commit occurred. */ - commitTime?: string; + commitTime?: string | null; /** * The ID of the stream. Only set on the first message, when a new stream was created. */ - streamId?: string; + streamId?: string | null; /** * A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set. */ - streamToken?: string; + streamToken?: string | null; /** * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ @@ -1300,7 +1300,7 @@ export namespace firestore_v1 { /** * The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. */ - updateTime?: string; + updateTime?: string | null; } export class Resource$Projects { diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 72c82a7a6c1..f36373c3208 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -133,7 +133,7 @@ export namespace firestore_v1beta1 { /** * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ - documents?: string[]; + documents?: string[] | null; /** * The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. */ @@ -145,11 +145,11 @@ export namespace firestore_v1beta1 { /** * Reads documents as they were at the given time. This may not be older than 60 seconds. */ - readTime?: string; + readTime?: string | null; /** * Reads documents in a transaction. */ - transaction?: string; + transaction?: string | null; } /** * The streamed response for Firestore.BatchGetDocuments. @@ -162,15 +162,15 @@ export namespace firestore_v1beta1 { /** * A document name that was requested but does not exist. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - missing?: string; + missing?: string | null; /** * The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. */ - readTime?: string; + readTime?: string | null; /** * The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request. */ - transaction?: string; + transaction?: string | null; } /** * The request for Firestore.BeginTransaction. @@ -188,7 +188,7 @@ export namespace firestore_v1beta1 { /** * The transaction that was started. */ - transaction?: string; + transaction?: string | null; } /** * A selection of a collection, such as `messages as m1`. @@ -197,11 +197,11 @@ export namespace firestore_v1beta1 { /** * When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections. */ - allDescendants?: boolean; + allDescendants?: boolean | null; /** * The collection ID. When set, selects only collections with this ID. */ - collectionId?: string; + collectionId?: string | null; } /** * The request for Firestore.Commit. @@ -210,7 +210,7 @@ export namespace firestore_v1beta1 { /** * If set, applies all writes in this transaction, and commits it. */ - transaction?: string; + transaction?: string | null; /** * The writes to apply. Always executed atomically and in order. */ @@ -223,7 +223,7 @@ export namespace firestore_v1beta1 { /** * The time at which the commit occurred. */ - commitTime?: string; + commitTime?: string | null; /** * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ @@ -240,7 +240,7 @@ export namespace firestore_v1beta1 { /** * The operator for combining multiple filters. */ - op?: string; + op?: string | null; } /** * A position in a query result set. @@ -249,7 +249,7 @@ export namespace firestore_v1beta1 { /** * If the position is just before or just after the given values, relative to the sort order defined by the query. */ - before?: boolean; + before?: boolean | null; /** * The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. */ @@ -262,19 +262,19 @@ export namespace firestore_v1beta1 { /** * Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. */ - createTime?: string; + createTime?: string | null; /** * The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. */ - fields?: {[key: string]: Schema$Value}; + fields?: {[key: string]: Schema$Value} | null; /** * The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - name?: string; + name?: string | null; /** * Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. */ - updateTime?: string; + updateTime?: string | null; } /** * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. @@ -287,11 +287,11 @@ export namespace firestore_v1beta1 { /** * A set of target IDs for targets that no longer match this document. */ - removedTargetIds?: number[]; + removedTargetIds?: number[] | null; /** * A set of target IDs of targets that match this document. */ - targetIds?: number[]; + targetIds?: number[] | null; } /** * A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected. @@ -300,15 +300,15 @@ export namespace firestore_v1beta1 { /** * The resource name of the Document that was deleted. */ - document?: string; + document?: string | null; /** * The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete. */ - readTime?: string; + readTime?: string | null; /** * A set of target IDs for targets that previously matched this entity. */ - removedTargetIds?: number[]; + removedTargetIds?: number[] | null; } /** * A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value. @@ -317,7 +317,7 @@ export namespace firestore_v1beta1 { /** * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ - fieldPaths?: string[]; + fieldPaths?: string[] | null; } /** * A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected. @@ -326,15 +326,15 @@ export namespace firestore_v1beta1 { /** * The resource name of the Document that has gone out of view. */ - document?: string; + document?: string | null; /** * The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove. */ - readTime?: string; + readTime?: string | null; /** * A set of target IDs for targets that previously matched this document. */ - removedTargetIds?: number[]; + removedTargetIds?: number[] | null; } /** * A target specified by a set of documents names. @@ -343,7 +343,7 @@ export namespace firestore_v1beta1 { /** * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ - documents?: string[]; + documents?: string[] | null; } /** * A transformation of a document. @@ -352,7 +352,7 @@ export namespace firestore_v1beta1 { /** * The name of the document to transform. */ - document?: string; + document?: string | null; /** * The list of transformations to apply to the fields of the document, in order. This must not be empty. */ @@ -369,11 +369,11 @@ export namespace firestore_v1beta1 { /** * The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target. */ - count?: number; + count?: number | null; /** * The target ID to which this filter applies. */ - targetId?: number; + targetId?: number | null; } /** * A filter on a specific field. @@ -386,7 +386,7 @@ export namespace firestore_v1beta1 { /** * The operator to filter by. */ - op?: string; + op?: string | null; /** * The value to compare to. */ @@ -396,7 +396,7 @@ export namespace firestore_v1beta1 { * A reference to a field, such as `max(messages.time) as max_time`. */ export interface Schema$FieldReference { - fieldPath?: string; + fieldPath?: string | null; } /** * A transformation of a field of the document. @@ -409,7 +409,7 @@ export namespace firestore_v1beta1 { /** * The path of the field. See Document.fields for the field path syntax reference. */ - fieldPath?: string; + fieldPath?: string | null; /** * Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. */ @@ -429,7 +429,7 @@ export namespace firestore_v1beta1 { /** * Sets the field to the given server value. */ - setToServerValue?: string; + setToServerValue?: string | null; } /** * A filter. @@ -455,19 +455,19 @@ export namespace firestore_v1beta1 { /** * Which collection ids are being exported. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The time the operation ended, either successfully or otherwise. Unset if the operation is still active. */ - endTime?: string; + endTime?: string | null; /** * The state of the export operation. */ - operationState?: string; + operationState?: string | null; /** * Where the entities are being exported to. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; /** * An estimate of the number of bytes processed. */ @@ -479,7 +479,7 @@ export namespace firestore_v1beta1 { /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; } /** * The request for FirestoreAdmin.ExportDocuments. @@ -488,11 +488,11 @@ export namespace firestore_v1beta1 { /** * Which collection ids to export. Unspecified means all collections. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; } /** * Returned in the google.longrunning.Operation response field. @@ -501,7 +501,7 @@ export namespace firestore_v1beta1 { /** * Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; } /** * Metadata for ImportDocuments operations. @@ -510,19 +510,19 @@ export namespace firestore_v1beta1 { /** * Which collection ids are being imported. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The time the operation ended, either successfully or otherwise. Unset if the operation is still active. */ - endTime?: string; + endTime?: string | null; /** * The location of the documents being imported. */ - inputUriPrefix?: string; + inputUriPrefix?: string | null; /** * The state of the import operation. */ - operationState?: string; + operationState?: string | null; /** * An estimate of the number of bytes processed. */ @@ -534,7 +534,7 @@ export namespace firestore_v1beta1 { /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; } /** * The request for FirestoreAdmin.ImportDocuments. @@ -543,11 +543,11 @@ export namespace firestore_v1beta1 { /** * Which collection ids to import. Unspecified means all collections included in the import. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix. */ - inputUriPrefix?: string; + inputUriPrefix?: string | null; } /** * An index definition. @@ -556,7 +556,7 @@ export namespace firestore_v1beta1 { /** * The collection ID to which this index applies. Required. */ - collectionId?: string; + collectionId?: string | null; /** * The fields to index. */ @@ -564,11 +564,11 @@ export namespace firestore_v1beta1 { /** * The resource name of the index. Output only. */ - name?: string; + name?: string | null; /** * The state of the index. Output only. */ - state?: string; + state?: string | null; } /** * A field of an index. @@ -577,11 +577,11 @@ export namespace firestore_v1beta1 { /** * The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path. */ - fieldPath?: string; + fieldPath?: string | null; /** * The field's mode. */ - mode?: string; + mode?: string | null; } /** * Metadata for index operations. This metadata populates the metadata field of google.longrunning.Operation. @@ -590,7 +590,7 @@ export namespace firestore_v1beta1 { /** * True if the [google.longrunning.Operation] was cancelled. If the cancellation is in progress, cancelled will be true but google.longrunning.Operation.done will be false. */ - cancelled?: boolean; + cancelled?: boolean | null; /** * Progress of the existing operation, measured in number of documents. */ @@ -598,19 +598,19 @@ export namespace firestore_v1beta1 { /** * The time the operation ended, either successfully or otherwise. Unset if the operation is still active. */ - endTime?: string; + endTime?: string | null; /** * The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}` */ - index?: string; + index?: string | null; /** * The type of index operation. */ - operationType?: string; + operationType?: string | null; /** * The time that work began on the operation. */ - startTime?: string; + startTime?: string | null; } /** * The response for FirestoreAdmin.ListIndexes. @@ -623,7 +623,7 @@ export namespace firestore_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The metadata message for google.cloud.location.Location.metadata. @@ -636,11 +636,11 @@ export namespace firestore_v1beta1 { /** * An estimate of how much work has been completed. Note that this may be greater than `work_estimated`. */ - workCompleted?: string; + workCompleted?: string | null; /** * An estimate of how much work needs to be performed. Zero if the work estimate is unavailable. May change as work progresses. */ - workEstimated?: string; + workEstimated?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -649,7 +649,7 @@ export namespace firestore_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -657,15 +657,15 @@ export namespace firestore_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -674,11 +674,11 @@ export namespace firestore_v1beta1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * The request for Firestore.ListCollectionIds. @@ -687,11 +687,11 @@ export namespace firestore_v1beta1 { /** * The maximum number of results to return. */ - pageSize?: number; + pageSize?: number | null; /** * A page token. Must be a value from ListCollectionIdsResponse. */ - pageToken?: string; + pageToken?: string | null; } /** * The response from Firestore.ListCollectionIds. @@ -700,11 +700,11 @@ export namespace firestore_v1beta1 { /** * The collection ids. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * A page token that may be used to continue the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for Firestore.ListDocuments. @@ -717,7 +717,7 @@ export namespace firestore_v1beta1 { /** * The next page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A request for Firestore.Listen @@ -730,11 +730,11 @@ export namespace firestore_v1beta1 { /** * Labels associated with this target change. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The ID of a target to remove from this stream. */ - removeTarget?: number; + removeTarget?: number | null; } /** * The response for Firestore.Listen. @@ -768,7 +768,7 @@ export namespace firestore_v1beta1 { /** * The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. */ - fields?: {[key: string]: Schema$Value}; + fields?: {[key: string]: Schema$Value} | null; } /** * An order on a field. @@ -777,7 +777,7 @@ export namespace firestore_v1beta1 { /** * The direction to order by. Defaults to `ASCENDING`. */ - direction?: string; + direction?: string | null; /** * The field to order by. */ @@ -790,11 +790,11 @@ export namespace firestore_v1beta1 { /** * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ - exists?: boolean; + exists?: boolean | null; /** * When set, the target document must exist and have been last updated at that time. */ - updateTime?: string; + updateTime?: string | null; } /** * The projection of document's fields to return. @@ -812,7 +812,7 @@ export namespace firestore_v1beta1 { /** * 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; + parent?: string | null; /** * A structured query. */ @@ -825,7 +825,7 @@ export namespace firestore_v1beta1 { /** * Reads documents at the given time. This may not be older than 60 seconds. */ - readTime?: string; + readTime?: string | null; } /** * Options for a transaction that can be used to read and write documents. @@ -834,7 +834,7 @@ export namespace firestore_v1beta1 { /** * An optional transaction to retry. */ - retryTransaction?: string; + retryTransaction?: string | null; } /** * The request for Firestore.Rollback. @@ -843,7 +843,7 @@ export namespace firestore_v1beta1 { /** * The transaction to roll back. */ - transaction?: string; + transaction?: string | null; } /** * The request for Firestore.RunQuery. @@ -856,7 +856,7 @@ export namespace firestore_v1beta1 { /** * Reads documents as they were at the given time. This may not be older than 60 seconds. */ - readTime?: string; + readTime?: string | null; /** * A structured query. */ @@ -864,7 +864,7 @@ export namespace firestore_v1beta1 { /** * Reads documents in a transaction. */ - transaction?: string; + transaction?: string | null; } /** * The response for Firestore.RunQuery. @@ -877,15 +877,15 @@ export namespace firestore_v1beta1 { /** * The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run. */ - readTime?: string; + readTime?: string | null; /** * The number of results that have been skipped due to an offset between the last response and the current response. */ - skippedResults?: number; + skippedResults?: number | null; /** * The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response. */ - transaction?: string; + transaction?: 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). @@ -894,15 +894,15 @@ export namespace firestore_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A Firestore query. @@ -919,11 +919,11 @@ export namespace firestore_v1beta1 { /** * The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified. */ - limit?: number; + limit?: number | null; /** * The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified. */ - offset?: number; + offset?: number | null; /** * The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` */ @@ -952,7 +952,7 @@ export namespace firestore_v1beta1 { /** * If the target should be removed once it is current and consistent. */ - once?: boolean; + once?: boolean | null; /** * A target specified by a query. */ @@ -960,15 +960,15 @@ export namespace firestore_v1beta1 { /** * Start listening after a specific `read_time`. The client must know the state of matching documents at this time. */ - readTime?: string; + readTime?: string | null; /** * A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail. */ - resumeToken?: string; + resumeToken?: string | null; /** * The target ID that identifies the target on the stream. Must be a positive number and non-zero. */ - targetId?: number; + targetId?: number | null; } /** * Targets being watched have changed. @@ -981,19 +981,19 @@ export namespace firestore_v1beta1 { /** * The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a `read_time` with `target_ids` empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` is guaranteed to be monotonically increasing. */ - readTime?: string; + readTime?: string | null; /** * A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change. */ - resumeToken?: string; + resumeToken?: string | null; /** * The type of change that occurred. */ - targetChangeType?: string; + targetChangeType?: string | null; /** * The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined. */ - targetIds?: number[]; + targetIds?: number[] | null; } /** * Options for creating a new transaction. @@ -1019,7 +1019,7 @@ export namespace firestore_v1beta1 { /** * The unary operator to apply. */ - op?: string; + op?: string | null; } /** * A message that can hold any of the supported value types. @@ -1032,15 +1032,15 @@ export namespace firestore_v1beta1 { /** * A boolean value. */ - booleanValue?: boolean; + booleanValue?: boolean | null; /** * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. */ - bytesValue?: string; + bytesValue?: string | null; /** * A double value. */ - doubleValue?: number; + doubleValue?: number | null; /** * A geo point value representing a point on the surface of Earth. */ @@ -1048,7 +1048,7 @@ export namespace firestore_v1beta1 { /** * An integer value. */ - integerValue?: string; + integerValue?: string | null; /** * A map value. */ @@ -1056,19 +1056,19 @@ export namespace firestore_v1beta1 { /** * A null value. */ - nullValue?: string; + nullValue?: string | null; /** * A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - referenceValue?: string; + referenceValue?: string | null; /** * A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. */ - stringValue?: string; + stringValue?: string | null; /** * A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. */ - timestampValue?: string; + timestampValue?: string | null; } /** * A write on a document. @@ -1081,7 +1081,7 @@ export namespace firestore_v1beta1 { /** * A document name to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ - delete?: string; + delete?: string | null; /** * Applies a transformation to a document. At most one `transform` per document is allowed in a given request. An `update` cannot follow a `transform` on the same document in a given request. */ @@ -1102,15 +1102,15 @@ export namespace firestore_v1beta1 { /** * Labels associated with this write request. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */ - streamId?: string; + streamId?: string | null; /** * A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. */ - streamToken?: string; + streamToken?: string | null; /** * The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. */ @@ -1123,15 +1123,15 @@ export namespace firestore_v1beta1 { /** * The time at which the commit occurred. */ - commitTime?: string; + commitTime?: string | null; /** * The ID of the stream. Only set on the first message, when a new stream was created. */ - streamId?: string; + streamId?: string | null; /** * A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set. */ - streamToken?: string; + streamToken?: string | null; /** * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ @@ -1148,7 +1148,7 @@ export namespace firestore_v1beta1 { /** * The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. */ - updateTime?: string; + updateTime?: string | null; } export class Resource$Projects { diff --git a/src/apis/firestore/v1beta2.ts b/src/apis/firestore/v1beta2.ts index a1cf54da0b9..dcdc2384755 100644 --- a/src/apis/firestore/v1beta2.ts +++ b/src/apis/firestore/v1beta2.ts @@ -128,19 +128,19 @@ export namespace firestore_v1beta2 { /** * Which collection ids are being exported. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The state of the export operation. */ - operationState?: string; + operationState?: string | null; /** * Where the entities are being exported to. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; /** * The progress, in bytes, of this operation. */ @@ -152,7 +152,7 @@ export namespace firestore_v1beta2 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; } /** * The request for FirestoreAdmin.ExportDocuments. @@ -161,11 +161,11 @@ export namespace firestore_v1beta2 { /** * Which collection ids to export. Unspecified means all collections. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; } /** * Returned in the google.longrunning.Operation response field. @@ -174,7 +174,7 @@ export namespace firestore_v1beta2 { /** * Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; } /** * Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id. @@ -187,7 +187,7 @@ export namespace firestore_v1beta2 { /** * A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */ - name?: string; + name?: string | null; } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField. @@ -204,11 +204,11 @@ export namespace firestore_v1beta2 { /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` */ - field?: string; + field?: string | null; /** * A list of IndexConfigDelta, which describe the intent of this operation. */ @@ -216,11 +216,11 @@ export namespace firestore_v1beta2 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; /** * The state of the operation. */ - state?: string; + state?: string | null; } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. @@ -229,19 +229,19 @@ export namespace firestore_v1beta2 { /** * Which collection ids are being imported. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The location of the documents being imported. */ - inputUriPrefix?: string; + inputUriPrefix?: string | null; /** * The state of the import operation. */ - operationState?: string; + operationState?: string | null; /** * The progress, in bytes, of this operation. */ @@ -253,7 +253,7 @@ export namespace firestore_v1beta2 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; } /** * The request for FirestoreAdmin.ImportDocuments. @@ -262,11 +262,11 @@ export namespace firestore_v1beta2 { /** * Which collection ids to import. Unspecified means all collections included in the import. */ - collectionIds?: string[]; + collectionIds?: string[] | null; /** * Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix. */ - inputUriPrefix?: string; + inputUriPrefix?: string | null; } /** * Cloud Firestore indexes enable simple and complex queries against documents in a database. @@ -279,15 +279,15 @@ export namespace firestore_v1beta2 { /** * Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. */ - name?: string; + name?: string | null; /** * Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. */ - queryScope?: string; + queryScope?: string | null; /** * Output only. The serving state of the index. */ - state?: string; + state?: string | null; } /** * The index configuration for this field. @@ -296,7 +296,7 @@ export namespace firestore_v1beta2 { /** * Output only. Specifies the resource name of the `Field` from which this field's index configuration is set (when `uses_ancestor_config` is true), or from which it *would* be set if this field had no index configuration (when `uses_ancestor_config` is false). */ - ancestorField?: string; + ancestorField?: string | null; /** * The indexes supported for this field. */ @@ -304,11 +304,11 @@ export namespace firestore_v1beta2 { /** * Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`. */ - reverting?: boolean; + reverting?: boolean | null; /** * Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. */ - usesAncestorConfig?: boolean; + usesAncestorConfig?: boolean | null; } /** * Information about an index configuration change. @@ -317,7 +317,7 @@ export namespace firestore_v1beta2 { /** * Specifies how the index is changing. */ - changeType?: string; + changeType?: string | null; /** * The index being changed. */ @@ -330,15 +330,15 @@ export namespace firestore_v1beta2 { /** * Indicates that this field supports operations on `array_value`s. */ - arrayConfig?: string; + arrayConfig?: string | null; /** * Can be __name__. For single field indexes, this must match the name of the field or may be omitted. */ - fieldPath?: string; + fieldPath?: string | null; /** * Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. */ - order?: string; + order?: string | null; } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. @@ -347,11 +347,11 @@ export namespace firestore_v1beta2 { /** * The time this operation completed. Will be unset if operation still in progress. */ - endTime?: string; + endTime?: string | null; /** * The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ - index?: string; + index?: string | null; /** * The progress, in bytes, of this operation. */ @@ -363,11 +363,11 @@ export namespace firestore_v1beta2 { /** * The time this operation started. */ - startTime?: string; + startTime?: string | null; /** * The state of the operation. */ - state?: string; + state?: string | null; } /** * The response for FirestoreAdmin.ListFields. @@ -380,7 +380,7 @@ export namespace firestore_v1beta2 { /** * A page token that may be used to request another page of results. If blank, this is the last page. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for FirestoreAdmin.ListIndexes. @@ -393,7 +393,7 @@ export namespace firestore_v1beta2 { /** * A page token that may be used to request another page of results. If blank, this is the last page. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used. @@ -402,11 +402,11 @@ export namespace firestore_v1beta2 { /** * The amount of work completed. */ - completedWork?: string; + completedWork?: string | null; /** * The amount of work estimated. */ - estimatedWork?: string; + estimatedWork?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -415,7 +415,7 @@ export namespace firestore_v1beta2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -423,15 +423,15 @@ export namespace firestore_v1beta2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -440,15 +440,15 @@ export namespace firestore_v1beta2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index 295a8f5b9e8..4695005e667 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -105,7 +105,7 @@ export namespace fitness_v1 { /** * Available for Bucket.Type.ACTIVITY_TYPE, Bucket.Type.ACTIVITY_SEGMENT */ - activity?: number; + activity?: number | null; /** * There will be one dataset per AggregateBy in the request. */ @@ -113,7 +113,7 @@ export namespace fitness_v1 { /** * The end time for the aggregated data, in milliseconds since epoch, inclusive. */ - endTimeMillis?: string; + endTimeMillis?: string | null; /** * Available for Bucket.Type.SESSION */ @@ -121,11 +121,11 @@ export namespace fitness_v1 { /** * The start time for the aggregated data, in milliseconds since epoch, inclusive. */ - startTimeMillis?: string; + startTimeMillis?: string | null; /** * The type of a bucket signifies how the data aggregation is performed in the bucket. */ - type?: string; + type?: string | null; } /** * The specification of which data to aggregate. @@ -134,11 +134,11 @@ export namespace fitness_v1 { /** * A data source ID to aggregate. Mutually exclusive of dataTypeName. Only data from the specified data source ID will be included in the aggregation. The dataset in the response will have the same data source ID. */ - dataSourceId?: string; + dataSourceId?: string | null; /** * The data type to aggregate. All data sources providing this data type will contribute data to the aggregation. The response will contain a single dataset for this data type name. The dataset will have a data source ID of derived:com.google.:com.google.android.gms:aggregated */ - dataTypeName?: string; + dataTypeName?: string | null; } /** * Next id: 10 @@ -167,15 +167,15 @@ export namespace fitness_v1 { /** * The end of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive. */ - endTimeMillis?: string; + endTimeMillis?: string | null; /** * DO NOT POPULATE THIS FIELD. It is ignored. */ - filteredDataQualityStandard?: string[]; + filteredDataQualityStandard?: string[] | null; /** * The start of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive. */ - startTimeMillis?: string; + startTimeMillis?: string | null; } export interface Schema$AggregateResponse { /** @@ -187,50 +187,50 @@ export namespace fitness_v1 { /** * An optional URI that can be used to link back to the application. */ - detailsUrl?: string; + detailsUrl?: string | null; /** * The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source. */ - name?: string; + name?: string | null; /** * Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName. */ - packageName?: string; + packageName?: string | null; /** * Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data. */ - version?: string; + version?: string | null; } export interface Schema$BucketByActivity { /** * The default activity stream will be used if a specific activityDataSourceId is not specified. */ - activityDataSourceId?: string; + activityDataSourceId?: string | null; /** * Specifies that only activity segments of duration longer than minDurationMillis are considered and used as a container for aggregated data. */ - minDurationMillis?: string; + minDurationMillis?: string | null; } export interface Schema$BucketBySession { /** * Specifies that only sessions of duration longer than minDurationMillis are considered and used as a container for aggregated data. */ - minDurationMillis?: string; + minDurationMillis?: string | null; } export interface Schema$BucketByTime { /** * Specifies that result buckets aggregate data by exactly durationMillis time frames. Time frames that contain no data will be included in the response with an empty dataset. */ - durationMillis?: string; + durationMillis?: string | null; period?: Schema$BucketByTimePeriod; } export interface Schema$BucketByTimePeriod { /** * org.joda.timezone.DateTimeZone */ - timeZoneId?: string; - type?: string; - value?: number; + timeZoneId?: string | null; + type?: string | null; + value?: number | null; } /** * Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type. A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type. Data points always contain one value for each field of the data type. @@ -239,31 +239,31 @@ export namespace fitness_v1 { /** * DO NOT USE THIS FIELD. It is ignored, and not stored. */ - computationTimeMillis?: string; + computationTimeMillis?: string | null; /** * The data type defining the format of the values in this data point. */ - dataTypeName?: string; + dataTypeName?: string | null; /** * The end time of the interval represented by this data point, in nanoseconds since epoch. */ - endTimeNanos?: string; + endTimeNanos?: string | null; /** * Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data. */ - modifiedTimeMillis?: string; + modifiedTimeMillis?: string | null; /** * If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally. WARNING: do not rely on this field for anything other than debugging. The value of this field, if it is set at all, is an implementation detail and is not guaranteed to remain consistent. */ - originDataSourceId?: string; + originDataSourceId?: string | null; /** * The raw timestamp from the original SensorEvent. */ - rawTimestampNanos?: string; + rawTimestampNanos?: string | null; /** * The start time of the interval represented by this data point, in nanoseconds since epoch. */ - startTimeNanos?: string; + startTimeNanos?: string | null; /** * Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source. Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field. */ @@ -276,19 +276,19 @@ export namespace fitness_v1 { /** * The data stream ID of the data source that created the points in this dataset. */ - dataSourceId?: string; + dataSourceId?: string | null; /** * The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the second part of the dataset identifier. */ - maxEndTimeNs?: string; + maxEndTimeNs?: string | null; /** * The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier. */ - minStartTimeNs?: string; + minStartTimeNs?: string | null; /** * This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response. */ @@ -305,15 +305,15 @@ export namespace fitness_v1 { /** * DO NOT POPULATE THIS FIELD. It is never populated in responses from the platform, and is ignored in queries. It will be removed in a future version entirely. */ - dataQualityStandard?: string[]; + dataQualityStandard?: string[] | null; /** * A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName When any of the optional fields that make up the data stream ID are absent, they will be omitted from the data stream ID. The minimum viable data stream ID would be: type:dataType.name:developer project number Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. */ - dataStreamId?: string; + dataStreamId?: string | null; /** * The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors. */ - dataStreamName?: string; + dataStreamName?: string | null; /** * The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API. */ @@ -325,11 +325,11 @@ export namespace fitness_v1 { /** * An end-user visible name for this data source. */ - name?: string; + name?: string | null; /** * A constant describing the type of this data source. Indicates whether this data source produces raw or derived data. */ - type?: string; + type?: string | null; } export interface Schema$DataType { /** @@ -339,7 +339,7 @@ export namespace fitness_v1 { /** * Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform. */ - name?: string; + name?: string | null; } /** * In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.). This message is only instantiated in code and not used for wire comms or stored in any way. @@ -348,12 +348,12 @@ export namespace fitness_v1 { /** * The different supported formats for each field in a data type. */ - format?: string; + format?: string | null; /** * Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type. */ - name?: string; - optional?: boolean; + name?: string | null; + optional?: boolean | null; } /** * Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including: - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance) - Display the source of data to the user (by using the device make / model) - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone) - Build different analysis models for each device/version. @@ -362,29 +362,29 @@ export namespace fitness_v1 { /** * Manufacturer of the product/hardware. */ - manufacturer?: string; + manufacturer?: string | null; /** * End-user visible model name for the device. */ - model?: string; + model?: string | null; /** * A constant representing the type of the device. */ - type?: string; + type?: string | null; /** * The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form. */ - uid?: string; + uid?: string | null; /** * Version string for the device hardware/software. */ - version?: string; + version?: string | null; } export interface Schema$ListDataPointChangesResponse { /** * The data stream ID of the data source with data point changes. */ - dataSourceId?: string; + dataSourceId?: string | null; /** * Deleted data points for the user. Note, for modifications this should be parsed before handling insertions. */ @@ -396,7 +396,7 @@ export namespace fitness_v1 { /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListDataSourcesResponse { /** @@ -412,11 +412,11 @@ export namespace fitness_v1 { /** * Flag to indicate server has more data to transfer */ - hasMoreData?: boolean; + hasMoreData?: boolean | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Sessions with an end time that is between startTime and endTime of the request. */ @@ -429,7 +429,7 @@ export namespace fitness_v1 { /** * Floating point value. */ - fpVal?: number; + fpVal?: number | null; } /** * Sessions contain metadata, such as a user-friendly name and time interval information. @@ -438,11 +438,11 @@ export namespace fitness_v1 { /** * Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value */ - activeTimeMillis?: string; + activeTimeMillis?: string | null; /** * The type of activity this session represents. */ - activityType?: number; + activityType?: number | null; /** * The application that created the session. */ @@ -450,27 +450,27 @@ export namespace fitness_v1 { /** * A description for this session. */ - description?: string; + description?: string | null; /** * An end time, in milliseconds since epoch, inclusive. */ - endTimeMillis?: string; + endTimeMillis?: string | null; /** * A client-generated identifier that is unique across all sessions owned by this particular user. */ - id?: string; + id?: string | null; /** * A timestamp that indicates when the session was last modified. */ - modifiedTimeMillis?: string; + modifiedTimeMillis?: string | null; /** * A human readable name of the session. */ - name?: string; + name?: string | null; /** * A start time, in milliseconds since epoch, inclusive. */ - startTimeMillis?: string; + startTimeMillis?: string | null; } /** * Holder object for the value of a single field in a data point. A field value has a particular format and is only ever set to one of an integer or a floating point value. LINT.IfChange @@ -479,11 +479,11 @@ export namespace fitness_v1 { /** * Floating point value. When this is set, other values must not be set. */ - fpVal?: number; + fpVal?: number | null; /** * Integer value. When this is set, other values must not be set. */ - intVal?: number; + intVal?: number | null; /** * Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled. */ @@ -491,10 +491,10 @@ export namespace fitness_v1 { /** * String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled. */ - stringVal?: string; + stringVal?: string | null; } export interface Schema$ValueMapValEntry { - key?: string; + key?: string | null; value?: Schema$MapValue; } diff --git a/src/apis/fusiontables/v1.ts b/src/apis/fusiontables/v1.ts index ffc6a91c77b..d21176b7bdf 100644 --- a/src/apis/fusiontables/v1.ts +++ b/src/apis/fusiontables/v1.ts @@ -118,27 +118,27 @@ export namespace fusiontables_v1 { /** * Color of line or the interior of a polygon in #RRGGBB format. */ - color?: string; + color?: string | null; /** * Icon name used for a point. */ - icon?: string; + 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; + 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; + min?: number | null; /** * Opacity of the color: 0.0 (transparent) to 1.0 (opaque). */ - opacity?: number; + opacity?: number | null; /** * Width of a line (in pixels). */ - weight?: number; + weight?: number | null; } /** * Specifies the id, name and type of a column in a table. @@ -147,31 +147,31 @@ export namespace fusiontables_v1 { /** * Optional identifier of the base column. If present, this column is derived from the specified base column. */ - baseColumn?: {columnId?: number; tableIndex?: number}; + baseColumn?: {columnId?: number; tableIndex?: number} | null; /** * Identifier for the column. */ - columnId?: number; + columnId?: number | null; /** * Optional column description. */ - description?: string; + 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; + graph_predicate?: string | null; /** * Type name: a template for an individual column. */ - kind?: string; + kind?: string | null; /** * Required name of the column. */ - name?: string; + name?: string | null; /** * Required type of the column. */ - type?: string; + type?: string | null; } /** * Represents a list of columns in a table. @@ -184,15 +184,15 @@ export namespace fusiontables_v1 { /** * Type name: a list of all columns. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of columns for the table. */ - totalItems?: number; + totalItems?: number | null; } /** * Represents a Geometry object. @@ -201,12 +201,12 @@ export namespace fusiontables_v1 { /** * The list of geometries in this geometry collection. */ - geometries?: any[]; - geometry?: any; + geometries?: any[] | null; + geometry?: any | null; /** * Type: A collection of geometries. */ - type?: string; + type?: string | null; } /** * Represents an import request. @@ -215,11 +215,11 @@ export namespace fusiontables_v1 { /** * Type name: a template for an import request. */ - kind?: string; + kind?: string | null; /** * The number of rows received from the import request. */ - numRowsReceived?: string; + numRowsReceived?: string | null; } /** * Represents a line geometry. @@ -228,11 +228,11 @@ export namespace fusiontables_v1 { /** * The coordinates that define the line. */ - coordinates?: number[][]; + coordinates?: number[][] | null; /** * Type: A line geometry. */ - type?: string; + type?: string | null; } /** * Represents a LineStyle within a StyleSetting @@ -241,7 +241,7 @@ export namespace fusiontables_v1 { /** * Color of the line in #RRGGBB format. */ - strokeColor?: string; + strokeColor?: string | null; /** * Column-value, gradient or buckets styler that is used to determine the line color and opacity. */ @@ -249,11 +249,11 @@ export namespace fusiontables_v1 { /** * Opacity of the line : 0.0 (transparent) to 1.0 (opaque). */ - strokeOpacity?: number; + strokeOpacity?: number | null; /** * Width of the line in pixels. */ - strokeWeight?: number; + strokeWeight?: number | null; /** * Column-value or bucket styler that is used to determine the width of the line. */ @@ -266,11 +266,11 @@ export namespace fusiontables_v1 { /** * The coordinates that define the point. */ - coordinates?: number[]; + coordinates?: number[] | null; /** * Point: A point geometry. */ - type?: string; + type?: string | null; } /** * Represents a PointStyle within a StyleSetting @@ -279,7 +279,7 @@ export namespace fusiontables_v1 { /** * Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519 */ - iconName?: string; + iconName?: string | null; /** * Column or a bucket value from which the icon name is to be determined. */ @@ -292,11 +292,11 @@ export namespace fusiontables_v1 { /** * The coordinates that define the polygon. */ - coordinates?: number[][][]; + coordinates?: number[][][] | null; /** * Type: A polygon geometry. */ - type?: string; + type?: string | null; } /** * Represents a PolygonStyle within a StyleSetting @@ -305,7 +305,7 @@ export namespace fusiontables_v1 { /** * Color of the interior of the polygon in #RRGGBB format. */ - fillColor?: string; + fillColor?: string | null; /** * Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon. */ @@ -313,11 +313,11 @@ export namespace fusiontables_v1 { /** * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque). */ - fillOpacity?: number; + fillOpacity?: number | null; /** * Color of the polygon border in #RRGGBB format. */ - strokeColor?: string; + strokeColor?: string | null; /** * Column-value, gradient or buckets styler that is used to determine the border color and opacity. */ @@ -325,11 +325,11 @@ export namespace fusiontables_v1 { /** * Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque). */ - strokeOpacity?: number; + strokeOpacity?: number | null; /** * Width of the polyon border in pixels. */ - strokeWeight?: number; + strokeWeight?: number | null; /** * Column-value or bucket styler that is used to determine the width of the polygon border. */ @@ -342,15 +342,15 @@ export namespace fusiontables_v1 { /** * Columns in the table. */ - columns?: string[]; + columns?: string[] | null; /** * Type name: a template for an individual table. */ - kind?: string; + 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[][]; + rows?: any[][] | null; } /** * Represents a StyleFunction within a StyleSetting @@ -363,7 +363,7 @@ export namespace fusiontables_v1 { /** * Name of the column whose value is used in the style. */ - columnName?: string; + columnName?: string | null; /** * Gradient function that interpolates a range of colors based on column value. */ @@ -371,11 +371,11 @@ export namespace fusiontables_v1 { 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; + kind?: string | null; } /** * Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId. @@ -384,7 +384,7 @@ export namespace fusiontables_v1 { /** * 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; + kind?: string | null; /** * Style definition for points in the table. */ @@ -392,7 +392,7 @@ export namespace fusiontables_v1 { /** * Optional name for the style setting. */ - name?: string; + name?: string | null; /** * Style definition for polygons in the table. */ @@ -404,11 +404,11 @@ export namespace fusiontables_v1 { /** * Identifier for the style setting (unique only within tables). */ - styleId?: number; + styleId?: number | null; /** * Identifier for the table. */ - tableId?: string; + tableId?: string | null; } /** * Represents a list of styles for a given table. @@ -421,15 +421,15 @@ export namespace fusiontables_v1 { /** * Type name: in this case, a list of style settings. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of styles for the table. */ - totalItems?: number; + totalItems?: number | null; } /** * Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link. @@ -438,15 +438,15 @@ export namespace fusiontables_v1 { /** * Optional attribution assigned to the table. */ - attribution?: string; + attribution?: string | null; /** * Optional link for attribution. */ - attributionLink?: string; + attributionLink?: string | null; /** * Optional base table identifier if this table is a view or merged table. */ - baseTableIds?: string[]; + baseTableIds?: string[] | null; /** * Columns in the table. */ @@ -454,27 +454,27 @@ export namespace fusiontables_v1 { /** * Optional description assigned to the table. */ - description?: string; + description?: string | null; /** * Variable for whether table is exportable. */ - isExportable?: boolean; + isExportable?: boolean | null; /** * Type name: a template for an individual table. */ - kind?: string; + kind?: string | null; /** * Name assigned to a table. */ - name?: string; + name?: string | null; /** * Optional sql that encodes the table definition for derived tables. */ - sql?: string; + sql?: string | null; /** * Encrypted unique alphanumeric identifier for the table. */ - tableId?: string; + tableId?: string | null; } /** * Represents a list of tables. @@ -487,11 +487,11 @@ export namespace fusiontables_v1 { /** * Type name: a list of all tables. */ - kind?: string; + 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; + nextPageToken?: string | null; } /** * Specifies the identifier, name, and type of a task in a table. @@ -500,23 +500,23 @@ export namespace fusiontables_v1 { /** * Type of the resource. This is always "fusiontables#task". */ - kind?: string; + kind?: string | null; /** * An indication of task progress. */ - progress?: string; + progress?: string | null; /** * false while the table is busy with some other task. true if this background task is currently running. */ - started?: boolean; + started?: boolean | null; /** * Identifier for the task. */ - taskId?: string; + 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; + type?: string | null; } /** * Represents a list of tasks for a table. @@ -529,15 +529,15 @@ export namespace fusiontables_v1 { /** * Type of the resource. This is always "fusiontables#taskList". */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of tasks for the table. */ - totalItems?: number; + totalItems?: number | null; } /** * Represents the contents of InfoWindow templates. @@ -546,27 +546,27 @@ export namespace fusiontables_v1 { /** * List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified. */ - automaticColumnNames?: string[]; + 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; + 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; + kind?: string | null; /** * Optional name assigned to a template. */ - name?: string; + name?: string | null; /** * Identifier for the table for which the template is defined. */ - tableId?: string; + tableId?: string | null; /** * Identifier for the template, unique within the context of a particular table. */ - templateId?: number; + templateId?: number | null; } /** * Represents a list of templates for a given table. @@ -579,15 +579,15 @@ export namespace fusiontables_v1 { /** * Type name: a list of all templates. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of templates for the table. */ - totalItems?: number; + totalItems?: number | null; } export class Resource$Column { diff --git a/src/apis/fusiontables/v2.ts b/src/apis/fusiontables/v2.ts index a2e285d652c..5d5df7763b0 100644 --- a/src/apis/fusiontables/v2.ts +++ b/src/apis/fusiontables/v2.ts @@ -118,27 +118,27 @@ export namespace fusiontables_v2 { /** * Color of line or the interior of a polygon in #RRGGBB format. */ - color?: string; + color?: string | null; /** * Icon name used for a point. */ - icon?: string; + 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; + 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; + min?: number | null; /** * Opacity of the color: 0.0 (transparent) to 1.0 (opaque). */ - opacity?: number; + opacity?: number | null; /** * Width of a line (in pixels). */ - weight?: number; + weight?: number | null; } /** * Specifies the details of a column in a table. @@ -147,51 +147,51 @@ export namespace fusiontables_v2 { /** * Identifier of the base column. If present, this column is derived from the specified base column. */ - baseColumn?: {columnId?: number; tableIndex?: number}; + baseColumn?: {columnId?: number; tableIndex?: number} | null; /** * Identifier for the column. */ - columnId?: number; + columnId?: number | null; /** * JSON schema for interpreting JSON in this column. */ - columnJsonSchema?: string; + columnJsonSchema?: string | null; /** * JSON object containing custom column properties. */ - columnPropertiesJson?: string; + columnPropertiesJson?: string | null; /** * Column description. */ - description?: string; + 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; + 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; + graphPredicate?: string | null; /** * The kind of item this is. For a column, this is always fusiontables#column. */ - kind?: string; + kind?: string | null; /** * Name of the column. */ - name?: string; + name?: string | null; /** * Type of the column. */ - type?: string; + type?: string | null; /** * If true, data entered via the web application is validated. */ - validateData?: boolean; + 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[]; + validValues?: string[] | null; } /** * Represents a list of columns in a table. @@ -204,15 +204,15 @@ export namespace fusiontables_v2 { /** * The kind of item this is. For a column list, this is always fusiontables#columnList. */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of columns for the table. */ - totalItems?: number; + totalItems?: number | null; } /** * Represents a Geometry object. @@ -221,12 +221,12 @@ export namespace fusiontables_v2 { /** * The list of geometries in this geometry collection. */ - geometries?: any[]; - geometry?: any; + geometries?: any[] | null; + geometry?: any | null; /** * Type: A collection of geometries. */ - type?: string; + type?: string | null; } /** * Represents an import request. @@ -235,11 +235,11 @@ export namespace fusiontables_v2 { /** * The kind of item this is. For an import, this is always fusiontables#import. */ - kind?: string; + kind?: string | null; /** * The number of rows received from the import request. */ - numRowsReceived?: string; + numRowsReceived?: string | null; } /** * Represents a line geometry. @@ -248,11 +248,11 @@ export namespace fusiontables_v2 { /** * The coordinates that define the line. */ - coordinates?: number[][]; + coordinates?: number[][] | null; /** * Type: A line geometry. */ - type?: string; + type?: string | null; } /** * Represents a LineStyle within a StyleSetting @@ -261,7 +261,7 @@ export namespace fusiontables_v2 { /** * Color of the line in #RRGGBB format. */ - strokeColor?: string; + strokeColor?: string | null; /** * Column-value, gradient or buckets styler that is used to determine the line color and opacity. */ @@ -269,11 +269,11 @@ export namespace fusiontables_v2 { /** * Opacity of the line : 0.0 (transparent) to 1.0 (opaque). */ - strokeOpacity?: number; + strokeOpacity?: number | null; /** * Width of the line in pixels. */ - strokeWeight?: number; + strokeWeight?: number | null; /** * Column-value or bucket styler that is used to determine the width of the line. */ @@ -286,11 +286,11 @@ export namespace fusiontables_v2 { /** * The coordinates that define the point. */ - coordinates?: number[]; + coordinates?: number[] | null; /** * Point: A point geometry. */ - type?: string; + type?: string | null; } /** * Represents a PointStyle within a StyleSetting @@ -299,7 +299,7 @@ export namespace fusiontables_v2 { /** * Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519 */ - iconName?: string; + iconName?: string | null; /** * Column or a bucket value from which the icon name is to be determined. */ @@ -312,11 +312,11 @@ export namespace fusiontables_v2 { /** * The coordinates that define the polygon. */ - coordinates?: number[][][]; + coordinates?: number[][][] | null; /** * Type: A polygon geometry. */ - type?: string; + type?: string | null; } /** * Represents a PolygonStyle within a StyleSetting @@ -325,7 +325,7 @@ export namespace fusiontables_v2 { /** * Color of the interior of the polygon in #RRGGBB format. */ - fillColor?: string; + fillColor?: string | null; /** * Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon. */ @@ -333,11 +333,11 @@ export namespace fusiontables_v2 { /** * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque). */ - fillOpacity?: number; + fillOpacity?: number | null; /** * Color of the polygon border in #RRGGBB format. */ - strokeColor?: string; + strokeColor?: string | null; /** * Column-value, gradient or buckets styler that is used to determine the border color and opacity. */ @@ -345,11 +345,11 @@ export namespace fusiontables_v2 { /** * Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque). */ - strokeOpacity?: number; + strokeOpacity?: number | null; /** * Width of the polyon border in pixels. */ - strokeWeight?: number; + strokeWeight?: number | null; /** * Column-value or bucket styler that is used to determine the width of the polygon border. */ @@ -362,15 +362,15 @@ export namespace fusiontables_v2 { /** * Columns in the table. */ - columns?: string[]; + columns?: string[] | null; /** * The kind of item this is. For responses to SQL queries, this is always fusiontables#sqlresponse. */ - kind?: string; + 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[][]; + rows?: any[][] | null; } /** * Represents a StyleFunction within a StyleSetting @@ -383,7 +383,7 @@ export namespace fusiontables_v2 { /** * Name of the column whose value is used in the style. */ - columnName?: string; + columnName?: string | null; /** * Gradient function that interpolates a range of colors based on column value. */ @@ -391,11 +391,11 @@ export namespace fusiontables_v2 { 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; + kind?: string | null; } /** * Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId. @@ -404,7 +404,7 @@ export namespace fusiontables_v2 { /** * 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; + kind?: string | null; /** * Style definition for points in the table. */ @@ -412,7 +412,7 @@ export namespace fusiontables_v2 { /** * Optional name for the style setting. */ - name?: string; + name?: string | null; /** * Style definition for polygons in the table. */ @@ -424,11 +424,11 @@ export namespace fusiontables_v2 { /** * Identifier for the style setting (unique only within tables). */ - styleId?: number; + styleId?: number | null; /** * Identifier for the table. */ - tableId?: string; + tableId?: string | null; } /** * Represents a list of styles for a given table. @@ -441,15 +441,15 @@ export namespace fusiontables_v2 { /** * The kind of item this is. For a style list, this is always fusiontables#styleSettingList . */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of styles for the table. */ - totalItems?: number; + totalItems?: number | null; } /** * Represents a table. @@ -458,19 +458,19 @@ export namespace fusiontables_v2 { /** * Attribution assigned to the table. */ - attribution?: string; + attribution?: string | null; /** * Optional link for attribution. */ - attributionLink?: string; + attributionLink?: string | null; /** * Base table identifier if this table is a view or merged table. */ - baseTableIds?: string[]; + baseTableIds?: string[] | null; /** * Default JSON schema for validating all JSON column properties. */ - columnPropertiesJsonSchema?: string; + columnPropertiesJsonSchema?: string | null; /** * Columns in the table. */ @@ -478,35 +478,35 @@ export namespace fusiontables_v2 { /** * Description assigned to the table. */ - description?: string; + description?: string | null; /** * Variable for whether table is exportable. */ - isExportable?: boolean; + isExportable?: boolean | null; /** * The kind of item this is. For a table, this is always fusiontables#table. */ - kind?: string; + kind?: string | null; /** * Name assigned to a table. */ - name?: string; + name?: string | null; /** * SQL that encodes the table definition for derived tables. */ - sql?: string; + sql?: string | null; /** * Encrypted unique alphanumeric identifier for the table. */ - tableId?: string; + tableId?: string | null; /** * JSON object containing custom table properties. */ - tablePropertiesJson?: string; + tablePropertiesJson?: string | null; /** * JSON schema for validating the JSON table properties. */ - tablePropertiesJsonSchema?: string; + tablePropertiesJsonSchema?: string | null; } /** * Represents a list of tables. @@ -519,11 +519,11 @@ export namespace fusiontables_v2 { /** * The kind of item this is. For table list, this is always fusiontables#tableList. */ - kind?: string; + 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; + 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. @@ -532,23 +532,23 @@ export namespace fusiontables_v2 { /** * Type of the resource. This is always "fusiontables#task". */ - kind?: string; + kind?: string | null; /** * Task percentage completion. */ - progress?: string; + progress?: string | null; /** * false while the table is busy with some other task. true if this background task is currently running. */ - started?: boolean; + started?: boolean | null; /** * Identifier for the task. */ - taskId?: string; + taskId?: string | null; /** * Type of background task. */ - type?: string; + type?: string | null; } /** * Represents a list of tasks for a table. @@ -561,15 +561,15 @@ export namespace fusiontables_v2 { /** * Type of the resource. This is always "fusiontables#taskList". */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of tasks for the table. */ - totalItems?: number; + totalItems?: number | null; } /** * Represents the contents of InfoWindow templates. @@ -578,27 +578,27 @@ export namespace fusiontables_v2 { /** * List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified. */ - automaticColumnNames?: string[]; + 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; + body?: string | null; /** * The kind of item this is. For a template, this is always fusiontables#template. */ - kind?: string; + kind?: string | null; /** * Optional name assigned to a template. */ - name?: string; + name?: string | null; /** * Identifier for the table for which the template is defined. */ - tableId?: string; + tableId?: string | null; /** * Identifier for the template, unique within the context of a particular table. */ - templateId?: number; + templateId?: number | null; } /** * Represents a list of templates for a given table. @@ -611,15 +611,15 @@ export namespace fusiontables_v2 { /** * The kind of item this is. For a template list, this is always fusiontables#templateList . */ - kind?: string; + 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; + nextPageToken?: string | null; /** * Total number of templates for the table. */ - totalItems?: number; + totalItems?: number | null; } export class Resource$Column { diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index 42ae4493d75..490e7d6074c 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -138,55 +138,55 @@ export namespace games_v1 { /** * The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental. */ - achievementType?: string; + achievementType?: string | null; /** * The description of the achievement. */ - description?: string; + description?: string | null; /** * Experience points which will be earned when unlocking this achievement. */ - experiencePoints?: string; + experiencePoints?: string | null; /** * The total steps for an incremental achievement as a string. */ - formattedTotalSteps?: string; + formattedTotalSteps?: string | null; /** * The ID of the achievement. */ - id?: string; + id?: string | null; /** * The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ - initialState?: string; + initialState?: string | null; /** * Indicates whether the revealed icon image being returned is a default image, or is provided by the game. */ - isRevealedIconUrlDefault?: boolean; + isRevealedIconUrlDefault?: boolean | null; /** * Indicates whether the unlocked icon image being returned is a default image, or is game-provided. */ - isUnlockedIconUrlDefault?: boolean; + isUnlockedIconUrlDefault?: boolean | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinition. */ - kind?: string; + kind?: string | null; /** * The name of the achievement. */ - name?: string; + name?: string | null; /** * The image URL for the revealed achievement icon. */ - revealedIconUrl?: string; + revealedIconUrl?: string | null; /** * The total steps for an incremental achievement. */ - totalSteps?: number; + totalSteps?: number | null; /** * The image URL for the unlocked achievement icon. */ - unlockedIconUrl?: string; + unlockedIconUrl?: string | null; } /** * This is a JSON template for a list of achievement definition objects. @@ -199,11 +199,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinitionsListResponse. */ - kind?: string; + kind?: string | null; /** * Token corresponding to the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for an achievement increment response @@ -212,15 +212,15 @@ export namespace games_v1 { /** * The current steps recorded for this incremental achievement. */ - currentSteps?: number; + currentSteps?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementIncrementResponse. */ - kind?: string; + kind?: string | null; /** * Whether the current steps for the achievement has reached the number of steps required to unlock. */ - newlyUnlocked?: boolean; + newlyUnlocked?: boolean | null; } /** * This is a JSON template for an achievement reveal response @@ -229,11 +229,11 @@ export namespace games_v1 { /** * The current state of the achievement for which a reveal was attempted. This might be UNLOCKED if the achievement was already unlocked. Possible values are: - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ - currentState?: string; + currentState?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementRevealResponse. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for an achievement set steps at least response. @@ -242,15 +242,15 @@ export namespace games_v1 { /** * The current steps recorded for this incremental achievement. */ - currentSteps?: number; + currentSteps?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementSetStepsAtLeastResponse. */ - kind?: string; + kind?: string | null; /** * Whether the the current steps for the achievement has reached the number of steps required to unlock. */ - newlyUnlocked?: boolean; + newlyUnlocked?: boolean | null; } /** * This is a JSON template for an achievement unlock response @@ -259,11 +259,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUnlockResponse. */ - kind?: string; + kind?: string | null; /** * Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player). */ - newlyUnlocked?: boolean; + newlyUnlocked?: boolean | null; } /** * This is a JSON template for a list of achievement update requests. @@ -272,7 +272,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateMultipleRequest. */ - kind?: string; + kind?: string | null; /** * The individual achievement update requests. */ @@ -285,7 +285,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateListResponse. */ - kind?: string; + kind?: string | null; /** * The updated state of the achievements. */ @@ -298,7 +298,7 @@ export namespace games_v1 { /** * The achievement this update is being applied to. */ - achievementId?: string; + achievementId?: string | null; /** * The payload if an update of type INCREMENT was requested for the achievement. */ @@ -306,7 +306,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateRequest. */ - kind?: string; + kind?: string | null; /** * The payload if an update of type SET_STEPS_AT_LEAST was requested for the achievement. */ @@ -314,7 +314,7 @@ export namespace games_v1 { /** * The type of update being applied. Possible values are: - "REVEAL" - Achievement is revealed. - "UNLOCK" - Achievement is unlocked. - "INCREMENT" - Achievement is incremented. - "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed value. */ - updateType?: string; + updateType?: string | null; } /** * This is a JSON template for an achievement update response. @@ -323,27 +323,27 @@ export namespace games_v1 { /** * The achievement this update is was applied to. */ - achievementId?: string; + achievementId?: string | null; /** * The current state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ - currentState?: string; + currentState?: string | null; /** * The current steps recorded for this achievement if it is incremental. */ - currentSteps?: number; + currentSteps?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateResponse. */ - kind?: string; + kind?: string | null; /** * Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player). */ - newlyUnlocked?: boolean; + newlyUnlocked?: boolean | null; /** * Whether the requested updates actually affected the achievement. */ - updateOccurred?: boolean; + updateOccurred?: boolean | null; } /** * This is a JSON template for aggregate stats. @@ -352,23 +352,23 @@ export namespace games_v1 { /** * The number of messages sent between a pair of peers. */ - count?: string; + count?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats. */ - kind?: string; + kind?: string | null; /** * The maximum amount. */ - max?: string; + max?: string | null; /** * The minimum amount. */ - min?: string; + min?: string | null; /** * The total number of bytes sent for messages between a pair of peers. */ - sum?: string; + sum?: string | null; } /** * This is a JSON template for an anonymous player @@ -377,15 +377,15 @@ export namespace games_v1 { /** * The base URL for the image to display for the anonymous player. */ - avatarImageUrl?: string; + avatarImageUrl?: string | null; /** * The name to display for the anonymous player. */ - displayName?: string; + displayName?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for the Application resource. @@ -394,7 +394,7 @@ export namespace games_v1 { /** * The number of achievements visible to the currently authenticated player. */ - achievement_count?: number; + achievement_count?: number | null; /** * The assets of the application. */ @@ -402,7 +402,7 @@ export namespace games_v1 { /** * The author of the application. */ - author?: string; + author?: string | null; /** * The category of the application. */ @@ -410,15 +410,15 @@ export namespace games_v1 { /** * The description of the application. */ - description?: string; + description?: string | null; /** * A list of features that have been enabled for the application. Possible values are: - "SNAPSHOTS" - Snapshots has been enabled */ - enabledFeatures?: string[]; + enabledFeatures?: string[] | null; /** * The ID of the application. */ - id?: string; + id?: string | null; /** * The instances of the application. */ @@ -426,23 +426,23 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#application. */ - kind?: string; + kind?: string | null; /** * The last updated timestamp of the application. */ - lastUpdatedTimestamp?: string; + lastUpdatedTimestamp?: string | null; /** * The number of leaderboards visible to the currently authenticated player. */ - leaderboard_count?: number; + leaderboard_count?: number | null; /** * The name of the application. */ - name?: string; + name?: string | null; /** * A hint to the client UI for what color to use as an app-themed color. The color is given as an RGB triplet (e.g. "E0E0E0"). */ - themeColor?: string; + themeColor?: string | null; } /** * This is a JSON template for an application category object. @@ -451,15 +451,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#applicationCategory. */ - kind?: string; + kind?: string | null; /** * The primary category. */ - primary?: string; + primary?: string | null; /** * The secondary category. */ - secondary?: string; + secondary?: string | null; } /** * This is a JSON template for a third party application verification response resource. @@ -468,15 +468,15 @@ export namespace games_v1 { /** * An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.) */ - alternate_player_id?: string; + alternate_player_id?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#applicationVerifyResponse. */ - kind?: string; + kind?: string | null; /** * The ID of the player that was issued the auth token used in this request. */ - player_id?: string; + player_id?: string | null; } /** * This is a JSON template for data related to individual game categories. @@ -485,15 +485,15 @@ export namespace games_v1 { /** * The category name. */ - category?: string; + category?: string | null; /** * Experience points earned in this category. */ - experiencePoints?: string; + experiencePoints?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#category. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for a list of category data objects. @@ -506,11 +506,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#categoryListResponse. */ - kind?: string; + kind?: string | null; /** * Token corresponding to the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for a batch update failure resource. @@ -519,11 +519,11 @@ export namespace games_v1 { /** * The cause for the update failure. Possible values are: - "TOO_LARGE": A batch request was issued with more events than are allowed in a single batch. - "TIME_PERIOD_EXPIRED": A batch was sent with data too far in the past to record. - "TIME_PERIOD_SHORT": A batch was sent with a time range that was too short. - "TIME_PERIOD_LONG": A batch was sent with a time range that was too long. - "ALREADY_UPDATED": An attempt was made to record a batch of data which was already seen. - "RECORD_RATE_HIGH": An attempt was made to record data faster than the server will apply updates. */ - failureCause?: string; + failureCause?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventBatchRecordFailure. */ - kind?: string; + kind?: string | null; /** * The time range which was rejected; empty for a request-wide failure. */ @@ -536,11 +536,11 @@ export namespace games_v1 { /** * The ID of the child event. */ - childId?: string; + childId?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventChild. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for an event definition resource. @@ -553,31 +553,31 @@ export namespace games_v1 { /** * Description of what this event represents. */ - description?: string; + description?: string | null; /** * The name to display for the event. */ - displayName?: string; + displayName?: string | null; /** * The ID of the event. */ - id?: string; + id?: string | null; /** * The base URL for the image that represents the event. */ - imageUrl?: string; + imageUrl?: string | null; /** * Indicates whether the icon image being returned is a default image, or is game-provided. */ - isDefaultImageUrl?: boolean; + isDefaultImageUrl?: boolean | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinition. */ - kind?: string; + kind?: string | null; /** * The visibility of event being tracked in this definition. Possible values are: - "REVEALED": This event should be visible to all users. - "HIDDEN": This event should only be shown to users that have recorded this event at least once. */ - visibility?: string; + visibility?: string | null; } /** * This is a JSON template for a ListDefinitions response. @@ -590,11 +590,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinitionListResponse. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for an event period time range. @@ -603,15 +603,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodRange. */ - kind?: string; + kind?: string | null; /** * The time when this update period ends, in millis, since 1970 UTC (Unix Epoch). */ - periodEndMillis?: string; + periodEndMillis?: string | null; /** * The time when this update period begins, in millis, since 1970 UTC (Unix Epoch). */ - periodStartMillis?: string; + periodStartMillis?: string | null; } /** * This is a JSON template for an event period update resource. @@ -620,7 +620,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodUpdate. */ - kind?: string; + kind?: string | null; /** * The time period being covered by this update. */ @@ -637,15 +637,15 @@ export namespace games_v1 { /** * The ID of the event that was not updated. */ - eventId?: string; + eventId?: string | null; /** * The cause for the update failure. Possible values are: - "NOT_FOUND" - An attempt was made to set an event that was not defined. - "INVALID_UPDATE_VALUE" - An attempt was made to increment an event by a non-positive value. */ - failureCause?: string; + failureCause?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordFailure. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for an event period update resource. @@ -654,15 +654,15 @@ export namespace games_v1 { /** * The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch). */ - currentTimeMillis?: string; + currentTimeMillis?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordRequest. */ - kind?: string; + kind?: string | null; /** * The request ID used to identify this attempt to record events. */ - requestId?: string; + requestId?: string | null; /** * A list of the time period updates being made in this request. */ @@ -675,15 +675,15 @@ export namespace games_v1 { /** * The ID of the event being modified in this update. */ - definitionId?: string; + definitionId?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateRequest. */ - kind?: string; + kind?: string | null; /** * The number of times this event occurred in this time period. */ - updateCount?: string; + updateCount?: string | null; } /** * This is a JSON template for an event period update resource. @@ -700,7 +700,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateResponse. */ - kind?: string; + kind?: string | null; /** * The current status of any updated events */ @@ -713,15 +713,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementIncrement. */ - kind?: string; + kind?: string | null; /** * The requestId associated with an increment to an achievement. */ - requestId?: string; + requestId?: string | null; /** * The number of steps to be incremented. */ - steps?: number; + steps?: number | null; } /** * This is a JSON template for the payload to request to increment an achievement. @@ -730,11 +730,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementSetStepsAtLeast. */ - kind?: string; + kind?: string | null; /** * The minimum number of steps for the achievement to be set to. */ - steps?: number; + steps?: number | null; } /** * This is a JSON template for an image asset object. @@ -743,23 +743,23 @@ export namespace games_v1 { /** * The height of the asset. */ - height?: number; + height?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#imageAsset. */ - kind?: string; + kind?: string | null; /** * The name of the asset. */ - name?: string; + name?: string | null; /** * The URL of the asset. */ - url?: string; + url?: string | null; /** * The width of the asset. */ - width?: number; + width?: number | null; } /** * This is a JSON template for the Instance resource. @@ -768,7 +768,7 @@ export namespace games_v1 { /** * URI which shows where a user can acquire this instance. */ - acquisitionUri?: string; + acquisitionUri?: string | null; /** * Platform dependent details for Android. */ @@ -780,23 +780,23 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#instance. */ - kind?: string; + kind?: string | null; /** * Localized display name. */ - name?: string; + name?: string | null; /** * The platform type. Possible values are: - "ANDROID" - Instance is for Android. - "IOS" - Instance is for iOS - "WEB_APP" - Instance is for Web App. */ - platformType?: string; + platformType?: string | null; /** * Flag to show if this game instance supports realtime play. */ - realtimePlay?: boolean; + realtimePlay?: boolean | null; /** * Flag to show if this game instance supports turn based play. */ - turnBasedPlay?: boolean; + turnBasedPlay?: boolean | null; /** * Platform dependent details for Web. */ @@ -809,19 +809,19 @@ export namespace games_v1 { /** * Flag indicating whether the anti-piracy check is enabled. */ - enablePiracyCheck?: boolean; + enablePiracyCheck?: boolean | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#instanceAndroidDetails. */ - kind?: string; + kind?: string | null; /** * Android package name which maps to Google Play URL. */ - packageName?: string; + packageName?: string | null; /** * Indicates that this instance is the default for new installations. */ - preferred?: boolean; + preferred?: boolean | null; } /** * This is a JSON template for the iOS details resource. @@ -830,31 +830,31 @@ export namespace games_v1 { /** * Bundle identifier. */ - bundleIdentifier?: string; + bundleIdentifier?: string | null; /** * iTunes App ID. */ - itunesAppId?: string; + itunesAppId?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#instanceIosDetails. */ - kind?: string; + kind?: string | null; /** * Indicates that this instance is the default for new installations on iPad devices. */ - preferredForIpad?: boolean; + preferredForIpad?: boolean | null; /** * Indicates that this instance is the default for new installations on iPhone devices. */ - preferredForIphone?: boolean; + preferredForIphone?: boolean | null; /** * Flag to indicate if this instance supports iPad. */ - supportIpad?: boolean; + supportIpad?: boolean | null; /** * Flag to indicate if this instance supports iPhone. */ - supportIphone?: boolean; + supportIphone?: boolean | null; } /** * This is a JSON template for the Web details resource. @@ -863,15 +863,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#instanceWebDetails. */ - kind?: string; + kind?: string | null; /** * Launch URL for the game. */ - launchUrl?: string; + launchUrl?: string | null; /** * Indicates that this instance is the default for new installations. */ - preferred?: boolean; + preferred?: boolean | null; } /** * This is a JSON template for the Leaderboard resource. @@ -880,27 +880,27 @@ export namespace games_v1 { /** * The icon for the leaderboard. */ - iconUrl?: string; + iconUrl?: string | null; /** * The leaderboard ID. */ - id?: string; + id?: string | null; /** * Indicates whether the icon image being returned is a default image, or is game-provided. */ - isIconUrlDefault?: boolean; + isIconUrlDefault?: boolean | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard. */ - kind?: string; + kind?: string | null; /** * The name of the leaderboard. */ - name?: string; + name?: string | null; /** * How scores are ordered. Possible values are: - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order. - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order. */ - order?: string; + order?: string | null; } /** * This is a JSON template for the Leaderboard Entry resource. @@ -909,15 +909,15 @@ export namespace games_v1 { /** * The localized string for the numerical value of this score. */ - formattedScore?: string; + formattedScore?: string | null; /** * The localized string for the rank of this score for this leaderboard. */ - formattedScoreRank?: string; + formattedScoreRank?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardEntry. */ - kind?: string; + kind?: string | null; /** * The player who holds this score. */ @@ -925,23 +925,23 @@ export namespace games_v1 { /** * The rank of this score for this leaderboard. */ - scoreRank?: string; + scoreRank?: string | null; /** * Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ - scoreTag?: string; + scoreTag?: string | null; /** * The numerical value of this score. */ - scoreValue?: string; + scoreValue?: string | null; /** * The time span of this high score. Possible values are: - "ALL_TIME" - The score is an all-time high score. - "WEEKLY" - The score is a weekly high score. - "DAILY" - The score is a daily high score. */ - timeSpan?: string; + timeSpan?: string | null; /** * The timestamp at which this score was recorded, in milliseconds since the epoch in UTC. */ - writeTimestampMillis?: string; + writeTimestampMillis?: string | null; } /** * This is a JSON template for a list of leaderboard objects. @@ -954,11 +954,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardListResponse. */ - kind?: string; + kind?: string | null; /** * Token corresponding to the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for a score rank in a leaderboard. @@ -967,23 +967,23 @@ export namespace games_v1 { /** * The number of scores in the leaderboard as a string. */ - formattedNumScores?: string; + formattedNumScores?: string | null; /** * The rank in the leaderboard as a string. */ - formattedRank?: string; + formattedRank?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScoreRank. */ - kind?: string; + kind?: string | null; /** * The number of scores in the leaderboard. */ - numScores?: string; + numScores?: string | null; /** * The rank in the leaderboard. */ - rank?: string; + rank?: string | null; } /** * This is a JSON template for a ListScores response. @@ -996,15 +996,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScores. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of scores in the leaderboard. */ - numScores?: string; + numScores?: string | null; /** * The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the scoreRank and formattedScoreRank values will not be present. */ @@ -1012,7 +1012,7 @@ export namespace games_v1 { /** * The pagination token for the previous page of results. */ - prevPageToken?: string; + prevPageToken?: string | null; } /** * This is a JSON template for the metagame config resource @@ -1021,11 +1021,11 @@ export namespace games_v1 { /** * Current version of the metagame configuration data. When this data is updated, the version number will be increased by one. */ - currentVersion?: number; + currentVersion?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#metagameConfig. */ - kind?: string; + kind?: string | null; /** * The list of player levels. */ @@ -1038,31 +1038,31 @@ export namespace games_v1 { /** * The Android network subtype. */ - androidNetworkSubtype?: number; + androidNetworkSubtype?: number | null; /** * The Android network type. */ - androidNetworkType?: number; + androidNetworkType?: number | null; /** * iOS network type as defined in Reachability.h. */ - iosNetworkType?: number; + iosNetworkType?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics. */ - kind?: string; + kind?: string | null; /** * The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html */ - networkOperatorCode?: string; + networkOperatorCode?: string | null; /** * The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName */ - networkOperatorName?: string; + networkOperatorName?: string | null; /** * The amount of time in milliseconds it took for the client to establish a connection with the XMPP server. */ - registrationLatencyMillis?: number; + registrationLatencyMillis?: number | null; } /** * This is a JSON template for a result for a match participant. @@ -1071,19 +1071,19 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. */ - kind?: string; + kind?: string | null; /** * The ID of the participant. */ - participantId?: string; + participantId?: string | null; /** * The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. */ - placing?: number; + placing?: number | null; /** * The result of the participant for this match. Possible values are: - "MATCH_RESULT_WIN" - The participant won the match. - "MATCH_RESULT_LOSS" - The participant lost the match. - "MATCH_RESULT_TIE" - The participant tied the match. - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. */ - result?: string; + result?: string | null; } /** * This is a JSON template for peer channel diagnostics. @@ -1100,23 +1100,23 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#peerChannelDiagnostics. */ - kind?: string; + kind?: string | null; /** * Number of messages lost. */ - numMessagesLost?: number; + numMessagesLost?: number | null; /** * Number of messages received. */ - numMessagesReceived?: number; + numMessagesReceived?: number | null; /** * Number of messages sent. */ - numMessagesSent?: number; + numMessagesSent?: number | null; /** * Number of send failures. */ - numSendFailures?: number; + numSendFailures?: number | null; /** * Roundtrip latency stats in milliseconds. */ @@ -1129,15 +1129,15 @@ export namespace games_v1 { /** * Connected time in milliseconds. */ - connectedTimestampMillis?: string; + connectedTimestampMillis?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#peerSessionDiagnostics. */ - kind?: string; + kind?: string | null; /** * The participant ID of the peer. */ - participantId?: string; + participantId?: string | null; /** * Reliable channel diagnostics. */ @@ -1154,15 +1154,15 @@ export namespace games_v1 { /** * True if the player was auto-matched with the currently authenticated user. */ - autoMatched?: boolean; + autoMatched?: boolean | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#played. */ - kind?: string; + kind?: string | null; /** * The last time the player played the game in milliseconds since the epoch in UTC. */ - timeMillis?: string; + timeMillis?: string | null; } /** * This is a JSON template for a Player resource. @@ -1171,19 +1171,19 @@ export namespace games_v1 { /** * The base URL for the image that represents the player. */ - avatarImageUrl?: string; + avatarImageUrl?: string | null; /** * The url to the landscape mode player banner image. */ - bannerUrlLandscape?: string; + bannerUrlLandscape?: string | null; /** * The url to the portrait mode player banner image. */ - bannerUrlPortrait?: string; + bannerUrlPortrait?: string | null; /** * The name to display for the player. */ - displayName?: string; + displayName?: string | null; /** * An object to represent Play Game experience information for the player. */ @@ -1191,7 +1191,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#player. */ - kind?: string; + kind?: string | null; /** * Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. */ @@ -1199,15 +1199,15 @@ export namespace games_v1 { /** * An object representation of the individual components of the player's name. For some players, these fields may not be present. */ - name?: {familyName?: string; givenName?: string}; + name?: {familyName?: string; givenName?: string} | null; /** * The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. */ - originalPlayerId?: string; + originalPlayerId?: string | null; /** * The ID of the player. */ - playerId?: string; + playerId?: string | null; /** * The player's profile settings. Controls whether or not the player's profile is visible to other players. */ @@ -1215,7 +1215,7 @@ export namespace games_v1 { /** * The player's title rewarded for their game activities. */ - title?: string; + title?: string | null; } /** * This is a JSON template for an achievement object. @@ -1224,31 +1224,31 @@ export namespace games_v1 { /** * The state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ - achievementState?: string; + achievementState?: string | null; /** * The current steps for an incremental achievement. */ - currentSteps?: number; + currentSteps?: number | null; /** * Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished. */ - experiencePoints?: string; + experiencePoints?: string | null; /** * The current steps for an incremental achievement as a string. */ - formattedCurrentStepsString?: string; + formattedCurrentStepsString?: string | null; /** * The ID of the achievement. */ - id?: string; + id?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievement. */ - kind?: string; + kind?: string | null; /** * The timestamp of the last modification to this achievement's state. */ - lastUpdatedTimestamp?: string; + lastUpdatedTimestamp?: string | null; } /** * This is a JSON template for a list of achievement objects. @@ -1261,11 +1261,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievementListResponse. */ - kind?: string; + kind?: string | null; /** * Token corresponding to the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for an event status resource. @@ -1274,23 +1274,23 @@ export namespace games_v1 { /** * The ID of the event definition. */ - definitionId?: string; + definitionId?: string | null; /** * The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console. */ - formattedNumEvents?: string; + formattedNumEvents?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerEvent. */ - kind?: string; + kind?: string | null; /** * The current number of times this event has occurred. */ - numEvents?: string; + numEvents?: string | null; /** * The ID of the player. */ - playerId?: string; + playerId?: string | null; } /** * This is a JSON template for a ListByPlayer response. @@ -1303,11 +1303,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerEventListResponse. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for 1P/3P metadata about the player's experience. @@ -1316,7 +1316,7 @@ export namespace games_v1 { /** * The current number of experience points for the player. */ - currentExperiencePoints?: string; + currentExperiencePoints?: string | null; /** * The current level of the player. */ @@ -1324,11 +1324,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. */ - kind?: string; + kind?: string | null; /** * The timestamp when the player was leveled up, in millis since Unix epoch UTC. */ - lastLevelUpTimestampMillis?: string; + lastLevelUpTimestampMillis?: string | null; /** * The next level of the player. If the current level is the maximum level, this should be same as the current level. */ @@ -1341,11 +1341,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScore. */ - kind?: string; + kind?: string | null; /** * The ID of the leaderboard this score is in. */ - leaderboard_id?: string; + leaderboard_id?: string | null; /** * The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly. */ @@ -1353,15 +1353,15 @@ export namespace games_v1 { /** * The formatted value of this score. */ - scoreString?: string; + scoreString?: string | null; /** * Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ - scoreTag?: string; + scoreTag?: string | null; /** * The numerical value of this score. */ - scoreValue?: string; + scoreValue?: string | null; /** * The social rank of the score in this leaderboard. */ @@ -1369,11 +1369,11 @@ export namespace games_v1 { /** * The time span of this score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ - timeSpan?: string; + timeSpan?: string | null; /** * The timestamp at which this score was recorded, in milliseconds since the epoch in UTC. */ - writeTimestamp?: string; + writeTimestamp?: string | null; } /** * This is a JSON template for a list of player leaderboard scores. @@ -1386,11 +1386,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScoreListResponse. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The Player resources for the owner of this score. */ @@ -1403,19 +1403,19 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. */ - kind?: string; + kind?: string | null; /** * The level for the user. */ - level?: number; + level?: number | null; /** * The maximum experience points for this level. */ - maxExperiencePoints?: string; + maxExperiencePoints?: string | null; /** * The minimum experience points for this level. */ - minExperiencePoints?: string; + minExperiencePoints?: string | null; } /** * This is a JSON template for a third party player list response. @@ -1428,11 +1428,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerListResponse. */ - kind?: string; + kind?: string | null; /** * Token corresponding to the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for a player score. @@ -1441,23 +1441,23 @@ export namespace games_v1 { /** * The formatted score for this player score. */ - formattedScore?: string; + formattedScore?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScore. */ - kind?: string; + kind?: string | null; /** * The numerical value for this player score. */ - score?: string; + score?: string | null; /** * Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ - scoreTag?: string; + scoreTag?: string | null; /** * The time span for this player score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ - timeSpan?: string; + timeSpan?: string | null; } /** * This is a JSON template for a list of score submission statuses. @@ -1466,7 +1466,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreListResponse. */ - kind?: string; + kind?: string | null; /** * The score submissions statuses. */ @@ -1479,23 +1479,23 @@ export namespace games_v1 { /** * The time spans where the submitted score is better than the existing score for that time span. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ - beatenScoreTimeSpans?: string[]; + beatenScoreTimeSpans?: string[] | null; /** * The formatted value of the submitted score. */ - formattedScore?: string; + formattedScore?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreResponse. */ - kind?: string; + kind?: string | null; /** * The leaderboard ID that this score was submitted to. */ - leaderboardId?: string; + leaderboardId?: string | null; /** * Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ - scoreTag?: string; + scoreTag?: string | null; /** * The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's DAILY score, but not better than the player's scores for the WEEKLY or ALL_TIME time spans. */ @@ -1508,7 +1508,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreSubmissionList. */ - kind?: string; + kind?: string | null; /** * The score submissions. */ @@ -1521,8 +1521,8 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. */ - kind?: string; - profileVisible?: boolean; + kind?: string | null; + profileVisible?: boolean | null; } /** * This is a JSON template for a push token resource. @@ -1531,7 +1531,7 @@ export namespace games_v1 { /** * The revision of the client SDK used by your application, in the same format that's used by revisions.check. Used to send backward compatible messages. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - IOS - Push token is for iOS */ - clientRevision?: string; + clientRevision?: string | null; /** * Unique identifier for this push token. */ @@ -1539,11 +1539,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#pushToken. */ - kind?: string; + kind?: string | null; /** * The preferred language for notifications that are sent using this token. */ - language?: string; + language?: string | null; } /** * This is a JSON template for a push token ID resource. @@ -1552,11 +1552,11 @@ export namespace games_v1 { /** * A push token ID for iOS devices. */ - ios?: {apns_device_token?: string; apns_environment?: string}; + ios?: {apns_device_token?: string; apns_environment?: string} | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#pushTokenId. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for a Quest resource. @@ -1565,47 +1565,47 @@ export namespace games_v1 { /** * The timestamp at which the user accepted the quest in milliseconds since the epoch in UTC. Only present if the player has accepted the quest. */ - acceptedTimestampMillis?: string; + acceptedTimestampMillis?: string | null; /** * The ID of the application this quest is part of. */ - applicationId?: string; + applicationId?: string | null; /** * The banner image URL for the quest. */ - bannerUrl?: string; + bannerUrl?: string | null; /** * The description of the quest. */ - description?: string; + description?: string | null; /** * The timestamp at which the quest ceases to be active in milliseconds since the epoch in UTC. */ - endTimestampMillis?: string; + endTimestampMillis?: string | null; /** * The icon image URL for the quest. */ - iconUrl?: string; + iconUrl?: string | null; /** * The ID of the quest. */ - id?: string; + id?: string | null; /** * Indicates whether the banner image being returned is a default image, or is game-provided. */ - isDefaultBannerUrl?: boolean; + isDefaultBannerUrl?: boolean | null; /** * Indicates whether the icon image being returned is a default image, or is game-provided. */ - isDefaultIconUrl?: boolean; + isDefaultIconUrl?: boolean | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#quest. */ - kind?: string; + kind?: string | null; /** * The timestamp at which the quest was last updated by the user in milliseconds since the epoch in UTC. Only present if the player has accepted the quest. */ - lastUpdatedTimestampMillis?: string; + lastUpdatedTimestampMillis?: string | null; /** * The quest milestones. */ @@ -1613,19 +1613,19 @@ export namespace games_v1 { /** * The name of the quest. */ - name?: string; + name?: string | null; /** * The timestamp at which the user should be notified that the quest will end soon in milliseconds since the epoch in UTC. */ - notifyTimestampMillis?: string; + notifyTimestampMillis?: string | null; /** * The timestamp at which the quest becomes active in milliseconds since the epoch in UTC. */ - startTimestampMillis?: string; + startTimestampMillis?: string | null; /** * The state of the quest. Possible values are: - "UPCOMING": The quest is upcoming. The user can see the quest, but cannot accept it until it is open. - "OPEN": The quest is currently open and may be accepted at this time. - "ACCEPTED": The user is currently participating in this quest. - "COMPLETED": The user has completed the quest. - "FAILED": The quest was attempted but was not completed before the deadline expired. - "EXPIRED": The quest has expired and was not accepted. - "DELETED": The quest should be deleted from the local database. */ - state?: string; + state?: string | null; } /** * This is a JSON template for a Quest Criterion Contribution resource. @@ -1634,15 +1634,15 @@ export namespace games_v1 { /** * The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console. */ - formattedValue?: string; + formattedValue?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution. */ - kind?: string; + kind?: string | null; /** * The value of the contribution. */ - value?: string; + value?: string | null; } /** * This is a JSON template for a Quest Criterion resource. @@ -1659,7 +1659,7 @@ export namespace games_v1 { /** * The ID of the event the criterion corresponds to. */ - eventId?: string; + eventId?: string | null; /** * The value of the event associated with this quest at the time that the quest was accepted. This value may change if event increments that took place before the start of quest are uploaded after the quest starts. There will be no initialPlayerProgress until the player has accepted the quest. */ @@ -1667,7 +1667,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#questCriterion. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for a list of quest objects. @@ -1680,11 +1680,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#questListResponse. */ - kind?: string; + kind?: string | null; /** * Token corresponding to the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for a Quest Milestone resource. @@ -1693,7 +1693,7 @@ export namespace games_v1 { /** * The completion reward data of the milestone, represented as a Base64-encoded string. This is a developer-specified binary blob with size between 0 and 2 KB before encoding. */ - completionRewardData?: string; + completionRewardData?: string | null; /** * The criteria of the milestone. */ @@ -1701,15 +1701,15 @@ export namespace games_v1 { /** * The milestone ID. */ - id?: string; + id?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#questMilestone. */ - kind?: string; + kind?: string | null; /** * The current state of the milestone. Possible values are: - "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has not yet been claimed. - "CLAIMED" - The milestone is complete and has been claimed. - "NOT_COMPLETED" - The milestone has not yet been completed. - "NOT_STARTED" - The milestone is for a quest that has not yet been accepted. */ - state?: string; + state?: string | null; } /** * This is a JSON template for the result of checking a revision. @@ -1718,15 +1718,15 @@ export namespace games_v1 { /** * The version of the API this client revision should use when calling API methods. */ - apiVersion?: string; + apiVersion?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#revisionCheckResponse. */ - kind?: string; + kind?: string | null; /** * The result of the revision check. Possible values are: - "OK" - The revision being used is current. - "DEPRECATED" - There is currently a newer version available, but the revision being used still works. - "INVALID" - The revision being used is not supported in any released version. */ - revisionStatus?: string; + revisionStatus?: string | null; } /** * This is a JSON template for a room resource object. @@ -1735,7 +1735,7 @@ export namespace games_v1 { /** * The ID of the application being played. */ - applicationId?: string; + applicationId?: string | null; /** * Criteria for auto-matching players into this room. */ @@ -1751,15 +1751,15 @@ export namespace games_v1 { /** * This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.) */ - description?: string; + description?: string | null; /** * The ID of the participant that invited the user to the room. Not set if the user was not invited to the room. */ - inviterId?: string; + inviterId?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#room. */ - kind?: string; + kind?: string | null; /** * Details about the last update to the room. */ @@ -1771,19 +1771,19 @@ export namespace games_v1 { /** * Globally unique ID for a room. */ - roomId?: string; + roomId?: string | null; /** * The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status. */ - roomStatusVersion?: number; + roomStatusVersion?: number | null; /** * The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left. */ - status?: string; + status?: string | null; /** * The variant / mode of the application being played; can be any integer value, or left blank. */ - variant?: number; + variant?: number | null; } /** * This is a JSON template for a room auto-match criteria object. @@ -1792,19 +1792,19 @@ export namespace games_v1 { /** * A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. */ - exclusiveBitmask?: string; + exclusiveBitmask?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria. */ - kind?: string; + kind?: string | null; /** * The maximum number of players that should be added to the room by auto-matching. */ - maxAutoMatchingPlayers?: number; + maxAutoMatchingPlayers?: number | null; /** * The minimum number of players that should be added to the room by auto-matching. */ - minAutoMatchingPlayers?: number; + minAutoMatchingPlayers?: number | null; } /** * This is a JSON template for status of room automatching that is in progress. @@ -1813,11 +1813,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus. */ - kind?: string; + kind?: string | null; /** * An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete. */ - waitEstimateSeconds?: number; + waitEstimateSeconds?: number | null; } /** * This is a JSON template for the client address when setting up a room. @@ -1826,11 +1826,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress. */ - kind?: string; + kind?: string | null; /** * The XMPP address of the client on the Google Games XMPP network. */ - xmppAddress?: string; + xmppAddress?: string | null; } /** * This is a JSON template for a room creation request. @@ -1843,7 +1843,7 @@ export namespace games_v1 { /** * The capabilities that this client supports for realtime communication. */ - capabilities?: string[]; + capabilities?: string[] | null; /** * Client address for the player creating the room. */ @@ -1851,11 +1851,11 @@ export namespace games_v1 { /** * The player IDs to invite to the room. */ - invitedPlayerIds?: string[]; + invitedPlayerIds?: string[] | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest. */ - kind?: string; + kind?: string | null; /** * Network diagnostics for the client creating the room. */ @@ -1863,11 +1863,11 @@ export namespace games_v1 { /** * A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries. */ - requestId?: string; + requestId?: string | null; /** * The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible. */ - variant?: number; + variant?: number | null; } /** * This is a JSON template for a join room request. @@ -1876,7 +1876,7 @@ export namespace games_v1 { /** * The capabilities that this client supports for realtime communication. */ - capabilities?: string[]; + capabilities?: string[] | null; /** * Client address for the player joining the room. */ @@ -1884,7 +1884,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomJoinRequest. */ - kind?: string; + kind?: string | null; /** * Network diagnostics for the client joining the room. */ @@ -1897,27 +1897,27 @@ export namespace games_v1 { /** * Android network subtype. http://developer.android.com/reference/android/net/NetworkInfo.html#getSubtype() */ - androidNetworkSubtype?: number; + androidNetworkSubtype?: number | null; /** * Android network type. http://developer.android.com/reference/android/net/NetworkInfo.html#getType() */ - androidNetworkType?: number; + androidNetworkType?: number | null; /** * iOS network type as defined in Reachability.h. */ - iosNetworkType?: number; + iosNetworkType?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveDiagnostics. */ - kind?: string; + kind?: string | null; /** * The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html */ - networkOperatorCode?: string; + networkOperatorCode?: string | null; /** * The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName */ - networkOperatorName?: string; + networkOperatorName?: string | null; /** * Diagnostics about all peer sessions. */ @@ -1925,7 +1925,7 @@ export namespace games_v1 { /** * Whether or not sockets were used. */ - socketsUsed?: boolean; + socketsUsed?: boolean | null; } /** * This is a JSON template for a leave room request. @@ -1934,7 +1934,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveRequest. */ - kind?: string; + kind?: string | null; /** * Diagnostics for a player leaving the room. */ @@ -1942,7 +1942,7 @@ export namespace games_v1 { /** * Reason for leaving the match. Possible values are: - "PLAYER_LEFT" - The player chose to leave the room.. - "GAME_LEFT" - The game chose to remove the player from the room. - "REALTIME_ABANDONED" - The player switched to another application and abandoned the room. - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a connection to other peer(s). - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate with the server. - "REALTIME_SERVER_ERROR" - The client received an error response when it tried to communicate with the server. - "REALTIME_TIMEOUT" - The client timed out while waiting for a room. - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first calling Leave. - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room. - "REALTIME_GAME_CRASHED" - The game crashed. - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed. - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to enter a room. - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a new room. */ - reason?: string; + reason?: string | null; } /** * This is a JSON template for a list of rooms. @@ -1955,11 +1955,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomList. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for room modification metadata. @@ -1968,15 +1968,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification. */ - kind?: string; + kind?: string | null; /** * The timestamp at which they modified the room, in milliseconds since the epoch in UTC. */ - modifiedTimestampMillis?: string; + modifiedTimestampMillis?: string | null; /** * The ID of the participant that modified the room. */ - participantId?: string; + participantId?: string | null; } /** * This is a JSON template for an update on the status of a peer in a room. @@ -1985,31 +1985,31 @@ export namespace games_v1 { /** * The amount of time in milliseconds it took to establish connections with this peer. */ - connectionSetupLatencyMillis?: number; + connectionSetupLatencyMillis?: number | null; /** * The error code in event of a failure. Possible values are: - "P2P_FAILED" - The client failed to establish a P2P connection with the peer. - "PRESENCE_FAILED" - The client failed to register to receive P2P connections. - "RELAY_SERVER_FAILED" - The client received an error when trying to use the relay server to establish a P2P connection with the peer. */ - error?: string; + error?: string | null; /** * More detailed diagnostic message returned in event of a failure. */ - error_reason?: string; + error_reason?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatus. */ - kind?: string; + kind?: string | null; /** * The ID of the participant. */ - participantId?: string; + participantId?: string | null; /** * The status of the peer in the room. Possible values are: - "CONNECTION_ESTABLISHED" - The client established a P2P connection with the peer. - "CONNECTION_FAILED" - The client failed to establish directed presence with the peer. */ - status?: string; + status?: string | null; /** * The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer. */ - unreliableRoundtripLatencyMillis?: number; + unreliableRoundtripLatencyMillis?: number | null; } /** * This is a JSON template for an update on the status of peers in a room. @@ -2018,7 +2018,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatuses. */ - kind?: string; + kind?: string | null; /** * The updates for the peers. */ @@ -2031,7 +2031,7 @@ export namespace games_v1 { /** * True if this participant was auto-matched with the requesting player. */ - autoMatched?: boolean; + autoMatched?: boolean | null; /** * Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ @@ -2039,7 +2039,7 @@ export namespace games_v1 { /** * The capabilities which can be used when communicating with this participant. */ - capabilities?: string[]; + capabilities?: string[] | null; /** * Client address for the participant. */ @@ -2047,19 +2047,19 @@ export namespace games_v1 { /** * True if this participant is in the fully connected set of peers in the room. */ - connected?: boolean; + connected?: boolean | null; /** * An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts. */ - id?: string; + id?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant. */ - kind?: string; + kind?: string | null; /** * The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT. Possible values are: - "PLAYER_LEFT" - The player explicitly chose to leave the room. - "GAME_LEFT" - The game chose to remove the player from the room. - "ABANDONED" - The player switched to another application and abandoned the room. - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room. - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server. - "TIMEOUT" - The client timed out while waiting for players to join and connect. - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly. */ - leaveReason?: string; + leaveReason?: string | null; /** * Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ @@ -2067,7 +2067,7 @@ export namespace games_v1 { /** * The status of the participant with respect to the room. Possible values are: - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room. - "PARTICIPANT_LEFT" - The participant joined the room and then left it. */ - status?: string; + status?: string | null; } /** * This is a JSON template for the status of a room that the player has joined. @@ -2080,7 +2080,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus. */ - kind?: string; + kind?: string | null; /** * The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations. */ @@ -2088,15 +2088,15 @@ export namespace games_v1 { /** * Globally unique ID for a room. */ - roomId?: string; + roomId?: string | null; /** * The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - All joined players have left. */ - status?: string; + status?: string | null; /** * The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status. */ - statusVersion?: number; + statusVersion?: number | null; } /** * This is a JSON template for a request to submit a score to leaderboards. @@ -2105,23 +2105,23 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#scoreSubmission. */ - kind?: string; + kind?: string | null; /** * The leaderboard this score is being submitted to. */ - leaderboardId?: string; + leaderboardId?: string | null; /** * The new score being submitted. */ - score?: string; + score?: string | null; /** * Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ - scoreTag?: string; + scoreTag?: string | null; /** * Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986. */ - signature?: string; + signature?: string | null; } /** * This is a JSON template for an snapshot object. @@ -2134,43 +2134,43 @@ export namespace games_v1 { /** * The description of this snapshot. */ - description?: string; + description?: string | null; /** * The ID of the file underlying this snapshot in the Drive API. Only present if the snapshot is a view on a Drive file and the file is owned by the caller. */ - driveId?: string; + driveId?: string | null; /** * The duration associated with this snapshot, in millis. */ - durationMillis?: string; + durationMillis?: string | null; /** * The ID of the snapshot. */ - id?: string; + id?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot. */ - kind?: string; + kind?: string | null; /** * The timestamp (in millis since Unix epoch) of the last modification to this snapshot. */ - lastModifiedMillis?: string; + lastModifiedMillis?: string | null; /** * The progress value (64-bit integer set by developer) associated with this snapshot. */ - progressValue?: string; + progressValue?: string | null; /** * The title of this snapshot. */ - title?: string; + title?: string | null; /** * The type of this snapshot. Possible values are: - "SAVE_GAME" - A snapshot representing a save game. */ - type?: string; + type?: string | null; /** * The unique name provided when the snapshot was created. */ - uniqueName?: string; + uniqueName?: string | null; } /** * This is a JSON template for an image of a snapshot. @@ -2179,23 +2179,23 @@ export namespace games_v1 { /** * The height of the image. */ - height?: number; + height?: number | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage. */ - kind?: string; + kind?: string | null; /** * The MIME type of the image. */ - mime_type?: string; + mime_type?: string | null; /** * The URL of the image. This URL may be invalidated at any time and should not be cached. */ - url?: string; + url?: string | null; /** * The width of the image. */ - width?: number; + width?: number | null; } /** * This is a JSON template for a list of snapshot objects. @@ -2208,11 +2208,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotListResponse. */ - kind?: string; + kind?: string | null; /** * Token corresponding to the next page of results. If there are no more results, the token is omitted. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for an turn-based auto-match criteria object. @@ -2221,19 +2221,19 @@ export namespace games_v1 { /** * A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. */ - exclusiveBitmask?: string; + exclusiveBitmask?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. */ - kind?: string; + kind?: string | null; /** * The maximum number of players that should be added to the match by auto-matching. */ - maxAutoMatchingPlayers?: number; + maxAutoMatchingPlayers?: number | null; /** * The minimum number of players that should be added to the match by auto-matching. */ - minAutoMatchingPlayers?: number; + minAutoMatchingPlayers?: number | null; } /** * This is a JSON template for a turn-based match resource object. @@ -2242,7 +2242,7 @@ export namespace games_v1 { /** * The ID of the application being played. */ - applicationId?: string; + applicationId?: string | null; /** * Criteria for auto-matching players into this match. */ @@ -2258,15 +2258,15 @@ export namespace games_v1 { /** * This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list. */ - description?: string; + description?: string | null; /** * The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. */ - inviterId?: string; + inviterId?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. */ - kind?: string; + kind?: string | null; /** * Details about the last update to the match. */ @@ -2274,15 +2274,15 @@ export namespace games_v1 { /** * Globally unique ID for a turn-based match. */ - matchId?: string; + matchId?: string | null; /** * The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch. */ - matchNumber?: number; + matchNumber?: number | null; /** * The version of this match: an increasing counter, used to avoid out-of-date updates to the match. */ - matchVersion?: number; + matchVersion?: number | null; /** * The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. */ @@ -2290,7 +2290,7 @@ export namespace games_v1 { /** * The ID of the participant that is taking a turn. */ - pendingParticipantId?: string; + pendingParticipantId?: string | null; /** * The data / game state for the previous match; set for the first turn of rematches only. */ @@ -2298,7 +2298,7 @@ export namespace games_v1 { /** * The ID of a rematch of this match. Only set for completed matches that have been rematched. */ - rematchId?: string; + rematchId?: string | null; /** * The results reported for this match. */ @@ -2306,19 +2306,19 @@ export namespace games_v1 { /** * The status of the match. Possible values are: - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. - "MATCH_ACTIVE" - The match has started. - "MATCH_COMPLETE" - The match has finished. - "MATCH_CANCELED" - The match was canceled. - "MATCH_EXPIRED" - The match expired due to inactivity. - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. */ - status?: string; + status?: string | null; /** * The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are: - "USER_INVITED" - The user has been invited to join the match and has not responded yet. - "USER_AWAITING_TURN" - The user is waiting for their turn. - "USER_TURN" - The user has an action to take in the match. - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) */ - userMatchStatus?: string; + userMatchStatus?: string | null; /** * The variant / mode of the application being played; can be any integer value, or left blank. */ - variant?: number; + variant?: number | null; /** * The ID of another participant in the match that can be used when describing the participants the user is playing with. */ - withParticipantId?: string; + withParticipantId?: string | null; } /** * This is a JSON template for a turn-based match creation request. @@ -2331,19 +2331,19 @@ export namespace games_v1 { /** * The player ids to invite to the match. */ - invitedPlayerIds?: string[]; + invitedPlayerIds?: string[] | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchCreateRequest. */ - kind?: string; + kind?: string | null; /** * A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries. */ - requestId?: string; + requestId?: string | null; /** * The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible. */ - variant?: number; + variant?: number | null; } /** * This is a JSON template for a turn-based match data object. @@ -2352,15 +2352,15 @@ export namespace games_v1 { /** * The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. */ - data?: string; + data?: string | null; /** * True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. */ - dataAvailable?: boolean; + dataAvailable?: boolean | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for sending a turn-based match data object. @@ -2369,11 +2369,11 @@ export namespace games_v1 { /** * The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. */ - data?: string; + data?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchDataRequest. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for a list of turn-based matches. @@ -2386,11 +2386,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchList. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for turn-based match modification metadata. @@ -2399,15 +2399,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. */ - kind?: string; + kind?: string | null; /** * The timestamp at which they modified the match, in milliseconds since the epoch in UTC. */ - modifiedTimestampMillis?: string; + modifiedTimestampMillis?: string | null; /** * The ID of the participant that modified the match. */ - participantId?: string; + participantId?: string | null; } /** * This is a JSON template for a participant in a turn-based match. @@ -2416,7 +2416,7 @@ export namespace games_v1 { /** * True if this participant was auto-matched with the requesting player. */ - autoMatched?: boolean; + autoMatched?: boolean | null; /** * Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ @@ -2424,11 +2424,11 @@ export namespace games_v1 { /** * An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. */ - id?: string; + id?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. */ - kind?: string; + kind?: string | null; /** * Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ @@ -2436,7 +2436,7 @@ export namespace games_v1 { /** * The status of the participant with respect to the match. Possible values are: - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. - "PARTICIPANT_LEFT" - The participant joined the match and then left it. - "PARTICIPANT_FINISHED" - The participant finished playing in the match. - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. */ - status?: string; + status?: string | null; } /** * This is a JSON template for a rematch response. @@ -2445,7 +2445,7 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchRematch. */ - kind?: string; + kind?: string | null; /** * The old match that the rematch was created from; will be updated such that the rematchId field will point at the new match. */ @@ -2466,11 +2466,11 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchResults. */ - kind?: string; + kind?: string | null; /** * The version of the match being updated. */ - matchVersion?: number; + matchVersion?: number | null; /** * The match results for the participants in the match. */ @@ -2487,15 +2487,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchSync. */ - kind?: string; + kind?: string | null; /** * True if there were more matches available to fetch at the time the response was generated (which were not returned due to page size limits.) */ - moreAvailable?: boolean; + moreAvailable?: boolean | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for the object representing a turn. @@ -2508,15 +2508,15 @@ export namespace games_v1 { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchTurn. */ - kind?: string; + kind?: string | null; /** * The version of this match: an increasing counter, used to avoid out-of-date updates to the match. */ - matchVersion?: number; + matchVersion?: number | null; /** * The ID of the participant who should take their turn next. May be set to the current player's participant ID to update match state without changing the turn. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players. */ - pendingParticipantId?: string; + pendingParticipantId?: string | null; /** * The match results for the participants in the match. */ diff --git a/src/apis/gamesConfiguration/v1configuration.ts b/src/apis/gamesConfiguration/v1configuration.ts index 4f763ce15f6..d914d08e3bd 100644 --- a/src/apis/gamesConfiguration/v1configuration.ts +++ b/src/apis/gamesConfiguration/v1configuration.ts @@ -116,7 +116,7 @@ export namespace gamesConfiguration_v1configuration { /** * The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental. */ - achievementType?: string; + achievementType?: string | null; /** * The draft data of the achievement. */ @@ -124,15 +124,15 @@ export namespace gamesConfiguration_v1configuration { /** * The ID of the achievement. */ - id?: string; + id?: string | null; /** * The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ - initialState?: string; + initialState?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration. */ - kind?: string; + kind?: string | null; /** * The read-only published data of the achievement. */ @@ -140,11 +140,11 @@ export namespace gamesConfiguration_v1configuration { /** * Steps to unlock. Only applicable to incremental achievements. */ - stepsToUnlock?: number; + stepsToUnlock?: number | null; /** * The token for this resource. */ - token?: string; + token?: string | null; } /** * This is a JSON template for an achievement configuration detail. @@ -157,11 +157,11 @@ export namespace gamesConfiguration_v1configuration { /** * The icon url of this achievement. Writes to this field are ignored. */ - iconUrl?: string; + iconUrl?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail. */ - kind?: string; + kind?: string | null; /** * Localized strings for the achievement name. */ @@ -169,11 +169,11 @@ export namespace gamesConfiguration_v1configuration { /** * Point value for the achievement. */ - pointValue?: number; + pointValue?: number | null; /** * The sort rank of this achievement. Writes to this field are ignored. */ - sortRank?: number; + sortRank?: number | null; } /** * This is a JSON template for a ListConfigurations response. @@ -186,11 +186,11 @@ export namespace gamesConfiguration_v1configuration { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementConfigurationListResponse. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for a number affix resource. @@ -228,15 +228,15 @@ export namespace gamesConfiguration_v1configuration { /** * The curreny code string. Only used for CURRENCY format type. */ - currencyCode?: string; + currencyCode?: string | null; /** * The formatting for the number. Possible values are: - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added. - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds. - "CURRENCY" - Numbers are formatted to currency according to locale. */ - numberFormatType?: string; + numberFormatType?: string | null; /** * The number of decimal places for number. Only used for NUMERIC format type. */ - numDecimalPlaces?: number; + numDecimalPlaces?: number | null; /** * An optional suffix for the NUMERIC format type. These strings follow the same plural rules as all Android string resources. */ @@ -249,19 +249,19 @@ export namespace gamesConfiguration_v1configuration { /** * The image type for the image. */ - imageType?: string; + imageType?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#imageConfiguration. */ - kind?: string; + kind?: string | null; /** * The resource ID of resource which the image belongs to. */ - resourceId?: string; + resourceId?: string | null; /** * The url for this image. */ - url?: string; + url?: string | null; } /** * This is a JSON template for an leaderboard configuration resource. @@ -274,11 +274,11 @@ export namespace gamesConfiguration_v1configuration { /** * The ID of the leaderboard. */ - id?: string; + id?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration. */ - kind?: string; + kind?: string | null; /** * The read-only published data of the leaderboard. */ @@ -286,19 +286,19 @@ export namespace gamesConfiguration_v1configuration { /** * Maximum score that can be posted to this leaderboard. */ - scoreMax?: string; + scoreMax?: string | null; /** * Minimum score that can be posted to this leaderboard. */ - scoreMin?: string; + scoreMin?: string | null; /** * The type of the leaderboard. Possible values are: - "LARGER_IS_BETTER" - Larger scores posted are ranked higher. - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher. */ - scoreOrder?: string; + scoreOrder?: string | null; /** * The token for this resource. */ - token?: string; + token?: string | null; } /** * This is a JSON template for a leaderboard configuration detail. @@ -307,11 +307,11 @@ export namespace gamesConfiguration_v1configuration { /** * The icon url of this leaderboard. Writes to this field are ignored. */ - iconUrl?: string; + iconUrl?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail. */ - kind?: string; + kind?: string | null; /** * Localized strings for the leaderboard name. */ @@ -323,7 +323,7 @@ export namespace gamesConfiguration_v1configuration { /** * The sort rank of this leaderboard. Writes to this field are ignored. */ - sortRank?: number; + sortRank?: number | null; } /** * This is a JSON template for a ListConfigurations response. @@ -336,11 +336,11 @@ export namespace gamesConfiguration_v1configuration { /** * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardConfigurationListResponse. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for a localized string resource. @@ -349,15 +349,15 @@ export namespace gamesConfiguration_v1configuration { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString. */ - kind?: string; + kind?: string | null; /** * The locale string. */ - locale?: string; + locale?: string | null; /** * The string value. */ - value?: string; + value?: string | null; } /** * This is a JSON template for a localized string bundle resource. @@ -366,7 +366,7 @@ export namespace gamesConfiguration_v1configuration { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle. */ - kind?: string; + kind?: string | null; /** * The locale strings. */ diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index 5a956156947..c1bbab9e5ae 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -122,7 +122,7 @@ export namespace gamesManagement_v1management { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse. */ - kind?: string; + kind?: string | null; /** * The achievement reset results. */ @@ -135,11 +135,11 @@ export namespace gamesManagement_v1management { /** * The IDs of achievements to reset. */ - achievement_ids?: string[]; + achievement_ids?: string[] | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetMultipleForAllRequest. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for an achievement reset response. @@ -148,19 +148,19 @@ export namespace gamesManagement_v1management { /** * The current state of the achievement. This is the same as the initial state of the achievement. Possible values are: - "HIDDEN"- Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ - currentState?: string; + currentState?: string | null; /** * The ID of an achievement for which player state has been updated. */ - definitionId?: string; + definitionId?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse. */ - kind?: string; + kind?: string | null; /** * Flag to indicate if the requested update actually occurred. */ - updateOccurred?: boolean; + updateOccurred?: boolean | null; } /** * This is a JSON template for multiple events reset all request. @@ -169,11 +169,11 @@ export namespace gamesManagement_v1management { /** * The IDs of events to reset. */ - event_ids?: string[]; + event_ids?: string[] | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#eventsResetMultipleForAllRequest. */ - kind?: string; + kind?: string | null; } /** * This is a JSON template for metadata about a player playing a game with the currently authenticated user. @@ -182,11 +182,11 @@ export namespace gamesManagement_v1management { /** * True if the player was auto-matched with the currently authenticated user. */ - autoMatched?: boolean; + autoMatched?: boolean | null; /** * The last time the player played the game in milliseconds since the epoch in UTC. */ - timeMillis?: string; + timeMillis?: string | null; } /** * This is a JSON template for 1P/3P metadata about the player's experience. @@ -195,7 +195,7 @@ export namespace gamesManagement_v1management { /** * The current number of experience points for the player. */ - currentExperiencePoints?: string; + currentExperiencePoints?: string | null; /** * The current level of the player. */ @@ -203,7 +203,7 @@ export namespace gamesManagement_v1management { /** * The timestamp when the player was leveled up, in millis since Unix epoch UTC. */ - lastLevelUpTimestampMillis?: string; + lastLevelUpTimestampMillis?: string | null; /** * The next level of the player. If the current level is the maximum level, this should be same as the current level. */ @@ -216,15 +216,15 @@ export namespace gamesManagement_v1management { /** * The level for the user. */ - level?: number; + level?: number | null; /** * The maximum experience points for this level. */ - maxExperiencePoints?: string; + maxExperiencePoints?: string | null; /** * The minimum experience points for this level. */ - minExperiencePoints?: string; + minExperiencePoints?: string | null; } /** * This is a JSON template for the HiddenPlayer resource. @@ -233,11 +233,11 @@ export namespace gamesManagement_v1management { /** * The time this player was hidden. */ - hiddenTimeMillis?: string; + hiddenTimeMillis?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayer. */ - kind?: string; + kind?: string | null; /** * The player information. */ @@ -254,11 +254,11 @@ export namespace gamesManagement_v1management { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayerList. */ - kind?: string; + kind?: string | null; /** * The pagination token for the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * This is a JSON template for a Player resource. @@ -267,19 +267,19 @@ export namespace gamesManagement_v1management { /** * The base URL for the image that represents the player. */ - avatarImageUrl?: string; + avatarImageUrl?: string | null; /** * The url to the landscape mode player banner image. */ - bannerUrlLandscape?: string; + bannerUrlLandscape?: string | null; /** * The url to the portrait mode player banner image. */ - bannerUrlPortrait?: string; + bannerUrlPortrait?: string | null; /** * The name to display for the player. */ - displayName?: string; + displayName?: string | null; /** * An object to represent Play Game experience information for the player. */ @@ -287,7 +287,7 @@ export namespace gamesManagement_v1management { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player. */ - kind?: string; + kind?: string | null; /** * Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. */ @@ -295,15 +295,15 @@ export namespace gamesManagement_v1management { /** * An object representation of the individual components of the player's name. For some players, these fields may not be present. */ - name?: {familyName?: string; givenName?: string}; + name?: {familyName?: string; givenName?: string} | null; /** * The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. */ - originalPlayerId?: string; + originalPlayerId?: string | null; /** * The ID of the player. */ - playerId?: string; + playerId?: string | null; /** * The player's profile settings. Controls whether or not the player's profile is visible to other players. */ @@ -311,7 +311,7 @@ export namespace gamesManagement_v1management { /** * The player's title rewarded for their game activities. */ - title?: string; + title?: string | null; } /** * This is a JSON template for a list of leaderboard reset resources. @@ -320,7 +320,7 @@ export namespace gamesManagement_v1management { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse. */ - kind?: string; + kind?: string | null; /** * The leaderboard reset results. */ @@ -333,15 +333,15 @@ export namespace gamesManagement_v1management { /** * The ID of an leaderboard for which player state has been updated. */ - definitionId?: string; + definitionId?: string | null; /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse. */ - kind?: string; + kind?: string | null; /** * The time spans of the updated score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ - resetScoreTimeSpans?: string[]; + resetScoreTimeSpans?: string[] | null; } /** * This is a JSON template for profile settings @@ -350,8 +350,8 @@ export namespace gamesManagement_v1management { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#profileSettings. */ - kind?: string; - profileVisible?: boolean; + kind?: string | null; + profileVisible?: boolean | null; } /** * This is a JSON template for multiple quests reset all request. @@ -360,11 +360,11 @@ export namespace gamesManagement_v1management { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#questsResetMultipleForAllRequest. */ - kind?: string; + kind?: string | null; /** * The IDs of quests to reset. */ - quest_ids?: string[]; + quest_ids?: string[] | null; } /** * This is a JSON template for multiple scores reset all request. @@ -373,11 +373,11 @@ export namespace gamesManagement_v1management { /** * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#scoresResetMultipleForAllRequest. */ - kind?: string; + kind?: string | null; /** * The IDs of leaderboards to reset. */ - leaderboard_ids?: string[]; + leaderboard_ids?: string[] | null; } export class Resource$Achievements { diff --git a/src/apis/genomics/v1.ts b/src/apis/genomics/v1.ts index 933a9acca8f..5dc6e4d27b9 100644 --- a/src/apis/genomics/v1.ts +++ b/src/apis/genomics/v1.ts @@ -128,19 +128,19 @@ export namespace genomics_v1 { /** * The names of the disks that were created for this pipeline. */ - diskNames?: string[]; + diskNames?: string[] | null; /** * The instance on which the operation is running. */ - instanceName?: string; + instanceName?: string | null; /** * The machine type of the instance. */ - machineType?: string; + machineType?: string | null; /** * The availability zone in which the instance resides. */ - zone?: string; + zone?: string | null; } /** * An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user. @@ -149,7 +149,7 @@ export namespace genomics_v1 { /** * The numeric ID of the action that started the container. */ - actionId?: number; + actionId?: number | null; } /** * An event generated when a container starts. @@ -158,15 +158,15 @@ export namespace genomics_v1 { /** * The numeric ID of the action that started this container. */ - actionId?: number; + actionId?: number | null; /** * The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. */ - ipAddress?: string; + ipAddress?: string | null; /** * The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition. */ - portMappings?: {[key: string]: number}; + portMappings?: {[key: string]: number} | null; } /** * An event generated when a container exits. @@ -175,15 +175,15 @@ export namespace genomics_v1 { /** * The numeric ID of the action that started this container. */ - actionId?: number; + actionId?: number | null; /** * The exit status of the container. */ - exitStatus?: number; + exitStatus?: number | null; /** * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ - stderr?: string; + stderr?: string | null; } /** * An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run. @@ -192,11 +192,11 @@ export namespace genomics_v1 { /** * A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). */ - cause?: string; + cause?: string | null; /** * If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present. */ - metrics?: string[]; + metrics?: 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 `{}`. @@ -209,15 +209,15 @@ export namespace genomics_v1 { /** * A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field. */ - description?: string; + description?: string | null; /** * Machine-readable details about the event. */ - details?: {[key: string]: any}; + details?: {[key: string]: any} | null; /** * The time at which the event occurred. */ - timestamp?: string; + timestamp?: string | null; } /** * An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event. @@ -226,11 +226,11 @@ export namespace genomics_v1 { /** * The human-readable description of the cause of the failure. */ - cause?: string; + cause?: string | null; /** * The Google standard error code that best describes this failure. */ - code?: string; + code?: string | null; } /** * The response message for Operations.ListOperations. @@ -239,7 +239,7 @@ export namespace genomics_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -252,7 +252,7 @@ export namespace genomics_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -260,15 +260,15 @@ export namespace genomics_v1 { /** * An OperationMetadata or Metadata object. This will always be returned with the Operation. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ - name?: string; + name?: string | null; /** * An Empty object. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * An event that occurred during an Operation. @@ -277,15 +277,15 @@ export namespace genomics_v1 { /** * Required description of event. */ - description?: string; + description?: string | null; /** * Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time. */ - endTime?: string; + endTime?: string | null; /** * Optional time of when event started. */ - startTime?: string; + startTime?: string | null; } /** * Metadata describing an Operation. @@ -294,15 +294,15 @@ export namespace genomics_v1 { /** * This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation. */ - clientId?: string; + clientId?: string | null; /** * The time at which the job was submitted to the Genomics service. */ - createTime?: string; + createTime?: string | null; /** * The time at which the job stopped running. */ - endTime?: string; + endTime?: string | null; /** * Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export. */ @@ -310,23 +310,23 @@ export namespace genomics_v1 { /** * Optionally provided by the caller when submitting the request that creates the operation. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The Google Cloud Project in which the job is scoped. */ - projectId?: string; + projectId?: string | null; /** * The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Runtime metadata on this Operation. */ - runtimeMetadata?: {[key: string]: any}; + runtimeMetadata?: {[key: string]: any} | null; /** * The time at which the job began to run. */ - startTime?: string; + startTime?: string | null; } /** * An event generated when the worker starts pulling an image. @@ -335,7 +335,7 @@ export namespace genomics_v1 { /** * The URI of the image that was pulled. */ - imageUri?: string; + imageUri?: string | null; } /** * An event generated when the worker stops pulling an image. @@ -344,7 +344,7 @@ export namespace genomics_v1 { /** * The URI of the image that was pulled. */ - imageUri?: string; + imageUri?: string | null; } /** * The response to the RunPipeline method, returned in the operation's result field on success. @@ -366,15 +366,15 @@ export namespace genomics_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped. @@ -383,11 +383,11 @@ export namespace genomics_v1 { /** * The numeric ID of the action that started the container. */ - actionId?: number; + actionId?: number | null; /** * The exit status of the container. */ - exitStatus?: number; + exitStatus?: number | null; } /** * An event generated after a worker VM has been assigned to run the pipeline. @@ -396,15 +396,15 @@ export namespace genomics_v1 { /** * The worker's instance name. */ - instance?: string; + instance?: string | null; /** * The machine type that was assigned for the worker. */ - machineType?: string; + machineType?: string | null; /** * The zone the worker is running in. */ - zone?: string; + zone?: string | null; } /** * An event generated when the worker VM that was assigned to the pipeline has been released (deleted). @@ -413,11 +413,11 @@ export namespace genomics_v1 { /** * The worker's instance name. */ - instance?: string; + instance?: string | null; /** * The zone the worker was running in. */ - zone?: string; + zone?: string | null; } export class Resource$Operations { diff --git a/src/apis/genomics/v1alpha2.ts b/src/apis/genomics/v1alpha2.ts index 28a1102588d..48b27918266 100644 --- a/src/apis/genomics/v1alpha2.ts +++ b/src/apis/genomics/v1alpha2.ts @@ -130,19 +130,19 @@ export namespace genomics_v1alpha2 { /** * The names of the disks that were created for this pipeline. */ - diskNames?: string[]; + diskNames?: string[] | null; /** * The instance on which the operation is running. */ - instanceName?: string; + instanceName?: string | null; /** * The machine type of the instance. */ - machineType?: string; + machineType?: string | null; /** * The availability zone in which the instance resides. */ - zone?: string; + zone?: string | null; } /** * An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user. @@ -151,7 +151,7 @@ export namespace genomics_v1alpha2 { /** * The numeric ID of the action that started the container. */ - actionId?: number; + actionId?: number | null; } /** * An event generated when a container starts. @@ -160,15 +160,15 @@ export namespace genomics_v1alpha2 { /** * The numeric ID of the action that started this container. */ - actionId?: number; + actionId?: number | null; /** * The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. */ - ipAddress?: string; + ipAddress?: string | null; /** * The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition. */ - portMappings?: {[key: string]: number}; + portMappings?: {[key: string]: number} | null; } /** * An event generated when a container exits. @@ -177,28 +177,28 @@ export namespace genomics_v1alpha2 { /** * The numeric ID of the action that started this container. */ - actionId?: number; + actionId?: number | null; /** * The exit status of the container. */ - exitStatus?: number; + exitStatus?: number | null; /** * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ - stderr?: string; + stderr?: string | null; } /** * Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users. */ export interface Schema$ControllerConfig { - cmd?: string; - disks?: {[key: string]: string}; - gcsLogPath?: string; - gcsSinks?: {[key: string]: Schema$RepeatedString}; - gcsSources?: {[key: string]: Schema$RepeatedString}; - image?: string; - machineType?: string; - vars?: {[key: string]: string}; + cmd?: string | null; + disks?: {[key: string]: string} | null; + gcsLogPath?: string | null; + gcsSinks?: {[key: string]: Schema$RepeatedString} | null; + gcsSources?: {[key: string]: Schema$RepeatedString} | null; + image?: string | null; + machineType?: string | null; + vars?: {[key: string]: string} | null; } /** * An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run. @@ -207,11 +207,11 @@ export namespace genomics_v1alpha2 { /** * A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). */ - cause?: string; + cause?: string | null; /** * If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present. */ - metrics?: string[]; + metrics?: string[] | null; } /** * A Google Compute Engine disk resource specification. @@ -220,31 +220,31 @@ export namespace genomics_v1alpha2 { /** * Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to. */ - autoDelete?: boolean; + autoDelete?: boolean | null; /** * Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`. */ - mountPoint?: string; + mountPoint?: string | null; /** * Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use. */ - name?: string; + name?: string | null; /** * Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time. */ - readOnly?: boolean; + readOnly?: boolean | null; /** * The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD. */ - sizeGb?: number; + sizeGb?: number | null; /** * The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details. */ - source?: string; + source?: string | null; /** * Required. The type of the disk to create. */ - type?: string; + type?: string | null; } /** * The Docker execuctor specification. @@ -253,11 +253,11 @@ export namespace genomics_v1alpha2 { /** * Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384. */ - cmd?: string; + cmd?: string | null; /** * Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image. */ - imageName?: string; + imageName?: 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 `{}`. @@ -270,15 +270,15 @@ export namespace genomics_v1alpha2 { /** * A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field. */ - description?: string; + description?: string | null; /** * Machine-readable details about the event. */ - details?: {[key: string]: any}; + details?: {[key: string]: any} | null; /** * The time at which the event occurred. */ - timestamp?: string; + timestamp?: string | null; } /** * An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event. @@ -287,11 +287,11 @@ export namespace genomics_v1alpha2 { /** * The human-readable description of the cause of the failure. */ - cause?: string; + cause?: string | null; /** * The Google standard error code that best describes this failure. */ - code?: string; + code?: string | null; } /** * The response message for Operations.ListOperations. @@ -300,7 +300,7 @@ export namespace genomics_v1alpha2 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -313,7 +313,7 @@ export namespace genomics_v1alpha2 { /** * The token to use to get the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The matched pipelines. */ @@ -326,11 +326,11 @@ export namespace genomics_v1alpha2 { /** * Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`. */ - disk?: string; + disk?: string | null; /** * Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt, */ - path?: string; + path?: string | null; } /** * The logging options for the pipeline run. @@ -339,7 +339,7 @@ export namespace genomics_v1alpha2 { /** * The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`. */ - gcsPath?: string; + gcsPath?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -348,7 +348,7 @@ export namespace genomics_v1alpha2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -356,15 +356,15 @@ export namespace genomics_v1alpha2 { /** * An OperationMetadata or Metadata object. This will always be returned with the Operation. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ - name?: string; + name?: string | null; /** * An Empty object. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * An event that occurred during an Operation. @@ -373,15 +373,15 @@ export namespace genomics_v1alpha2 { /** * Required description of event. */ - description?: string; + description?: string | null; /** * Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time. */ - endTime?: string; + endTime?: string | null; /** * Optional time of when event started. */ - startTime?: string; + startTime?: string | null; } /** * Metadata describing an Operation. @@ -390,15 +390,15 @@ export namespace genomics_v1alpha2 { /** * This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation. */ - clientId?: string; + clientId?: string | null; /** * The time at which the job was submitted to the Genomics service. */ - createTime?: string; + createTime?: string | null; /** * The time at which the job stopped running. */ - endTime?: string; + endTime?: string | null; /** * Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export. */ @@ -406,23 +406,23 @@ export namespace genomics_v1alpha2 { /** * Optionally provided by the caller when submitting the request that creates the operation. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The Google Cloud Project in which the job is scoped. */ - projectId?: string; + projectId?: string | null; /** * The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Runtime metadata on this Operation. */ - runtimeMetadata?: {[key: string]: any}; + runtimeMetadata?: {[key: string]: any} | null; /** * The time at which the job began to run. */ - startTime?: string; + startTime?: string | null; } /** * The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method. @@ -431,7 +431,7 @@ export namespace genomics_v1alpha2 { /** * User-specified description. */ - description?: string; + description?: string | null; /** * Specifies the docker run information. */ @@ -443,7 +443,7 @@ export namespace genomics_v1alpha2 { /** * Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines. */ - name?: string; + name?: string | null; /** * Output parameters of the pipeline. */ @@ -451,11 +451,11 @@ export namespace genomics_v1alpha2 { /** * Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline. */ - pipelineId?: string; + pipelineId?: string | null; /** * Required. The project in which to create the pipeline. The caller must have WRITE access. */ - projectId?: string; + projectId?: string | null; /** * Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb */ @@ -468,11 +468,11 @@ export namespace genomics_v1alpha2 { /** * The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`. */ - defaultValue?: string; + defaultValue?: string | null; /** * Human-readable description. */ - description?: string; + description?: string | null; /** * If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be. */ @@ -480,7 +480,7 @@ export namespace genomics_v1alpha2 { /** * Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline. */ - name?: string; + name?: string | null; } /** * The system resources for the pipeline run. @@ -489,15 +489,15 @@ export namespace genomics_v1alpha2 { /** * Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. */ - acceleratorCount?: string; + acceleratorCount?: string | null; /** * Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types. */ - acceleratorType?: string; + acceleratorType?: string | null; /** * The size of the boot disk. Defaults to 10 (GB). */ - bootDiskSizeGb?: number; + bootDiskSizeGb?: number | null; /** * Disks to attach. */ @@ -505,23 +505,23 @@ export namespace genomics_v1alpha2 { /** * The minimum number of cores to use. Defaults to 1. */ - minimumCpuCores?: number; + minimumCpuCores?: number | null; /** * The minimum amount of RAM to use. Defaults to 3.75 (GB) */ - minimumRamGb?: number; + minimumRamGb?: number | null; /** * Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips). */ - noAddress?: boolean; + noAddress?: boolean | null; /** * Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. */ - preemptible?: boolean; + preemptible?: boolean | null; /** * List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen. */ - zones?: string[]; + zones?: string[] | null; } /** * An event generated when the worker starts pulling an image. @@ -530,7 +530,7 @@ export namespace genomics_v1alpha2 { /** * The URI of the image that was pulled. */ - imageUri?: string; + imageUri?: string | null; } /** * An event generated when the worker stops pulling an image. @@ -539,10 +539,10 @@ export namespace genomics_v1alpha2 { /** * The URI of the image that was pulled. */ - imageUri?: string; + imageUri?: string | null; } export interface Schema$RepeatedString { - values?: string[]; + values?: string[] | null; } /** * The pipeline run arguments. @@ -551,19 +551,19 @@ export namespace genomics_v1alpha2 { /** * This field is deprecated. Use `labels` instead. Client-specified pipeline operation identifier. */ - clientId?: string; + clientId?: string | null; /** * Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. */ - inputs?: {[key: string]: string}; + inputs?: {[key: string]: string} | null; /** * How long to keep the VM up after a failure (for example docker command failed, copying input or output files failed, etc). While the VM is up, one can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day. */ - keepVmAliveOnFailureDuration?: string; + keepVmAliveOnFailureDuration?: string | null; /** * Labels to apply to this pipeline run. Labels will also be applied to compute resources (VM, disks) created by this pipeline run. When listing operations, operations can filtered by labels. Label keys may not be empty; label values may be empty. Non-empty labels must be 1-63 characters long, and comply with [RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). 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. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. Logging options. Used by the service to communicate results to the user. */ @@ -571,11 +571,11 @@ export namespace genomics_v1alpha2 { /** * Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. */ - outputs?: {[key: string]: string}; + outputs?: {[key: string]: string} | null; /** * Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used. */ - projectId?: string; + projectId?: string | null; /** * Specifies resource requirements/overrides for the pipeline run. */ @@ -600,7 +600,7 @@ export namespace genomics_v1alpha2 { /** * The already created pipeline to run. */ - pipelineId?: string; + pipelineId?: string | null; } /** * The response to the RunPipeline method, returned in the operation's result field on success. @@ -622,21 +622,21 @@ export namespace genomics_v1alpha2 { /** * Email address of the service account. Defaults to `default`, which uses the compute service account associated with the project. */ - email?: string; + email?: string | null; /** * List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write */ - scopes?: string[]; + scopes?: string[] | null; } /** * Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users. */ export interface Schema$SetOperationStatusRequest { - errorCode?: string; - errorMessage?: string; - operationId?: string; + errorCode?: string | null; + errorMessage?: string | null; + operationId?: string | null; timestampEvents?: Schema$TimestampEvent[]; - validationToken?: string; + validationToken?: 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). @@ -645,15 +645,15 @@ export namespace genomics_v1alpha2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Stores the list of events and times they occured for major events in job execution. @@ -662,11 +662,11 @@ export namespace genomics_v1alpha2 { /** * String indicating the type of event */ - description?: string; + description?: string | null; /** * The time this event occured. */ - timestamp?: string; + timestamp?: string | null; } /** * An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped. @@ -675,11 +675,11 @@ export namespace genomics_v1alpha2 { /** * The numeric ID of the action that started the container. */ - actionId?: number; + actionId?: number | null; /** * The exit status of the container. */ - exitStatus?: number; + exitStatus?: number | null; } /** * An event generated after a worker VM has been assigned to run the pipeline. @@ -688,15 +688,15 @@ export namespace genomics_v1alpha2 { /** * The worker's instance name. */ - instance?: string; + instance?: string | null; /** * The machine type that was assigned for the worker. */ - machineType?: string; + machineType?: string | null; /** * The zone the worker is running in. */ - zone?: string; + zone?: string | null; } /** * An event generated when the worker VM that was assigned to the pipeline has been released (deleted). @@ -705,11 +705,11 @@ export namespace genomics_v1alpha2 { /** * The worker's instance name. */ - instance?: string; + instance?: string | null; /** * The zone the worker was running in. */ - zone?: string; + zone?: string | null; } export class Resource$Operations { diff --git a/src/apis/genomics/v2alpha1.ts b/src/apis/genomics/v2alpha1.ts index a1b502d57fb..6f785c0b5d4 100644 --- a/src/apis/genomics/v2alpha1.ts +++ b/src/apis/genomics/v2alpha1.ts @@ -128,11 +128,11 @@ export namespace genomics_v2alpha1 { /** * How many accelerators of this type to attach. */ - count?: string; + count?: string | null; /** * The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes. */ - type?: string; + type?: string | null; } /** * Specifies a single action that runs a Docker container. @@ -141,7 +141,7 @@ export namespace genomics_v2alpha1 { /** * If specified, overrides the `CMD` specified in the container. If the container also has an `ENTRYPOINT` the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container. */ - commands?: string[]; + commands?: string[] | null; /** * If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys. */ @@ -149,23 +149,23 @@ export namespace genomics_v2alpha1 { /** * If specified, overrides the `ENTRYPOINT` specified in the container. */ - entrypoint?: string; + entrypoint?: string | null; /** * The environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed. */ - environment?: {[key: string]: string}; + environment?: {[key: string]: string} | null; /** * The set of flags to apply to this action. */ - flags?: string[]; + flags?: string[] | null; /** * Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.genomics.v2alpha1.Action.credentials field. */ - imageUri?: string; + imageUri?: string | null; /** * Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under `/google` that contains log files and other operational components. <ul> <li><code>/google/logs</code> All logs written during the pipeline execution.</li> <li><code>/google/logs/output</code> The combined standard output and standard error of all actions run as part of the pipeline execution.</li> <li><code>/google/logs/action/x/stdout</code> The complete contents of each individual action's standard output.</li> <li><code>/google/logs/action/x/stderr</code> The complete contents of each individual action's standard error output.</li> </ul> */ @@ -173,19 +173,19 @@ export namespace genomics_v2alpha1 { /** * An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hyphen. */ - name?: string; + name?: string | null; /** * An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used. */ - pidNamespace?: string; + pidNamespace?: string | null; /** * A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata. */ - portMappings?: {[key: string]: number}; + portMappings?: {[key: string]: number} | null; /** * The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. */ - timeout?: string; + timeout?: string | null; } /** * The request message for Operations.CancelOperation. @@ -202,7 +202,7 @@ export namespace genomics_v2alpha1 { /** * A workflow specific event occurred. */ - event?: {[key: string]: any}; + event?: {[key: string]: any} | null; /** * The operation has finished with the given result. */ @@ -219,11 +219,11 @@ export namespace genomics_v2alpha1 { /** * The deadline by which the worker must request an extension. The backend will allow for network transmission time and other delays, but the worker must attempt to transmit the extension request no later than the deadline. */ - deadline?: string; + deadline?: string | null; /** * The metadata that describes the operation assigned to the worker. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; } /** * Describes a Compute Engine resource that is being managed by a running pipeline. @@ -232,19 +232,19 @@ export namespace genomics_v2alpha1 { /** * The names of the disks that were created for this pipeline. */ - diskNames?: string[]; + diskNames?: string[] | null; /** * The instance on which the operation is running. */ - instanceName?: string; + instanceName?: string | null; /** * The machine type of the instance. */ - machineType?: string; + machineType?: string | null; /** * The availability zone in which the instance resides. */ - zone?: string; + zone?: string | null; } /** * An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user. @@ -253,7 +253,7 @@ export namespace genomics_v2alpha1 { /** * The numeric ID of the action that started the container. */ - actionId?: number; + actionId?: number | null; } /** * An event generated when a container starts. @@ -262,15 +262,15 @@ export namespace genomics_v2alpha1 { /** * The numeric ID of the action that started this container. */ - actionId?: number; + actionId?: number | null; /** * The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. */ - ipAddress?: string; + ipAddress?: string | null; /** * The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition. */ - portMappings?: {[key: string]: number}; + portMappings?: {[key: string]: number} | null; } /** * An event generated when a container exits. @@ -279,15 +279,15 @@ export namespace genomics_v2alpha1 { /** * The numeric ID of the action that started this container. */ - actionId?: number; + actionId?: number | null; /** * The exit status of the container. */ - exitStatus?: number; + exitStatus?: number | null; /** * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ - stderr?: string; + stderr?: string | null; } /** * An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run. @@ -296,11 +296,11 @@ export namespace genomics_v2alpha1 { /** * A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). */ - cause?: string; + cause?: string | null; /** * If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present. */ - metrics?: string[]; + metrics?: string[] | null; } /** * Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. @@ -309,19 +309,19 @@ export namespace genomics_v2alpha1 { /** * A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hyphen. */ - name?: string; + name?: string | null; /** * The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance. */ - sizeGb?: number; + sizeGb?: number | null; /** * An optional image to put on the disk before attaching it to the VM. */ - sourceImage?: string; + sourceImage?: string | null; /** * The Compute Engine disk type. If unspecified, `pd-standard` is used. */ - type?: string; + type?: string | null; } /** * The status of a disk on a VM. @@ -330,11 +330,11 @@ export namespace genomics_v2alpha1 { /** * Free disk space. */ - freeSpaceBytes?: string; + freeSpaceBytes?: string | null; /** * Total disk space. */ - totalSpaceBytes?: string; + totalSpaceBytes?: 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 `{}`. @@ -347,15 +347,15 @@ export namespace genomics_v2alpha1 { /** * A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field. */ - description?: string; + description?: string | null; /** * Machine-readable details about the event. */ - details?: {[key: string]: any}; + details?: {[key: string]: any} | null; /** * The time at which the event occurred. */ - timestamp?: string; + timestamp?: string | null; } /** * An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event. @@ -364,11 +364,11 @@ export namespace genomics_v2alpha1 { /** * The human-readable description of the cause of the failure. */ - cause?: string; + cause?: string | null; /** * The Google standard error code that best describes this failure. */ - code?: string; + code?: string | null; } /** * The response message for Operations.ListOperations. @@ -377,7 +377,7 @@ export namespace genomics_v2alpha1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -390,11 +390,11 @@ export namespace genomics_v2alpha1 { /** * The time at which the operation was created by the API. */ - createTime?: string; + createTime?: string | null; /** * The time at which execution was completed and resources were cleaned up. */ - endTime?: string; + endTime?: string | null; /** * The list of events that have happened so far during the execution of this operation. */ @@ -402,7 +402,7 @@ export namespace genomics_v2alpha1 { /** * The user-defined labels associated with this operation. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The pipeline this operation represents. */ @@ -410,7 +410,7 @@ export namespace genomics_v2alpha1 { /** * The first time at which resources were allocated to execute the pipeline. */ - startTime?: string; + startTime?: string | null; } /** * Carries information about a particular disk mount inside a container. @@ -419,15 +419,15 @@ export namespace genomics_v2alpha1 { /** * The name of the disk to mount, as specified in the resources section. */ - disk?: string; + disk?: string | null; /** * The path to mount the disk inside the container. */ - path?: string; + path?: string | null; /** * If true, the disk is mounted read-only inside the container. */ - readOnly?: boolean; + readOnly?: boolean | null; } /** * VM networking options. @@ -436,15 +436,15 @@ export namespace genomics_v2alpha1 { /** * The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used. */ - name?: string; + name?: string | null; /** * If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with `regions/x/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in. */ - subnetwork?: string; + subnetwork?: string | null; /** * If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information. */ - usePrivateAddress?: boolean; + usePrivateAddress?: boolean | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -453,7 +453,7 @@ export namespace genomics_v2alpha1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -461,15 +461,15 @@ export namespace genomics_v2alpha1 { /** * An OperationMetadata or Metadata object. This will always be returned with the Operation. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ - name?: string; + name?: string | null; /** * An Empty object. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * An event that occurred during an Operation. @@ -478,15 +478,15 @@ export namespace genomics_v2alpha1 { /** * Required description of event. */ - description?: string; + description?: string | null; /** * Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time. */ - endTime?: string; + endTime?: string | null; /** * Optional time of when event started. */ - startTime?: string; + startTime?: string | null; } /** * Metadata describing an Operation. @@ -495,15 +495,15 @@ export namespace genomics_v2alpha1 { /** * This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation. */ - clientId?: string; + clientId?: string | null; /** * The time at which the job was submitted to the Genomics service. */ - createTime?: string; + createTime?: string | null; /** * The time at which the job stopped running. */ - endTime?: string; + endTime?: string | null; /** * Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export. */ @@ -511,23 +511,23 @@ export namespace genomics_v2alpha1 { /** * Optionally provided by the caller when submitting the request that creates the operation. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The Google Cloud Project in which the job is scoped. */ - projectId?: string; + projectId?: string | null; /** * The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Runtime metadata on this Operation. */ - runtimeMetadata?: {[key: string]: any}; + runtimeMetadata?: {[key: string]: any} | null; /** * The time at which the job began to run. */ - startTime?: string; + startTime?: string | null; } /** * Specifies a series of actions to execute, expressed as Docker containers. @@ -540,7 +540,7 @@ export namespace genomics_v2alpha1 { /** * The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value). */ - environment?: {[key: string]: string}; + environment?: {[key: string]: string} | null; /** * The resources required for execution. */ @@ -548,7 +548,7 @@ export namespace genomics_v2alpha1 { /** * The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. */ - timeout?: string; + timeout?: string | null; } /** * An event generated when the worker starts pulling an image. @@ -557,7 +557,7 @@ export namespace genomics_v2alpha1 { /** * The URI of the image that was pulled. */ - imageUri?: string; + imageUri?: string | null; } /** * An event generated when the worker stops pulling an image. @@ -566,7 +566,7 @@ export namespace genomics_v2alpha1 { /** * The URI of the image that was pulled. */ - imageUri?: string; + imageUri?: string | null; } /** * The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail. @@ -575,11 +575,11 @@ export namespace genomics_v2alpha1 { /** * The project ID to allocate resources in. */ - projectId?: string; + projectId?: string | null; /** * The list of regions allowed for VM allocation. If set, the `zones` field must not be set. */ - regions?: string[]; + regions?: string[] | null; /** * The virtual machine specification. */ @@ -587,7 +587,7 @@ export namespace genomics_v2alpha1 { /** * The list of zones allowed for VM allocation. If set, the `regions` field must not be set. */ - zones?: string[]; + zones?: string[] | null; } /** * The arguments to the `RunPipeline` method. The requesting user must have the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service account or the request will fail. @@ -596,7 +596,7 @@ export namespace genomics_v2alpha1 { /** * User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`). */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. The description of the pipeline to run. */ @@ -622,11 +622,11 @@ export namespace genomics_v2alpha1 { /** * The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited. */ - cipherText?: string; + cipherText?: string | null; /** * The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key. */ - keyName?: string; + keyName?: string | null; } /** * Carries information about a Google Cloud service account. @@ -635,11 +635,11 @@ export namespace genomics_v2alpha1 { /** * Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. */ - email?: string; + email?: string | null; /** * List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default. */ - scopes?: string[]; + scopes?: string[] | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -648,15 +648,15 @@ export namespace genomics_v2alpha1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped. @@ -665,11 +665,11 @@ export namespace genomics_v2alpha1 { /** * The numeric ID of the action that started the container. */ - actionId?: number; + actionId?: number | null; /** * The exit status of the container. */ - exitStatus?: number; + exitStatus?: number | null; } /** * Carries information about a Compute Engine VM resource. @@ -682,15 +682,15 @@ export namespace genomics_v2alpha1 { /** * The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used. */ - bootDiskSizeGb?: number; + bootDiskSizeGb?: number | null; /** * The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is `projects/cos-cloud/global/images/family/cos-stable`, which selects the latest stable release of Container-Optimized OS. This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value `projects/cos-cloud/global/images/family/cos-beta`. */ - bootImage?: string; + bootImage?: string | null; /** * The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. */ - cpuPlatform?: string; + cpuPlatform?: string | null; /** * The list of disks to create and attach to the VM. */ @@ -698,15 +698,15 @@ export namespace genomics_v2alpha1 { /** * Whether Stackdriver monitoring should be enabled on the VM. */ - enableStackdriverMonitoring?: boolean; + enableStackdriverMonitoring?: boolean | null; /** * Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the [name and value restrictions](https://cloud.google.com/compute/docs/labeling-resources) on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as "n1-standard-1") or a custom machine type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "4096" indicates the memory in MB). See [Creating an instance with a custom machine type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) for more specifications on creating a custom machine type. */ - machineType?: string; + machineType?: string | null; /** * The VM network configuration. */ @@ -714,11 +714,11 @@ export namespace genomics_v2alpha1 { /** * The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage. */ - nvidiaDriverVersion?: string; + nvidiaDriverVersion?: string | null; /** * If true, allocate a preemptible VM. */ - preemptible?: boolean; + preemptible?: boolean | null; /** * The service account to install on the VM. This account does not need any permissions other than those required by the pipeline. */ @@ -731,15 +731,15 @@ export namespace genomics_v2alpha1 { /** * The worker's instance name. */ - instance?: string; + instance?: string | null; /** * The machine type that was assigned for the worker. */ - machineType?: string; + machineType?: string | null; /** * The zone the worker is running in. */ - zone?: string; + zone?: string | null; } /** * An event generated when the worker VM that was assigned to the pipeline has been released (deleted). @@ -748,11 +748,11 @@ export namespace genomics_v2alpha1 { /** * The worker's instance name. */ - instance?: string; + instance?: string | null; /** * The zone the worker was running in. */ - zone?: string; + zone?: string | null; } /** * The status of the worker VM. @@ -761,7 +761,7 @@ export namespace genomics_v2alpha1 { /** * Status of attached disks. */ - attachedDisks?: {[key: string]: Schema$DiskStatus}; + attachedDisks?: {[key: string]: Schema$DiskStatus} | null; /** * Status of the boot disk. */ @@ -769,15 +769,15 @@ export namespace genomics_v2alpha1 { /** * Free RAM. */ - freeRamBytes?: string; + freeRamBytes?: string | null; /** * Total RAM. */ - totalRamBytes?: string; + totalRamBytes?: string | null; /** * System uptime. */ - uptimeSeconds?: string; + uptimeSeconds?: string | null; } export class Resource$Pipelines { diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 169d43d65e4..ea3555d038f 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -108,35 +108,35 @@ export namespace gmail_v1 { /** * The state that a message should be left in after it has been forwarded. */ - disposition?: string; + disposition?: string | null; /** * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. */ - emailAddress?: string; + emailAddress?: string | null; /** * Whether all incoming mail is automatically forwarded to another address. */ - enabled?: boolean; + enabled?: boolean | null; } export interface Schema$BatchDeleteMessagesRequest { /** * The IDs of the messages to delete. */ - ids?: string[]; + ids?: string[] | null; } export interface Schema$BatchModifyMessagesRequest { /** * A list of label IDs to add to messages. */ - addLabelIds?: string[]; + addLabelIds?: string[] | null; /** * The IDs of the messages to modify. There is a limit of 1000 ids per request. */ - ids?: string[]; + ids?: string[] | null; /** * A list of label IDs to remove from messages. */ - removeLabelIds?: string[]; + removeLabelIds?: string[] | null; } /** * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates. @@ -145,11 +145,11 @@ export namespace gmail_v1 { /** * The email address of the delegate. */ - delegateEmail?: string; + delegateEmail?: string | null; /** * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. */ - verificationStatus?: string; + verificationStatus?: string | null; } /** * A draft email in the user's mailbox. @@ -158,7 +158,7 @@ export namespace gmail_v1 { /** * The immutable ID of the draft. */ - id?: string; + id?: string | null; /** * The message content of the draft. */ @@ -179,7 +179,7 @@ export namespace gmail_v1 { /** * The server assigned ID of the filter. */ - id?: string; + id?: string | null; } /** * A set of actions to perform on a message. @@ -188,15 +188,15 @@ export namespace gmail_v1 { /** * List of labels to add to the message. */ - addLabelIds?: string[]; + addLabelIds?: string[] | null; /** * Email address that the message should be forwarded to. */ - forward?: string; + forward?: string | null; /** * List of labels to remove from the message. */ - removeLabelIds?: string[]; + removeLabelIds?: string[] | null; } /** * Message matching criteria. @@ -205,39 +205,39 @@ export namespace gmail_v1 { /** * Whether the response should exclude chats. */ - excludeChats?: boolean; + excludeChats?: boolean | null; /** * The sender's display name or email address. */ - from?: string; + from?: string | null; /** * Whether the message has any attachment. */ - hasAttachment?: boolean; + hasAttachment?: boolean | null; /** * Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". */ - negatedQuery?: string; + negatedQuery?: string | null; /** * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". */ - query?: string; + query?: string | null; /** * The size of the entire RFC822 message in bytes, including all headers and attachments. */ - size?: number; + size?: number | null; /** * How the message size in bytes should be in relation to the size field. */ - sizeComparison?: string; + sizeComparison?: string | null; /** * Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed. */ - subject?: string; + subject?: string | null; /** * The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive. */ - to?: string; + to?: string | null; } /** * Settings for a forwarding address. @@ -246,11 +246,11 @@ export namespace gmail_v1 { /** * An email address to which messages can be forwarded. */ - forwardingEmail?: string; + forwardingEmail?: string | null; /** * Indicates whether this address has been verified and is usable for forwarding. Read-only. */ - verificationStatus?: string; + verificationStatus?: string | null; } /** * A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways. @@ -259,7 +259,7 @@ export namespace gmail_v1 { /** * The mailbox sequence ID. */ - id?: string; + id?: string | null; /** * Labels added to messages in this history record. */ @@ -285,14 +285,14 @@ export namespace gmail_v1 { /** * Label IDs added to the message. */ - labelIds?: string[]; + labelIds?: string[] | null; message?: Schema$Message; } export interface Schema$HistoryLabelRemoved { /** * Label IDs removed from the message. */ - labelIds?: string[]; + labelIds?: string[] | null; message?: Schema$Message; } export interface Schema$HistoryMessageAdded { @@ -308,19 +308,19 @@ export namespace gmail_v1 { /** * If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted. */ - autoExpunge?: boolean; + autoExpunge?: boolean | null; /** * Whether IMAP is enabled for the account. */ - enabled?: boolean; + enabled?: boolean | null; /** * The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder. */ - expungeBehavior?: string; + expungeBehavior?: string | null; /** * An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit. */ - maxFolderSize?: number; + maxFolderSize?: number | null; } /** * Labels are used to categorize messages and threads within the user's mailbox. @@ -333,49 +333,49 @@ export namespace gmail_v1 { /** * The immutable ID of the label. */ - id?: string; + id?: string | null; /** * The visibility of the label in the label list in the Gmail web interface. */ - labelListVisibility?: string; + labelListVisibility?: string | null; /** * The visibility of the label in the message list in the Gmail web interface. */ - messageListVisibility?: string; + messageListVisibility?: string | null; /** * The total number of messages with the label. */ - messagesTotal?: number; + messagesTotal?: number | null; /** * The number of unread messages with the label. */ - messagesUnread?: number; + messagesUnread?: number | null; /** * The display name of the label. */ - name?: string; + name?: string | null; /** * The total number of threads with the label. */ - threadsTotal?: number; + threadsTotal?: number | null; /** * The number of unread threads with the label. */ - threadsUnread?: number; + threadsUnread?: number | null; /** * The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads. */ - type?: string; + type?: string | null; } export interface Schema$LabelColor { /** * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 */ - backgroundColor?: string; + backgroundColor?: string | null; /** * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 */ - textColor?: string; + textColor?: string | null; } /** * Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. @@ -384,7 +384,7 @@ export namespace gmail_v1 { /** * The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). */ - displayLanguage?: string; + displayLanguage?: string | null; } /** * Response for the ListDelegates method. @@ -403,11 +403,11 @@ export namespace gmail_v1 { /** * Token to retrieve the next page of results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Estimated total number of results. */ - resultSizeEstimate?: number; + resultSizeEstimate?: number | null; } /** * Response for the ListFilters method. @@ -435,11 +435,11 @@ export namespace gmail_v1 { /** * The ID of the mailbox's current history record. */ - historyId?: string; + historyId?: string | null; /** * Page token to retrieve the next page of results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListLabelsResponse { /** @@ -455,11 +455,11 @@ export namespace gmail_v1 { /** * Token to retrieve the next page of results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Estimated total number of results. */ - resultSizeEstimate?: number; + resultSizeEstimate?: number | null; } /** * Response for the ListSendAs method. @@ -480,11 +480,11 @@ export namespace gmail_v1 { /** * Page token to retrieve the next page of results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Estimated total number of results. */ - resultSizeEstimate?: number; + resultSizeEstimate?: number | null; /** * List of threads. Note that each thread resource does not contain a list of messages. The list of messages for a given thread can be fetched using the threads.get method. */ @@ -497,19 +497,19 @@ export namespace gmail_v1 { /** * The ID of the last history record that modified this message. */ - historyId?: string; + historyId?: string | null; /** * The immutable ID of the message. */ - id?: string; + id?: string | null; /** * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header. */ - internalDate?: string; + internalDate?: string | null; /** * List of IDs of labels applied to this message. */ - labelIds?: string[]; + labelIds?: string[] | null; /** * The parsed email structure in the message parts. */ @@ -517,19 +517,19 @@ export namespace gmail_v1 { /** * The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied. */ - raw?: string; + raw?: string | null; /** * Estimated size in bytes of the message. */ - sizeEstimate?: number; + sizeEstimate?: number | null; /** * A short part of the message text. */ - snippet?: string; + snippet?: string | null; /** * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: - The requested threadId must be specified on the Message or Draft.Message you supply with your request. - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. - The Subject headers must match. */ - threadId?: string; + threadId?: string | null; } /** * A single MIME message part. @@ -542,7 +542,7 @@ export namespace gmail_v1 { /** * The filename of the attachment. Only present if this message part represents an attachment. */ - filename?: string; + filename?: string | null; /** * List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject. */ @@ -550,11 +550,11 @@ export namespace gmail_v1 { /** * The MIME type of the message part. */ - mimeType?: string; + mimeType?: string | null; /** * The immutable ID of the message part. */ - partId?: string; + partId?: string | null; /** * The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521. */ @@ -567,45 +567,45 @@ export namespace gmail_v1 { /** * When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field. */ - attachmentId?: string; + attachmentId?: string | null; /** * The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment. */ - data?: string; + data?: string | null; /** * Number of bytes for the message part data (encoding notwithstanding). */ - size?: number; + size?: number | null; } export interface Schema$MessagePartHeader { /** * The name of the header before the : separator. For example, To. */ - name?: string; + name?: string | null; /** * The value of the header after the : separator. For example, someuser@example.com. */ - value?: string; + value?: string | null; } export interface Schema$ModifyMessageRequest { /** * A list of IDs of labels to add to this message. */ - addLabelIds?: string[]; + addLabelIds?: string[] | null; /** * A list IDs of labels to remove from this message. */ - removeLabelIds?: string[]; + removeLabelIds?: string[] | null; } export interface Schema$ModifyThreadRequest { /** * A list of IDs of labels to add to this thread. */ - addLabelIds?: string[]; + addLabelIds?: string[] | null; /** * A list of IDs of labels to remove from this thread. */ - removeLabelIds?: string[]; + removeLabelIds?: string[] | null; } /** * POP settings for an account. @@ -614,11 +614,11 @@ export namespace gmail_v1 { /** * The range of messages which are accessible via POP. */ - accessWindow?: string; + accessWindow?: string | null; /** * The action that will be executed on a message after it has been fetched via POP. */ - disposition?: string; + disposition?: string | null; } /** * Profile for a Gmail user. @@ -627,19 +627,19 @@ export namespace gmail_v1 { /** * The user's email address. */ - emailAddress?: string; + emailAddress?: string | null; /** * The ID of the mailbox's current history record. */ - historyId?: string; + historyId?: string | null; /** * The total number of messages in the mailbox. */ - messagesTotal?: number; + messagesTotal?: number | null; /** * The total number of threads in the mailbox. */ - threadsTotal?: number; + threadsTotal?: number | null; } /** * Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. @@ -648,27 +648,27 @@ export namespace gmail_v1 { /** * A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail. */ - displayName?: string; + displayName?: string | null; /** * Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address. */ - isDefault?: boolean; + isDefault?: boolean | null; /** * Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only. */ - isPrimary?: boolean; + isPrimary?: boolean | null; /** * An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header. */ - replyToAddress?: string; + replyToAddress?: string | null; /** * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. */ - sendAsEmail?: string; + sendAsEmail?: string | null; /** * An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. */ - signature?: string; + signature?: string | null; /** * An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases. */ @@ -676,11 +676,11 @@ export namespace gmail_v1 { /** * Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases. */ - treatAsAlias?: boolean; + treatAsAlias?: boolean | null; /** * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. */ - verificationStatus?: string; + verificationStatus?: string | null; } /** * An S/MIME email config. @@ -689,31 +689,31 @@ export namespace gmail_v1 { /** * Encrypted key password, when key is encrypted. */ - encryptedKeyPassword?: string; + encryptedKeyPassword?: string | null; /** * When the certificate expires (in milliseconds since epoch). */ - expiration?: string; + expiration?: string | null; /** * The immutable ID for the SmimeInfo. */ - id?: string; + id?: string | null; /** * Whether this SmimeInfo is the default one for this user's send-as address. */ - isDefault?: boolean; + isDefault?: boolean | null; /** * The S/MIME certificate issuer's common name. */ - issuerCn?: string; + issuerCn?: string | null; /** * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). */ - pem?: string; + pem?: string | null; /** * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. */ - pkcs12?: string; + pkcs12?: string | null; } /** * Configuration for communication with an SMTP service. @@ -722,23 +722,23 @@ export namespace gmail_v1 { /** * The hostname of the SMTP service. Required. */ - host?: string; + host?: string | null; /** * The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses. */ - password?: string; + password?: string | null; /** * The port of the SMTP service. Required. */ - port?: number; + port?: number | null; /** * The protocol that will be used to secure communication with the SMTP service. Required. */ - securityMode?: string; + securityMode?: string | null; /** * The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses. */ - username?: string; + username?: string | null; } /** * A collection of messages representing a conversation. @@ -747,11 +747,11 @@ export namespace gmail_v1 { /** * The ID of the last history record that modified this thread. */ - historyId?: string; + historyId?: string | null; /** * The unique ID of the thread. */ - id?: string; + id?: string | null; /** * The list of messages in the thread. */ @@ -759,7 +759,7 @@ export namespace gmail_v1 { /** * A short part of the message text. */ - snippet?: string; + snippet?: string | null; } /** * Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. @@ -768,35 +768,35 @@ export namespace gmail_v1 { /** * Flag that controls whether Gmail automatically replies to messages. */ - enableAutoReply?: boolean; + enableAutoReply?: boolean | null; /** * An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime. */ - endTime?: string; + endTime?: string | null; /** * Response body in HTML format. Gmail will sanitize the HTML before storing it. */ - responseBodyHtml?: string; + responseBodyHtml?: string | null; /** * Response body in plain text format. */ - responseBodyPlainText?: string; + responseBodyPlainText?: string | null; /** * Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. */ - responseSubject?: string; + responseSubject?: string | null; /** * Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. */ - restrictToContacts?: boolean; + restrictToContacts?: boolean | null; /** * Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users. */ - restrictToDomain?: boolean; + restrictToDomain?: boolean | null; /** * An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime. */ - startTime?: string; + startTime?: string | null; } /** * Set up or update a new push notification watch on this user's mailbox. @@ -805,15 +805,15 @@ export namespace gmail_v1 { /** * Filtering behavior of labelIds list specified. */ - labelFilterAction?: string; + labelFilterAction?: string | null; /** * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. */ - labelIds?: string[]; + labelIds?: string[] | null; /** * A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request). */ - topicName?: string; + topicName?: string | null; } /** * Push notification watch response. @@ -822,11 +822,11 @@ export namespace gmail_v1 { /** * When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch. */ - expiration?: string; + expiration?: string | null; /** * The ID of the mailbox's current history record. */ - historyId?: string; + historyId?: string | null; } export class Resource$Users { diff --git a/src/apis/groupsmigration/v1.ts b/src/apis/groupsmigration/v1.ts index 61db682642e..9e52140d380 100644 --- a/src/apis/groupsmigration/v1.ts +++ b/src/apis/groupsmigration/v1.ts @@ -108,11 +108,11 @@ export namespace groupsmigration_v1 { /** * The kind of insert resource this is. */ - kind?: string; + kind?: string | null; /** * The status of the insert request. */ - responseCode?: string; + responseCode?: string | null; } export class Resource$Archive { diff --git a/src/apis/groupssettings/v1.ts b/src/apis/groupssettings/v1.ts index e67dfb57875..cf523c292da 100644 --- a/src/apis/groupssettings/v1.ts +++ b/src/apis/groupssettings/v1.ts @@ -108,247 +108,247 @@ export namespace groupssettings_v1 { /** * Identifies whether members external to your organization can join the group. Possible values are: - true: G Suite users external to your organization can become members of this group. - false: Users not belonging to the organization are not allowed to become members of this group. */ - allowExternalMembers?: string; + allowExternalMembers?: string | null; /** * Deprecated. Allows Google to contact administrator of the group. - true: Allow Google to contact managers of this group. Occasionally Google may send updates on the latest features, ask for input on new features, or ask for permission to highlight your group. - false: Google can not contact managers of this group. */ - allowGoogleCommunication?: string; + allowGoogleCommunication?: string | null; /** * Allows posting from web. Possible values are: - true: Allows any member to post to the group forum. - false: Members only use Gmail to communicate with the group. */ - allowWebPosting?: string; + allowWebPosting?: string | null; /** * Allows the group to be archived only. Possible values are: - true: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable. - If true, the whoCanPostMessage property is set to NONE_CAN_POST. - If reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST. - false: The group is active and can receive messages. - When false, updating whoCanPostMessage to NONE_CAN_POST, results in an error. */ - archiveOnly?: string; + archiveOnly?: string | null; /** * Set the content of custom footer text. The maximum number of characters is 1,000. */ - customFooterText?: string; + customFooterText?: string | null; /** * An email address used when replying to a message if the replyTo property is set to REPLY_TO_CUSTOM. This address is defined by an account administrator. - When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds a custom email address used when replying to a message. - If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a text value or an error is returned. */ - customReplyTo?: string; + customReplyTo?: string | null; /** * Specifies whether the group has a custom role that's included in one of the settings being merged. This field is read-only and update/patch requests to it are ignored. Possible values are: - true - false */ - customRolesEnabledForSettingsToBeMerged?: string; + customRolesEnabledForSettingsToBeMerged?: string | null; /** * When a message is rejected, this is text for the rejection notification sent to the message's author. By default, this property is empty and has no value in the API's response body. The maximum notification text size is 10,000 characters. Note: Requires sendMessageDenyNotification property to be true. */ - defaultMessageDenyNotificationText?: string; + defaultMessageDenyNotificationText?: string | null; /** * Description of the group. This property value may be an empty string if no group description has been entered. If entered, the maximum group description is no more than 300 characters. */ - description?: string; + description?: string | null; /** * The group's email address. This property can be updated using the Directory API. Note: Only a group owner can change a group's email address. A group manager can't do this. When you change your group's address using the Directory API or the control panel, you are changing the address your subscribers use to send email and the web address people use to access your group. People can't reach your group by visiting the old address. */ - email?: string; + email?: string | null; /** * Specifies whether a collaborative inbox will remain turned on for the group. Possible values are: - true - false */ - enableCollaborativeInbox?: string; + enableCollaborativeInbox?: string | null; /** * Indicates if favorite replies should be displayed above other replies. - true: Favorite replies will be displayed above other replies. - false: Favorite replies will not be displayed above other replies. */ - favoriteRepliesOnTop?: string; + favoriteRepliesOnTop?: string | null; /** * Whether to include custom footer. Possible values are: - true - false */ - includeCustomFooter?: string; + includeCustomFooter?: string | null; /** * Enables the group to be included in the Global Address List. For more information, see the help center. Possible values are: - true: Group is included in the Global Address List. - false: Group is not included in the Global Address List. */ - includeInGlobalAddressList?: string; + includeInGlobalAddressList?: string | null; /** * Allows the Group contents to be archived. Possible values are: - true: Archive messages sent to the group. - false: Do not keep an archive of messages sent to this group. If false, previously archived messages remain in the archive. */ - isArchived?: string; + isArchived?: string | null; /** * The type of the resource. It is always groupsSettings#groups. */ - kind?: string; + kind?: string | null; /** * Deprecated. The maximum size of a message is 25Mb. */ - maxMessageBytes?: number; + maxMessageBytes?: number | null; /** * Enables members to post messages as the group. Possible values are: - true: Group member can post messages using the group's email address instead of their own email address. Message appear to originate from the group itself. Note: When true, any message moderation settings on individual users or new members do not apply to posts made on behalf of the group. - false: Members can not post in behalf of the group's email address. */ - membersCanPostAsTheGroup?: string; + membersCanPostAsTheGroup?: string | null; /** * Deprecated. The default message display font always has a value of "DEFAULT_FONT". */ - messageDisplayFont?: string; + messageDisplayFont?: string | null; /** * Moderation level of incoming messages. Possible values are: - MODERATE_ALL_MESSAGES: All messages are sent to the group owner's email address for approval. If approved, the message is sent to the group. - MODERATE_NON_MEMBERS: All messages from non group members are sent to the group owner's email address for approval. If approved, the message is sent to the group. - MODERATE_NEW_MEMBERS: All messages from new members are sent to the group owner's email address for approval. If approved, the message is sent to the group. - MODERATE_NONE: No moderator approval is required. Messages are delivered directly to the group. Note: When the whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam. When memberCanPostAsTheGroup is true, any message moderation settings on individual users or new members will not apply to posts made on behalf of the group. */ - messageModerationLevel?: string; + messageModerationLevel?: string | null; /** * Name of the group, which has a maximum size of 75 characters. */ - name?: string; + name?: string | null; /** * The primary language for group. For a group's primary language use the language tags from the G Suite languages found at G Suite Email Settings API Email Language Tags. */ - primaryLanguage?: string; + primaryLanguage?: string | null; /** * Specifies who should the default reply go to. Possible values are: - REPLY_TO_CUSTOM: For replies to messages, use the group's custom email address. When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds the custom email address used when replying to a message. If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a value. Otherwise an error is returned. - REPLY_TO_SENDER: The reply sent to author of message. - REPLY_TO_LIST: This reply message is sent to the group. - REPLY_TO_OWNER: The reply is sent to the owner(s) of the group. This does not include the group's managers. - REPLY_TO_IGNORE: Group users individually decide where the message reply is sent. - REPLY_TO_MANAGERS: This reply message is sent to the group's managers, which includes all managers and the group owner. */ - replyTo?: string; + replyTo?: string | null; /** * Allows a member to be notified if the member's message to the group is denied by the group owner. Possible values are: - true: When a message is rejected, send the deny message notification to the message author. The defaultMessageDenyNotificationText property is dependent on the sendMessageDenyNotification property being true. - false: When a message is rejected, no notification is sent. */ - sendMessageDenyNotification?: string; + sendMessageDenyNotification?: string | null; /** * Deprecated. This is merged into the new whoCanDiscoverGroup setting. Allows the group to be visible in the Groups Directory. Possible values are: - true: All groups in the account are listed in the Groups directory. - false: All groups in the account are not listed in the directory. */ - showInGroupDirectory?: string; + showInGroupDirectory?: string | null; /** * Specifies moderation levels for messages detected as spam. Possible values are: - ALLOW: Post the message to the group. - MODERATE: Send the message to the moderation queue. This is the default. - SILENTLY_MODERATE: Send the message to the moderation queue, but do not send notification to moderators. - REJECT: Immediately reject the message. */ - spamModerationLevel?: string; + spamModerationLevel?: string | null; /** * Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to add members. Possible values are: - ALL_MEMBERS_CAN_ADD: Managers and members can directly add new members. - ALL_MANAGERS_CAN_ADD: Only managers can directly add new members. this includes the group's owner. - ALL_OWNERS_CAN_ADD: Only owners can directly add new members. - NONE_CAN_ADD: No one can directly add new members. */ - whoCanAdd?: string; + whoCanAdd?: string | null; /** * Deprecated. This functionality is no longer supported in the Google Groups UI. The value is always "NONE". */ - whoCanAddReferences?: string; + whoCanAddReferences?: string | null; /** * Specifies who can approve members who ask to join groups. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are: - ALL_MEMBERS_CAN_APPROVE - ALL_MANAGERS_CAN_APPROVE - ALL_OWNERS_CAN_APPROVE - NONE_CAN_APPROVE */ - whoCanApproveMembers?: string; + whoCanApproveMembers?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can approve pending messages in the moderation queue. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanApproveMessages?: string; + whoCanApproveMessages?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to assign topics in a forum to another user. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanAssignTopics?: string; + whoCanAssignTopics?: string | null; /** * Specifies who can moderate metadata. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanAssistContent?: string; + whoCanAssistContent?: string | null; /** * Specifies who can deny membership to users. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanBanUsers?: string; + whoCanBanUsers?: string | null; /** * Permission to contact owner of the group via web UI. Possible values are: - ALL_IN_DOMAIN_CAN_CONTACT - ALL_MANAGERS_CAN_CONTACT - ALL_MEMBERS_CAN_CONTACT - ANYONE_CAN_CONTACT */ - whoCanContactOwner?: string; + whoCanContactOwner?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete replies to topics. (Authors can always delete their own posts). Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanDeleteAnyPost?: string; + whoCanDeleteAnyPost?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete topics. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanDeleteTopics?: string; + whoCanDeleteTopics?: string | null; /** * Specifies the set of users for whom this group is discoverable. Possible values are: - ANYONE_CAN_DISCOVER - ALL_IN_DOMAIN_CAN_DISCOVER - ALL_MEMBERS_CAN_DISCOVER */ - whoCanDiscoverGroup?: string; + whoCanDiscoverGroup?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to enter free form tags for topics in a forum. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanEnterFreeFormTags?: string; + whoCanEnterFreeFormTags?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can hide posts by reporting them as abuse. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanHideAbuse?: string; + whoCanHideAbuse?: string | null; /** * Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to invite new members. Possible values are: - ALL_MEMBERS_CAN_INVITE: Managers and members can invite a new member candidate. - ALL_MANAGERS_CAN_INVITE: Only managers can invite a new member. This includes the group's owner. - ALL_OWNERS_CAN_INVITE: Only owners can invite a new member. - NONE_CAN_INVITE: No one can invite a new member candidate. */ - whoCanInvite?: string; + whoCanInvite?: string | null; /** * Permission to join group. Possible values are: - ANYONE_CAN_JOIN: Anyone in the account domain can join. This includes accounts with multiple domains. - ALL_IN_DOMAIN_CAN_JOIN: Any Internet user who is outside your domain can access your Google Groups service and view the list of groups in your Groups directory. Warning: Group owners can add external addresses, outside of the domain to their groups. They can also allow people outside your domain to join their groups. If you later disable this option, any external addresses already added to users' groups remain in those groups. - INVITED_CAN_JOIN: Candidates for membership can be invited to join. - CAN_REQUEST_TO_JOIN: Non members can request an invitation to join. */ - whoCanJoin?: string; + whoCanJoin?: string | null; /** * Permission to leave the group. Possible values are: - ALL_MANAGERS_CAN_LEAVE - ALL_MEMBERS_CAN_LEAVE - NONE_CAN_LEAVE */ - whoCanLeaveGroup?: string; + whoCanLeaveGroup?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can prevent users from posting replies to topics. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanLockTopics?: string; + whoCanLockTopics?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can make topics appear at the top of the topic list. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanMakeTopicsSticky?: string; + whoCanMakeTopicsSticky?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as a duplicate of another topic. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanMarkDuplicate?: string; + whoCanMarkDuplicate?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark any other user's post as a favorite reply. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanMarkFavoriteReplyOnAnyTopic?: string; + whoCanMarkFavoriteReplyOnAnyTopic?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a post for a topic they started as a favorite reply. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanMarkFavoriteReplyOnOwnTopic?: string; + whoCanMarkFavoriteReplyOnOwnTopic?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as not needing a response. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanMarkNoResponseNeeded?: string; + whoCanMarkNoResponseNeeded?: string | null; /** * Specifies who can moderate content. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanModerateContent?: string; + whoCanModerateContent?: string | null; /** * Specifies who can manage members. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanModerateMembers?: string; + whoCanModerateMembers?: string | null; /** * Deprecated. This is merged into the new whoCanModerateMembers setting. Specifies who can change group members' roles. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanModifyMembers?: string; + whoCanModifyMembers?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to change tags and categories. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanModifyTagsAndCategories?: string; + whoCanModifyTagsAndCategories?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics into the group or forum. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanMoveTopicsIn?: string; + whoCanMoveTopicsIn?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics out of the group or forum. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanMoveTopicsOut?: string; + whoCanMoveTopicsOut?: string | null; /** * Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can post announcements, a special topic type. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - OWNERS_ONLY - NONE */ - whoCanPostAnnouncements?: string; + whoCanPostAnnouncements?: string | null; /** * Permissions to post messages. Possible values are: - NONE_CAN_POST: The group is disabled and archived. No one can post a message to this group. - When archiveOnly is false, updating whoCanPostMessage to NONE_CAN_POST, results in an error. - If archiveOnly is reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST. - ALL_MANAGERS_CAN_POST: Managers, including group owners, can post messages. - ALL_MEMBERS_CAN_POST: Any group member can post a message. - ALL_OWNERS_CAN_POST: Only group owners can post a message. - ALL_IN_DOMAIN_CAN_POST: Anyone in the account can post a message. - ANYONE_CAN_POST: Any Internet user who outside your account can access your Google Groups service and post a message. Note: When whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam. */ - whoCanPostMessage?: string; + whoCanPostMessage?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to take topics in a forum. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanTakeTopics?: string; + whoCanTakeTopics?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unassign any topic in a forum. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanUnassignTopic?: string; + whoCanUnassignTopic?: string | null; /** * Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unmark any post from a favorite reply. Possible values are: - ALL_MEMBERS - OWNERS_AND_MANAGERS - MANAGERS_ONLY - OWNERS_ONLY - NONE */ - whoCanUnmarkFavoriteReplyOnAnyTopic?: string; + whoCanUnmarkFavoriteReplyOnAnyTopic?: string | null; /** * Permissions to view group messages. Possible values are: - ANYONE_CAN_VIEW: Any Internet user can view the group's messages. - ALL_IN_DOMAIN_CAN_VIEW: Anyone in your account can view this group's messages. - ALL_MEMBERS_CAN_VIEW: All group members can view the group's messages. - ALL_MANAGERS_CAN_VIEW: Any group manager can view this group's messages. */ - whoCanViewGroup?: string; + whoCanViewGroup?: string | null; /** * Permissions to view membership. Possible values are: - ALL_IN_DOMAIN_CAN_VIEW: Anyone in the account can view the group members list. If a group already has external members, those members can still send email to this group. - ALL_MEMBERS_CAN_VIEW: The group members can view the group members list. - ALL_MANAGERS_CAN_VIEW: The group managers can view group members list. */ - whoCanViewMembership?: string; + whoCanViewMembership?: string | null; } export class Resource$Groups { diff --git a/src/apis/healthcare/index.ts b/src/apis/healthcare/index.ts index d85d18e3793..3ec351fa688 100644 --- a/src/apis/healthcare/index.ts +++ b/src/apis/healthcare/index.ts @@ -14,31 +14,19 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {healthcare_v1alpha2} from './v1alpha2'; import {healthcare_v1beta1} from './v1beta1'; export const VERSIONS = { - v1alpha2: healthcare_v1alpha2.Healthcare, v1beta1: healthcare_v1beta1.Healthcare, }; -export function healthcare(version: 'v1alpha2'): healthcare_v1alpha2.Healthcare; -export function healthcare( - options: healthcare_v1alpha2.Options -): healthcare_v1alpha2.Healthcare; export function healthcare(version: 'v1beta1'): healthcare_v1beta1.Healthcare; export function healthcare( options: healthcare_v1beta1.Options ): healthcare_v1beta1.Healthcare; -export function healthcare< - T = healthcare_v1alpha2.Healthcare | healthcare_v1beta1.Healthcare ->( +export function healthcare( this: GoogleConfigurable, - versionOrOptions: - | 'v1alpha2' - | healthcare_v1alpha2.Options - | 'v1beta1' - | healthcare_v1beta1.Options + versionOrOptions: 'v1beta1' | healthcare_v1beta1.Options ) { return getAPI('healthcare', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/healthcare/v1alpha2.ts b/src/apis/healthcare/v1alpha2.ts deleted file mode 100644 index a7f8c5bd862..00000000000 --- a/src/apis/healthcare/v1alpha2.ts +++ /dev/null @@ -1,10283 +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 healthcare_v1alpha2 { - export interface Options extends GlobalOptions { - version: 'v1alpha2'; - } - - interface StandardParameters { - /** - * V1 error format. - */ - '$.xgafv'?: string; - /** - * OAuth access token. - */ - access_token?: string; - /** - * Data format for response. - */ - alt?: string; - /** - * JSONP - */ - callback?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - */ - quotaUser?: string; - /** - * Legacy upload protocol for media (e.g. "media", "multipart"). - */ - uploadType?: string; - /** - * Upload protocol for media (e.g. "raw", "multipart"). - */ - upload_protocol?: string; - } - - /** - * Cloud Healthcare API - * - * Manage, store, and access healthcare data in Google Cloud Platform. - * - * @example - * const {google} = require('googleapis'); - * const healthcare = google.healthcare('v1alpha2'); - * - * @namespace healthcare - * @type {Function} - * @version v1alpha2 - * @variation v1alpha2 - * @param {object=} options Options for Healthcare - */ - export class Healthcare { - context: APIRequestContext; - projects: Resource$Projects; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.projects = new Resource$Projects(this.context); - } - } - - /** - * An annotation record. - */ - export interface Schema$Annotation { - /** - * Details of the source. - */ - annotationSource?: Schema$AnnotationSource; - /** - * Annotations for images, e.g., bounding polygons. - */ - imageAnnotation?: Schema$ImageAnnotation; - /** - * Output only. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. - */ - name?: string; - /** - * Annotations for resource, e.g., classification tags. - */ - resourceAnnotation?: Schema$ResourceAnnotation; - /** - * Annotations for sensitive texts, e.g., range of such texts. - */ - textAnnotation?: Schema$SensitiveTextAnnotation; - } - /** - * AnnotationSource holds the source information of the annotation. - */ - export interface Schema$AnnotationSource { - /** - * Cloud Healthcare API resource. - */ - cloudHealthcareSource?: Schema$CloudHealthcareSource; - } - /** - * An Annotation store that can store annotation resources such as labels and tags for text, image and audio. - */ - export interface Schema$AnnotationStore { - /** - * User-supplied key-value pairs used to organize Annotation stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. - */ - labels?: {[key: string]: string}; - /** - * Output only. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. - */ - name?: string; - } - /** - * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, 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; - } - /** - * 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[]; - /** - * The log type that this config enables. - */ - logType?: string; - } - /** - * Associates `members` with a `role`. - */ - export interface Schema$Binding { - /** - * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. - */ - condition?: Schema$Expr; - /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. - */ - members?: string[]; - /** - * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. - */ - role?: string; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$BoundingPoly { - label?: string; - vertices?: Schema$Vertex[]; - } - /** - * Mask a string by replacing its characters with a fixed character. - */ - export interface Schema$CharacterMaskConfig { - /** - * Character to mask the sensitive values. If not supplied, defaults to "*". - */ - maskingCharacter?: string; - } - /** - * Cloud Healthcare API resource. - */ - export interface Schema$CloudHealthcareSource { - /** - * Full path of a Cloud Healthcare API resource. - */ - name?: string; - } - /** - * Creates a new message. - */ - export interface Schema$CreateMessageRequest { - /** - * HL7v2 message. - */ - message?: Schema$Message; - } - /** - * Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). - */ - export interface Schema$CryptoHashConfig { - /** - * An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. - */ - cryptoKey?: string; - } - /** - * A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data. - */ - export interface Schema$Dataset { - /** - * Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. - */ - name?: string; - /** - * The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources (e.g., HL7 messages) where no explicit timezone is specified. - */ - timeZone?: string; - } - /** - * Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. - */ - export interface Schema$DateShiftConfig { - /** - * An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. - */ - cryptoKey?: string; - } - /** - * Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. - */ - export interface Schema$DeidentifyConfig { - /** - * Configures de-id of application/DICOM content. - */ - dicom?: Schema$DicomConfig; - /** - * Configures de-id of application/FHIR content. - */ - fhir?: Schema$FhirConfig; - /** - * Configures de-identification of image pixels wherever they are found in the source_dataset. - */ - image?: Schema$ImageConfig; - /** - * Configures de-identification of text wherever it is found in the source_dataset. - */ - text?: Schema$TextConfig; - } - /** - * Redacts identifying information from the specified dataset. - */ - export interface Schema$DeidentifyDatasetRequest { - /** - * Deidentify configuration. - */ - config?: Schema$DeidentifyConfig; - /** - * The name of the dataset resource to create and write the redacted data to (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). * The destination dataset must not exist. * The destination dataset must be in the same project as the source dataset. De-identifying data across multiple projects is not supported. - */ - destinationDataset?: string; - } - /** - * Contains the status of the Deidentify operation. - */ - export interface Schema$DeidentifyErrorDetails { - /** - * Number of resources failed to process. - */ - failureResourceCount?: string; - /** - * Number of stores failed to process. - */ - failureStoreCount?: string; - /** - * Number of resources successfully processed. - */ - successResourceCount?: string; - /** - * Number of stores successfully processed. - */ - successStoreCount?: string; - } - /** - * Contains a detailed summary of the Deidentify operation. - */ - export interface Schema$DeidentifySummary { - /** - * Number of resources successfully processed. - */ - successResourceCount?: string; - /** - * Number of stores successfully processed. - */ - successStoreCount?: string; - } - /** - * Contains multiple sensitive information findings for each resource slice. - */ - export interface Schema$Detail { - findings?: Schema$Finding[]; - } - /** - * Specifies the parameters needed for de-identification of DICOM stores. - */ - export interface Schema$DicomConfig { - /** - * Tag filtering profile that determines which tags to keep/remove. - */ - filterProfile?: string; - /** - * List of tags to keep. Remove all other tags. - */ - keepList?: Schema$TagFilterList; - /** - * List of tags to remove. Keep all other tags. - */ - removeList?: Schema$TagFilterList; - } - /** - * Represents a DICOM store. - */ - export interface Schema$DicomStore { - /** - * User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. - */ - labels?: {[key: string]: string}; - /** - * Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - */ - name?: string; - /** - * Notification destination for new DICOM instances. Supplied by the client. - */ - notificationConfig?: Schema$NotificationConfig; - } - /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. - */ - export interface Schema$Empty {} - /** - * Structure to describe the error encountered during batch operation on one resource. This is used both for sample errors in operation response, and for format of errors in error reports. - */ - export interface Schema$ErrorDetail { - /** - * The status of the error. - */ - error?: Schema$Status; - /** - * The identifier of the resource. - */ - resource?: string; - } - /** - * Exports data from the specified DICOM store. If a given resource (e.g., a DICOM object with the same SOPInstance UID) already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data will persist when the DICOM store from which it was exported is deleted. - */ - export interface Schema$ExportDicomDataRequest { - /** - * The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. - */ - bigqueryDestination?: Schema$GoogleCloudHealthcareV1alpha2DicomBigQueryDestination; - /** - * The Cloud Storage output destination. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. - */ - gcsDestination?: Schema$GoogleCloudHealthcareV1alpha2DicomGcsDestination; - } - /** - * Request to export resources. - */ - export interface Schema$ExportResourcesRequest { - /** - * The BigQuery output destination. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output will be one BigQuery table per resource type. - */ - bigqueryDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirBigQueryDestination; - /** - * The Cloud Storage output destination. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. The exported outputs are organized by FHIR resource types. The server will create one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource. - */ - gcsDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsDestination; - } - /** - * 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; - /** - * 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; - /** - * 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; - /** - * 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; - } - /** - * Specifies how de-identification of a FHIR store should be handled. - */ - export interface Schema$FhirConfig { - /** - * Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata will be passed through to the output dataset unmodified. All extensions are removed in the output. - */ - fieldMetadataList?: Schema$FieldMetadata[]; - } - /** - * Represents a FHIR store. - */ - export interface Schema$FhirStore { - /** - * Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as GetPatientEverything, will not return all the results if broken references exist. - */ - disableReferentialIntegrity?: boolean; - /** - * Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions. - */ - disableResourceVersioning?: boolean; - /** - * Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. - */ - enableHistoryImport?: boolean; - /** - * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. - */ - enableUpdateCreate?: boolean; - /** - * User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. - */ - labels?: {[key: string]: string}; - /** - * Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - /** - * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes will contain a map with a string describing the action that has triggered the notification, e.g. "action":"CreateResource". - */ - notificationConfig?: Schema$NotificationConfig; - /** - * A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation will be streamed to the new location in addition to the existing ones. When a location is removed from the list, the server will simply stop streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. - */ - streamConfigs?: Schema$StreamConfig[]; - /** - * Configuration of FHIR Subscription: https://www.hl7.org/fhir/subscription.html. - */ - subscriptionConfig?: Schema$SubscriptionConfig; - /** - * Configuration for how incoming FHIR resources will be validated against configured profiles. - */ - validationConfig?: Schema$ValidationConfig; - } - /** - * Specifies FHIR paths to match, and how to handle de-identification of matching fields. - */ - export interface Schema$FieldMetadata { - /** - * Deidentify action for one field. - */ - action?: string; - /** - * List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. e.g. "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. - */ - paths?: string[]; - } - export interface Schema$Finding { - /** - * Zero-based ending index of the found text, exclusively. - */ - end?: string; - /** - * The type of information stored in this text range (e.g. HumanName, BirthDate, Address, etc.) - */ - infoType?: string; - /** - * Zero-based starting index of the found text, inclusively. - */ - start?: string; - } - /** - * Request message for `GetIamPolicy` method. - */ - export interface Schema$GetIamPolicyRequest { - /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. - */ - options?: Schema$GetPolicyOptions; - } - /** - * Encapsulates settings provided to GetIamPolicy. - */ - export interface Schema$GetPolicyOptions { - /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - */ - requestedPolicyVersion?: number; - } - /** - * The BigQuery table where the output should be written. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2DicomBigQueryDestination { - /** - * If the destination table already exists and this flag is `TRUE`, the table will be overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error. - */ - force?: boolean; - /** - * BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - */ - tableUri?: string; - } - /** - * The Cloud Storage location where the output should be written, and the export configuration. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2DicomGcsDestination { - /** - * MIME types supported by DICOM spec. Each file will be written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component will exist only for multi-frame instances. Refer to the DICOM conformance statement for permissible MIME types: https://cloud.google.com/healthcare/docs/dicom#wado-rs The following extensions will be used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png If unspecified, the instances will be exported in their original DICOM format. - */ - mimeType?: string; - /** - * The Cloud Storage destination to export to. URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. - */ - uriPrefix?: string; - } - /** - * Specifies the configuration for importing data from Cloud Storage. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2DicomGcsSource { - /** - * Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm extensions in `my-directory/` and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata. - */ - uri?: string; - } - /** - * The configuration for exporting to BigQuery. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2FhirBigQueryDestination { - /** - * BigQuery URI to a dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId` - */ - datasetUri?: string; - /** - * The configuration for the exported BigQuery schema. - */ - schemaConfig?: Schema$SchemaConfig; - } - /** - * Final response of exporting resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestExportResourcesResponse { - /** - * The name of the FHIR store where resources have been exported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - fhirStore?: string; - /** - * The total number of resources exported from the requested FHIR store. - */ - resourceCount?: string; - } - /** - * The configuration for exporting to Cloud Storage. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsDestination { - /** - * URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. - */ - uriPrefix?: string; - } - /** - * Specifies the Cloud Storage destination where errors will be recorded. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination { - /** - * URI for a Cloud Storage directory to which error report files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. - */ - uriPrefix?: string; - } - /** - * Specifies the configuration for importing data from Cloud Storage. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsSource { - /** - * Points to a Cloud Storage URI containing file(s) to import. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: * `*` to match 0 or more non-separator characters * `**` to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson` extensions in `my-directory/` and its sub-directories. * `?` to match 1 character Files matching the wildcard are expected to contain content only, no metadata. - */ - uri?: string; - } - /** - * Error response of importing resources. This structure will be included in the error details to describe the detailed error. It will only be included when the operation finishes with some failure. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestImportResourcesErrorDetails { - /** - * The number of resources that had errors. - */ - errorCount?: string; - /** - * The name of the FHIR store where resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - fhirStore?: string; - /** - * The total number of resources included in the source data. This is the sum of the success and error counts. - */ - inputSize?: string; - /** - * The number of resources that have been imported. - */ - successCount?: string; - } - /** - * Final response of importing resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes successfully. - */ - export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestImportResourcesResponse { - /** - * The name of the FHIR store where the resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - fhirStore?: string; - /** - * The total number of resources included in the source data. - */ - inputSize?: string; - } - /** - * Represents an HL7v2 store. - */ - export interface Schema$Hl7V2Store { - /** - * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. - */ - labels?: {[key: string]: string}; - /** - * Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. - */ - name?: string; - /** - * The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications will be sent. Supplied by the client. - */ - notificationConfig?: Schema$NotificationConfig; - /** - * The configuration for the parser. It determines how the server parses the messages. - */ - parserConfig?: Schema$ParserConfig; - } - /** - * Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. - */ - export interface Schema$HttpBody { - /** - * The HTTP Content-Type header value specifying the content type of the body. - */ - contentType?: string; - /** - * The HTTP request/response body as raw binary. - */ - data?: string; - /** - * Application specific response metadata. Must be set in the first response for streaming APIs. - */ - extensions?: Array<{[key: string]: any}>; - } - /** - * Image annotation. - */ - export interface Schema$ImageAnnotation { - /** - * The list of polygons outlining the sensitive regions in the image. - */ - boundingPolys?: Schema$BoundingPoly[]; - } - /** - * Specifies how de-identification of image pixel should be handled. - */ - export interface Schema$ImageConfig { - /** - * Determines how to redact text from image. - */ - textRedactionMode?: string; - } - /** - * Returns the errors encountered during DICOM store import. - */ - export interface Schema$ImportDicomDataErrorDetails { - /** - * Deprecated. Use only for debugging purposes. Contains sample errors encountered in imports of individual resources (for example, a Cloud Storage object). - */ - sampleErrors?: Schema$ErrorDetail[]; - } - /** - * Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API will accept duplicate DICOM instances, by simply ignoring the newly pushed instance (it will not overwrite). - */ - export interface Schema$ImportDicomDataRequest { - /** - * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. - */ - gcsSource?: Schema$GoogleCloudHealthcareV1alpha2DicomGcsSource; - } - /** - * Request to import resources. - */ - export interface Schema$ImportResourcesRequest { - /** - * The content structure in the source location. If not specified, the server treats the input source files as BUNDLE. - */ - contentStructure?: string; - /** - * The Cloud Storage destination to write the error report to. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. Note that writing a file to the same destination multiple times will result in the previous version of the file being overwritten. - */ - gcsErrorDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination; - /** - * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains the format specified in ContentStructu. - */ - gcsSource?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsSource; - } - /** - * A transformation to apply to text that is identified as a specific info_type. - */ - export interface Schema$InfoTypeTransformation { - /** - * Config for character mask. - */ - characterMaskConfig?: Schema$CharacterMaskConfig; - /** - * Config for crypto hash. - */ - cryptoHashConfig?: Schema$CryptoHashConfig; - /** - * Config for date shift. - */ - dateShiftConfig?: Schema$DateShiftConfig; - /** - * InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type. - */ - infoTypes?: string[]; - /** - * Config for text redaction. - */ - redactConfig?: Schema$RedactConfig; - /** - * Config for replace with InfoType. - */ - replaceWithInfoTypeConfig?: Schema$ReplaceWithInfoTypeConfig; - } - /** - * Ingests a message into the specified HL7v2 store. - */ - export interface Schema$IngestMessageRequest { - /** - * HL7v2 message to ingest. - */ - message?: Schema$Message; - } - /** - * Acknowledges that a message has been ingested into the specified HL7v2 store. - */ - export interface Schema$IngestMessageResponse { - /** - * HL7v2 ACK message. - */ - hl7Ack?: string; - /** - * Created message resource. - */ - message?: Schema$Message; - } - /** - * Lists the Annotations in the specified Annotation store. - */ - export interface Schema$ListAnnotationsResponse { - /** - * The returned Annotations names. Won't be more values than the value of page_size in the request. - */ - annotations?: string[]; - /** - * Token to retrieve the next page of results or empty if there are no more results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the Annotation stores in the given dataset. - */ - export interface Schema$ListAnnotationStoresResponse { - /** - * The returned Annotation stores. Won't be more Annotation stores than the value of page_size in the request. - */ - annotationStores?: Schema$AnnotationStore[]; - /** - * Token to retrieve the next page of results or empty if there are no more results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the available datasets. - */ - export interface Schema$ListDatasetsResponse { - /** - * The first page of datasets. - */ - datasets?: Schema$Dataset[]; - /** - * Token to retrieve the next page of results, or empty if there are no more results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the DICOM stores in the given dataset. - */ - export interface Schema$ListDicomStoresResponse { - /** - * The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request. - */ - dicomStores?: Schema$DicomStore[]; - /** - * Token to retrieve the next page of results or empty if there are no more results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the FHIR stores in the given dataset. - */ - export interface Schema$ListFhirStoresResponse { - /** - * The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. - */ - fhirStores?: Schema$FhirStore[]; - /** - * Token to retrieve the next page of results or empty if there are no more results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the HL7v2 stores in the given dataset. - */ - export interface Schema$ListHl7V2StoresResponse { - /** - * The returned HL7v2 stores. Won't be more HL7v2 stores than the value of page_size in the request. - */ - hl7V2Stores?: Schema$Hl7V2Store[]; - /** - * Token to retrieve the next page of results or empty if there are no more results in the list. - */ - nextPageToken?: string; - } - /** - * The response message for Locations.ListLocations. - */ - export interface Schema$ListLocationsResponse { - /** - * A list of locations that matches the specified filter in the request. - */ - locations?: Schema$Location[]; - /** - * The standard List next-page token. - */ - nextPageToken?: string; - } - /** - * Lists the messages in the specified HL7v2 store. - */ - export interface Schema$ListMessagesResponse { - /** - * The returned message names. Won't be more values than the value of page_size in the request. - */ - messages?: string[]; - /** - * Token to retrieve the next page of results or empty if there are no more results in the list. - */ - nextPageToken?: string; - } - /** - * The response message for Operations.ListOperations. - */ - export interface Schema$ListOperationsResponse { - /** - * The standard List next-page token. - */ - nextPageToken?: string; - /** - * A list of operations that matches the specified filter in the request. - */ - operations?: Schema$Operation[]; - } - /** - * A resource that represents Google Cloud Platform location. - */ - export interface Schema$Location { - /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". - */ - displayName?: string; - /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} - */ - labels?: {[key: string]: string}; - /** - * The canonical id for this location. For example: `"us-east1"`. - */ - locationId?: string; - /** - * Service-specific metadata. For example the available capacity at the given location. - */ - metadata?: {[key: string]: any}; - /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` - */ - name?: string; - } - /** - * A complete HL7v2 message. See http://www.hl7.org/implement/standards/index.cfm?ref=common for details on the standard. - */ - export interface Schema$Message { - /** - * Output only. The datetime when the message was created. Set by the server. - */ - createTime?: string; - /** - * Raw message bytes. - */ - data?: string; - /** - * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. - */ - labels?: {[key: string]: string}; - /** - * The message type and trigger event for this message. MSH-9. - */ - messageType?: string; - /** - * Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. - */ - name?: string; - /** - * Output only. The parsed version of the raw message data. - */ - parsedData?: Schema$ParsedData; - /** - * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. - */ - patientIds?: Schema$PatientId[]; - /** - * The hospital that this message came from. MSH-4. - */ - sendFacility?: string; - /** - * The datetime the sending application sent this message. MSH-7. - */ - sendTime?: string; - } - /** - * Specifies where notifications should be sent upon changes to a data store. - */ - export interface Schema$NotificationConfig { - /** - * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail. - */ - pubsubTopic?: string; - } - /** - * 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; - /** - * The error result of the operation in case of failure or cancellation. - */ - error?: Schema$Status; - /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. - */ - metadata?: {[key: string]: any}; - /** - * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - */ - name?: string; - /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - */ - response?: {[key: string]: any}; - } - /** - * OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field. - */ - export interface Schema$OperationMetadata { - /** - * The name of the API method that initiated the operation. - */ - apiMethodName?: string; - counter?: Schema$ProgressCounter; - /** - * The time at which the operation was created by the API. - */ - createTime?: string; - /** - * The time at which execution was completed. - */ - endTime?: string; - } - /** - * The content of a HL7v2 message in a structured format. - */ - export interface Schema$ParsedData { - segments?: Schema$Segment[]; - } - /** - * The configuration for the parser. It determines how the server parses the messages. - */ - export interface Schema$ParserConfig { - /** - * Determines whether messages with no header are allowed. - */ - allowNullHeader?: boolean; - /** - * Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as the segment terminator, matching the HL7 version 2 specification. - */ - segmentTerminator?: string; - } - /** - * A patient identifier and associated type. - */ - export interface Schema$PatientId { - /** - * ID type, e.g. MRN or NHS. - */ - type?: string; - /** - * The patient's unique identifier. - */ - value?: string; - } - /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). - */ - export interface Schema$Policy { - /** - * Specifies cloud audit logging configuration for this policy. - */ - auditConfigs?: Schema$AuditConfig[]; - /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. - */ - bindings?: Schema$Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. - */ - etag?: string; - /** - * Deprecated. - */ - version?: number; - } - /** - * ProgressCounter provides counters to describe an operation's progress. - */ - export interface Schema$ProgressCounter { - /** - * The number of units that failed in the operation. - */ - failure?: string; - /** - * The number of units that are pending in the operation. - */ - pending?: string; - /** - * The number of units that succeeded in the operation. - */ - success?: string; - } - /** - * Define how to redact sensitive values. Default behaviour is erase, e.g. "My name is Jake." becomes "My name is ." - */ - export interface Schema$RedactConfig {} - /** - * When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jake" becomes "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. - */ - export interface Schema$ReplaceWithInfoTypeConfig {} - /** - * Resource level annotation. - */ - export interface Schema$ResourceAnnotation { - label?: string; - } - /** - * Configuration for the FHIR BigQuery and Cloud Storage schema. Determines how the server generates the schema. - */ - export interface Schema$SchemaConfig { - /** - * The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. - */ - recursiveStructureDepth?: string; - /** - * Specifies the output schema type. If unspecified, the default is `LOSSLESS`. - */ - schemaType?: string; - } - /** - * Request to search the resources in the specified FHIR store. - */ - export interface Schema$SearchResourcesRequest { - /** - * The 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). - */ - resourceType?: string; - } - /** - * A segment in a structured format. - */ - export interface Schema$Segment { - /** - * A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: - (0.1, "foo"): Component 1 of Field 0 has the value "foo". - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value "bar". - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, has the value "baz". - */ - fields?: {[key: string]: string}; - /** - * A string that indicates the type of segment, e.g., EVN, PID. - */ - segmentId?: string; - /** - * Set ID for segments that can be in a set. This can be empty if it is missing or it is not applicable. - */ - setId?: string; - } - /** - * A TextAnnotation specifies a text range that includes sensitive information. - */ - export interface Schema$SensitiveTextAnnotation { - /** - * Maps from a resource slice (e.g. FHIR resource field path) to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} - */ - details?: {[key: string]: Schema$Detail}; - } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$SetIamPolicyRequest { - /** - * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. - */ - policy?: Schema$Policy; - /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. - */ - updateMask?: string; - } - /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). 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; - /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. - */ - details?: Array<{[key: string]: any}>; - /** - * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - */ - message?: string; - } - /** - * This structure contains configuration for streaming FHIR export. - */ - export interface Schema$StreamConfig { - /** - * The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output will be organized in one table per resource type. The server will inspect and potentially create new tables (if they don't exist) in the given BigQuery dataset. Results will be appended to the corresponding BigQuery tables. The views of the latest snapshot will also be automatically created in the dataset. - */ - bigqueryDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirBigQueryDestination; - /** - * Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server will treat an empty list as an intent to stream all the supported resource types in this FHIR store. - */ - resourceTypes?: string[]; - } - /** - * Configuration of FHIR Subscription: https://www.hl7.org/fhir/subscription.html. - */ - export interface Schema$SubscriptionConfig { - /** - * REST hook endpoints that are allowed to receive subscription notifications. The create or update operation on a FHIR Subscription resource will fail if the FHIR Subscription resource contains a REST hook endpoint that is not in this list. A subscription notification push will fail if the FHIR Subscription resource contains a REST hook endpoint that is not in this list. The REST hook endpoint in a subscription resource will be compared with the endpoints in this list by exact matching. Users must verify their ownership of the domain of an endpoint before adding it to this list. To verify domain ownership, go to https://search.google.com/search-console/welcome. - */ - allowedRestHookEndpoints?: Schema$SubscriptionRestHookEndpoint[]; - } - /** - * REST hook endpoint of FHIR Subscription. - */ - export interface Schema$SubscriptionRestHookEndpoint { - /** - * Whether this endpoint is allowed to receive full resource payloads. If set to false, the subscription notificiation sending to this endpoint with full resource payload will be blocked. - */ - allowResourcePayload?: boolean; - /** - * Address of the REST hook endpoint. It must be a valid HTTPS URL with TLS certificate. - */ - endpoint?: string; - } - /** - * List of tags to be filtered. - */ - export interface Schema$TagFilterList { - /** - * Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". - */ - tags?: string[]; - } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsRequest { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - */ - permissions?: string[]; - } - export interface Schema$TextConfig { - /** - * The transformations to apply to the detected data. - */ - transformations?: Schema$InfoTypeTransformation[]; - } - /** - * This structure contains the configuration for FHIR profiles and validation. - */ - export interface Schema$ValidationConfig { - /** - * Whether profile validation should be disabled for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - */ - disableProfileValidation?: boolean; - /** - * A list of ImplementationGuide IDs in this FHIR store that will be used to configure which profiles are used for validation. For example, to enable an implementation guide with ID 1 set `enabled_implementation_guides` to `["1"]`. If `enabled_implementation_guides` is empty or omitted then incoming resources will only be required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. - */ - enabledImplementationGuides?: string[]; - } - /** - * A 2D coordinate in an image. The origin is the top-left. - */ - export interface Schema$Vertex { - /** - * X coordinate. - */ - x?: number; - /** - * Y coordinate. - */ - y?: number; - } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - datasets: Resource$Projects$Locations$Datasets; - constructor(context: APIRequestContext) { - this.context = context; - this.datasets = new Resource$Projects$Locations$Datasets(this.context); - } - - /** - * healthcare.projects.locations.get - * @desc Gets information about a location. - * @alias healthcare.projects.locations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Resource name for the location. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias healthcare.projects.locations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter The standard list filter. - * @param {string} params.name The resource that owns the locations collection, if applicable. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The standard list filter. - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datasets { - context: APIRequestContext; - annotationStores: Resource$Projects$Locations$Datasets$Annotationstores; - dicomStores: Resource$Projects$Locations$Datasets$Dicomstores; - fhirStores: Resource$Projects$Locations$Datasets$Fhirstores; - hl7V2Stores: Resource$Projects$Locations$Datasets$Hl7v2stores; - operations: Resource$Projects$Locations$Datasets$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.annotationStores = new Resource$Projects$Locations$Datasets$Annotationstores( - this.context - ); - this.dicomStores = new Resource$Projects$Locations$Datasets$Dicomstores( - this.context - ); - this.fhirStores = new Resource$Projects$Locations$Datasets$Fhirstores( - this.context - ); - this.hl7V2Stores = new Resource$Projects$Locations$Datasets$Hl7v2stores( - this.context - ); - this.operations = new Resource$Projects$Locations$Datasets$Operations( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.create - * @desc Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. A Google Cloud Platform project can contain up to 500 datasets across all regions. - * @alias healthcare.projects.locations.datasets.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.datasetId The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). - * @param {().Dataset} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/datasets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.deidentify - * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails. - * @alias healthcare.projects.locations.datasets.deidentify - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.sourceDataset Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - * @param {().DeidentifyDatasetRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - deidentify( - params?: Params$Resource$Projects$Locations$Datasets$Deidentify, - options?: MethodOptions - ): GaxiosPromise; - deidentify( - params: Params$Resource$Projects$Locations$Datasets$Deidentify, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deidentify( - params: Params$Resource$Projects$Locations$Datasets$Deidentify, - callback: BodyResponseCallback - ): void; - deidentify(callback: BodyResponseCallback): void; - deidentify( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Deidentify - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Deidentify; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Deidentify; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+sourceDataset}:deidentify').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['sourceDataset'], - pathParams: ['sourceDataset'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.delete - * @desc Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any). - * @alias healthcare.projects.locations.datasets.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.get - * @desc Gets any metadata associated with a dataset. - * @alias healthcare.projects.locations.datasets.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @alias healthcare.projects.locations.datasets.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.list - * @desc Lists the health datasets in the current project. - * @alias healthcare.projects.locations.datasets.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000. - * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. - * @param {string} params.parent The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/datasets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.patch - * @desc Updates dataset metadata. - * @alias healthcare.projects.locations.datasets.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().Dataset} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. - * @alias healthcare.projects.locations.datasets.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @alias healthcare.projects.locations.datasets.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - datasetId?: string; - /** - * The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Deidentify - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - */ - sourceDataset?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DeidentifyDatasetRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - */ - '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$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous List request, if any. - */ - pageToken?: string; - /** - * The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Annotationstores { - context: APIRequestContext; - annotations: Resource$Projects$Locations$Datasets$Annotationstores$Annotations; - constructor(context: APIRequestContext) { - this.context = context; - this.annotations = new Resource$Projects$Locations$Datasets$Annotationstores$Annotations( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.annotationStores.create - * @desc Creates a new Annotation store within the parent dataset. - * @alias healthcare.projects.locations.datasets.annotationStores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.annotationStoreId The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the dataset this Annotation store belongs to. - * @param {().AnnotationStore} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/annotationStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.delete - * @desc Deletes the specified Annotation store and removes all annotations that are contained within it. - * @alias healthcare.projects.locations.datasets.annotationStores.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation store to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.get - * @desc Gets the specified Annotation store or returns NOT_FOUND if it does not exist. - * @alias healthcare.projects.locations.datasets.annotationStores.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation store to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission `healthcare.AnnotationStores.getIamPolicy` on the specified resource - * @alias healthcare.projects.locations.datasets.annotationStores.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {().GetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.list - * @desc Lists the Annotation stores in the given dataset for a source store. - * @alias healthcare.projects.locations.datasets.annotationStores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - * @param {integer=} params.pageSize Limit on the number of Annotation stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/annotationStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.patch - * @desc Updates the specified Annotation store. - * @alias healthcare.projects.locations.datasets.annotationStores.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().AnnotationStore} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.setIamPolicy - * @desc POLICIES Sets the access control policy for a resource. Replaces any existing policy. Authorization requires the Google IAM permission `healthcare.annotationStores.setIamPolicy` on the specified resource - * @alias healthcare.projects.locations.datasets.annotationStores.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. There is no permission required to make this API call. - * @alias healthcare.projects.locations.datasets.annotationStores.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - annotationStoreId?: string; - /** - * The name of the dataset this Annotation store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AnnotationStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the Annotation store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the Annotation store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - */ - filter?: string; - /** - * Limit on the number of Annotation stores to return in a single response. If zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Output only. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AnnotationStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Annotationstores$Annotations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.create - * @desc Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service. - * @alias healthcare.projects.locations.datasets.annotationStores.annotations.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. - * @param {().Annotation} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/annotations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.delete - * @desc Deletes an Annotation or returns NOT_FOUND if it does not exist. - * @alias healthcare.projects.locations.datasets.annotationStores.annotations.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.get - * @desc Gets an Annotation. - * @alias healthcare.projects.locations.datasets.annotationStores.annotations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.list - * @desc Lists the Annotations in the given Annotation store for a source resource. - * @alias healthcare.projects.locations.datasets.annotationStores.annotations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts Annotations returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - source_version - * @param {integer=} params.pageSize Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the Annotation store to retrieve Annotations from. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/annotations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.patch - * @desc Updates the Annotation. - * @alias healthcare.projects.locations.datasets.annotationStores.annotations.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().Annotation} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Annotation; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the Annotation to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the Annotation to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Restricts Annotations returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - source_version - */ - filter?: string; - /** - * Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if any. - */ - pageToken?: string; - /** - * Name of the Annotation store to retrieve Annotations from. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Output only. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Annotation; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores { - context: APIRequestContext; - dicomWeb: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb; - constructor(context: APIRequestContext) { - this.context = context; - this.dicomWeb = new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.dicomStores.create - * @desc Creates a new DICOM store within the parent dataset. - * @alias healthcare.projects.locations.datasets.dicomStores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.dicomStoreId The ID of the DICOM store that is being created. Any string value up to 256 characters in length. - * @param {string} params.parent The name of the dataset this DICOM store belongs to. - * @param {().DicomStore} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/dicomStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.delete - * @desc Deletes the specified DICOM store and removes all images that are contained within it. - * @alias healthcare.projects.locations.datasets.dicomStores.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the DICOM store to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.export - * @desc Exports data to the specified destination by copying it from the DICOM store. The metadata field type is OperationMetadata. - * @alias healthcare.projects.locations.datasets.dicomStores.export - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The DICOM store resource name from which the data should be exported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {().ExportDicomDataRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - export( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, - options?: MethodOptions - ): GaxiosPromise; - export( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, - callback: BodyResponseCallback - ): void; - export(callback: BodyResponseCallback): void; - export( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Export - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Export; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Export; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}:export').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.get - * @desc Gets the specified DICOM store. - * @alias healthcare.projects.locations.datasets.dicomStores.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the DICOM store to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @alias healthcare.projects.locations.datasets.dicomStores.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.import - * @desc Imports data into the DICOM store by copying it from the specified source. For errors, the Operation will be populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which will hold finer-grained error information. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). The metadata field type is OperationMetadata. - * @alias healthcare.projects.locations.datasets.dicomStores.import - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the DICOM store resource into which the data is imported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {().ImportDicomDataRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - import( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, - options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, - callback: BodyResponseCallback - ): void; - import(callback: BodyResponseCallback): void; - import( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Import - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Import; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Import; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.list - * @desc Lists the DICOM stores in the given dataset. - * @alias healthcare.projects.locations.datasets.dicomStores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - * @param {integer=} params.pageSize Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/dicomStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.patch - * @desc Updates the specified DICOM store. - * @alias healthcare.projects.locations.datasets.dicomStores.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().DicomStore} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. - * @alias healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @alias healthcare.projects.locations.datasets.dicomStores.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the DICOM store that is being created. Any string value up to 256 characters in length. - */ - dicomStoreId?: string; - /** - * The name of the dataset this DICOM store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DicomStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the DICOM store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Export - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DICOM store resource name from which the data should be exported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ExportDicomDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the DICOM store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - */ - '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$Dicomstores$Import - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the DICOM store resource into which the data is imported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ImportDicomDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - */ - filter?: string; - /** - * Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DicomStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb { - context: APIRequestContext; - studies: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies; - constructor(context: APIRequestContext) { - this.context = context; - this.studies = new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForInstances - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - searchForInstances( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforinstances, - options?: MethodOptions - ): GaxiosPromise; - searchForInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchForInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforinstances, - callback: BodyResponseCallback - ): void; - searchForInstances(callback: BodyResponseCallback): void; - searchForInstances( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforinstances - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforinstances; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforinstances; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForSeries - * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForSeries - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - searchForSeries( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforseries, - options?: MethodOptions - ): GaxiosPromise; - searchForSeries( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforseries, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchForSeries( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforseries, - callback: BodyResponseCallback - ): void; - searchForSeries(callback: BodyResponseCallback): void; - searchForSeries( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforseries - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforseries; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforseries; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForStudies - * @desc SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForStudies - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForStudies DICOMweb request (e.g., `studies`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - searchForStudies( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforstudies, - options?: MethodOptions - ): GaxiosPromise; - searchForStudies( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforstudies, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchForStudies( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforstudies, - callback: BodyResponseCallback - ): void; - searchForStudies(callback: BodyResponseCallback): void; - searchForStudies( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforstudies - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforstudies; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforstudies; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.storeInstances - * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.storeInstances - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - storeInstances( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Storeinstances, - options?: MethodOptions - ): GaxiosPromise; - storeInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Storeinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - storeInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Storeinstances, - callback: BodyResponseCallback - ): void; - storeInstances(callback: BodyResponseCallback): void; - storeInstances( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Storeinstances - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Storeinstances; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Storeinstances; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforinstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforseries - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Searchforstudies - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the SearchForStudies DICOMweb request (e.g., `studies`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Storeinstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies { - context: APIRequestContext; - series: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series; - constructor(context: APIRequestContext) { - this.context = context; - this.series = new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.delete - * @desc DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DeleteStudy request (e.g., `studies/{study_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.metadata - * @desc RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.metadata - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - metadata( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Metadata, - options?: MethodOptions - ): GaxiosPromise; - metadata( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Metadata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - metadata( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Metadata, - callback: BodyResponseCallback - ): void; - metadata(callback: BodyResponseCallback): void; - metadata( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Metadata - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Metadata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Metadata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.retrieveStudy - * @desc RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.retrieveStudy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - retrieveStudy( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Retrievestudy, - options?: MethodOptions - ): GaxiosPromise; - retrieveStudy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Retrievestudy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - retrieveStudy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Retrievestudy, - callback: BodyResponseCallback - ): void; - retrieveStudy(callback: BodyResponseCallback): void; - retrieveStudy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Retrievestudy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Retrievestudy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Retrievestudy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForInstances - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - searchForInstances( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforinstances, - options?: MethodOptions - ): GaxiosPromise; - searchForInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchForInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforinstances, - callback: BodyResponseCallback - ): void; - searchForInstances(callback: BodyResponseCallback): void; - searchForInstances( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforinstances - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforinstances; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforinstances; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForSeries - * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForSeries - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - searchForSeries( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforseries, - options?: MethodOptions - ): GaxiosPromise; - searchForSeries( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforseries, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchForSeries( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforseries, - callback: BodyResponseCallback - ): void; - searchForSeries(callback: BodyResponseCallback): void; - searchForSeries( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforseries - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforseries; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforseries; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.storeInstances - * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.storeInstances - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - storeInstances( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Storeinstances, - options?: MethodOptions - ): GaxiosPromise; - storeInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Storeinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - storeInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Storeinstances, - callback: BodyResponseCallback - ): void; - storeInstances(callback: BodyResponseCallback): void; - storeInstances( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Storeinstances - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Storeinstances; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Storeinstances; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the DeleteStudy request (e.g., `studies/{study_id}`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Metadata - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Retrievestudy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforinstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Searchforseries - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Storeinstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series { - context: APIRequestContext; - instances: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances; - constructor(context: APIRequestContext) { - this.context = context; - this.instances = new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.delete - * @desc DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.metadata - * @desc RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.metadata - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - metadata( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Metadata, - options?: MethodOptions - ): GaxiosPromise; - metadata( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Metadata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - metadata( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Metadata, - callback: BodyResponseCallback - ): void; - metadata(callback: BodyResponseCallback): void; - metadata( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Metadata - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Metadata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Metadata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.retrieveSeries - * @desc RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.retrieveSeries - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - retrieveSeries( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Retrieveseries, - options?: MethodOptions - ): GaxiosPromise; - retrieveSeries( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Retrieveseries, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - retrieveSeries( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Retrieveseries, - callback: BodyResponseCallback - ): void; - retrieveSeries(callback: BodyResponseCallback): void; - retrieveSeries( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Retrieveseries - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Retrieveseries; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Retrieveseries; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.searchForInstances - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - searchForInstances( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Searchforinstances, - options?: MethodOptions - ): GaxiosPromise; - searchForInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Searchforinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchForInstances( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Searchforinstances, - callback: BodyResponseCallback - ): void; - searchForInstances(callback: BodyResponseCallback): void; - searchForInstances( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Searchforinstances - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Searchforinstances; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Searchforinstances; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Metadata - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Retrieveseries - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Searchforinstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances { - context: APIRequestContext; - frames: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames; - constructor(context: APIRequestContext) { - this.context = context; - this.frames = new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.delete - * @desc DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.metadata - * @desc RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.metadata - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - metadata( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Metadata, - options?: MethodOptions - ): GaxiosPromise; - metadata( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Metadata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - metadata( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Metadata, - callback: BodyResponseCallback - ): void; - metadata(callback: BodyResponseCallback): void; - metadata( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Metadata - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Metadata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Metadata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.rendered - * @desc RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.rendered - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - rendered( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Rendered, - options?: MethodOptions - ): GaxiosPromise; - rendered( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Rendered, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - rendered( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Rendered, - callback: BodyResponseCallback - ): void; - rendered(callback: BodyResponseCallback): void; - rendered( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Rendered - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Rendered; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Rendered; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.retrieveInstance - * @desc RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.retrieveInstance - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - retrieveInstance( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Retrieveinstance, - options?: MethodOptions - ): GaxiosPromise; - retrieveInstance( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Retrieveinstance, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - retrieveInstance( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Retrieveinstance, - callback: BodyResponseCallback - ): void; - retrieveInstance(callback: BodyResponseCallback): void; - retrieveInstance( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Retrieveinstance - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Retrieveinstance; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Retrieveinstance; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Metadata - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Rendered - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Retrieveinstance - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.rendered - * @desc RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.rendered - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - rendered( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Rendered, - options?: MethodOptions - ): GaxiosPromise; - rendered( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Rendered, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - rendered( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Rendered, - callback: BodyResponseCallback - ): void; - rendered(callback: BodyResponseCallback): void; - rendered( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Rendered - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Rendered; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Rendered; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.retrieveFrames - * @desc RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. - * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.retrieveFrames - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - retrieveFrames( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Retrieveframes, - options?: MethodOptions - ): GaxiosPromise; - retrieveFrames( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Retrieveframes, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - retrieveFrames( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Retrieveframes, - callback: BodyResponseCallback - ): void; - retrieveFrames(callback: BodyResponseCallback): void; - retrieveFrames( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Retrieveframes - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Retrieveframes; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Retrieveframes; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Rendered - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Frames$Retrieveframes - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). - */ - dicomWebPath?: string; - /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores { - context: APIRequestContext; - fhir: Resource$Projects$Locations$Datasets$Fhirstores$Fhir; - constructor(context: APIRequestContext) { - this.context = context; - this.fhir = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.capabilities - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - capabilities( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities, - options?: MethodOptions - ): GaxiosPromise; - capabilities( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - capabilities( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities, - callback: BodyResponseCallback - ): void; - capabilities(callback: BodyResponseCallback): void; - capabilities( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/metadata').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.create - * @desc Creates a new FHIR store within the parent dataset. - * @alias healthcare.projects.locations.datasets.fhirStores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.fhirStoreId The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the dataset this FHIR store belongs to. - * @param {().FhirStore} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhirStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.delete - * @desc Deletes the specified FHIR store and removes all resources within it. - * @alias healthcare.projects.locations.datasets.fhirStores.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the FHIR store to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.export - * @desc Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. - * @alias healthcare.projects.locations.datasets.fhirStores.export - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the FHIR store to export resource from. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * @param {().ExportResourcesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - export( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, - options?: MethodOptions - ): GaxiosPromise; - export( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, - callback: BodyResponseCallback - ): void; - export(callback: BodyResponseCallback): void; - export( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Export - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Export; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Export; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}:export').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.get - * @desc Gets the configuration of the specified FHIR store. - * @alias healthcare.projects.locations.datasets.fhirStores.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the FHIR store to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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.fhirStores.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - * @param {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$Fhirstores$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+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.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except for the special case of `history`, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. If history imports are enabled by setting enable_history_import in the FHIR store's configuration, this method can import historical versions of a resource by supplying a bundle of type `history` and using the `BUNDLE` format. The historical versions in the bundle must have `lastUpdated` timestamps, and the resulting resource history on the server will appear as if the versions had been created at those timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected to avoid creating an inconsistent sequence of resource versions. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. - * @alias healthcare.projects.locations.datasets.fhirStores.import - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the FHIR store to import FHIR resources to. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * @param {().ImportResourcesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - import( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, - options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, - callback: BodyResponseCallback - ): void; - import(callback: BodyResponseCallback): void; - import( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Import - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Import; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Import; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.list - * @desc Lists the FHIR stores in the given dataset. - * @alias healthcare.projects.locations.datasets.fhirStores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - * @param {integer=} params.pageSize Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhirStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.patch - * @desc Updates the configuration of the specified FHIR store. - * @alias healthcare.projects.locations.datasets.fhirStores.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().FhirStore} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. - * @alias healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. 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.fhirStores.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve the capabilities for. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - fhirStoreId?: string; - /** - * The name of the dataset this FHIR store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FhirStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the FHIR store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Export - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store to export resource from. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ExportResourcesRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the FHIR store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - */ - '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$Fhirstores$Import - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store to import FHIR resources to. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ImportResourcesRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - */ - filter?: string; - /** - * Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FhirStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * 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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.capabilities - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - capabilities( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, - options?: MethodOptions - ): GaxiosPromise; - capabilities( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - capabilities( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, - callback: BodyResponseCallback - ): void; - capabilities(callback: BodyResponseCallback): void; - capabilities( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/fhir/metadata').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The 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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - conditionalDelete( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, - options?: MethodOptions - ): GaxiosPromise; - conditionalDelete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - conditionalDelete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, - callback: BodyResponseCallback - ): void; - conditionalDelete(callback: BodyResponseCallback): void; - conditionalDelete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhir/{+type}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The 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 {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - conditionalPatch( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, - options?: MethodOptions - ): GaxiosPromise; - conditionalPatch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - conditionalPatch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, - callback: BodyResponseCallback - ): void; - conditionalPatch(callback: BodyResponseCallback): void; - conditionalPatch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhir/{+type}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The 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 {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - conditionalUpdate( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, - options?: MethodOptions - ): GaxiosPromise; - conditionalUpdate( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - conditionalUpdate( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, - callback: BodyResponseCallback - ): void; - conditionalUpdate(callback: BodyResponseCallback): void; - conditionalUpdate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhir/{+type}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The 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 {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhir/{+type}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * 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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store in which this bundle will be executed. - * @param {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - executeBundle( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, - options?: MethodOptions - ): GaxiosPromise; - executeBundle( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - executeBundle( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, - callback: BodyResponseCallback - ): void; - executeBundle(callback: BodyResponseCallback): void; - executeBundle( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhir').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.history - * @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 Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. - * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - history( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, - options?: MethodOptions - ): GaxiosPromise; - history( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - history( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, - callback: BodyResponseCallback - ): void; - history(callback: BodyResponseCallback): void; - history( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/_history').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn - * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation [Observation-lastn](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). Search terms are provided as query parameters following the same pattern as the search method. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources 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 - */ - ObservationLastn( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, - options?: MethodOptions - ): GaxiosPromise; - ObservationLastn( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - ObservationLastn( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, - callback: BodyResponseCallback - ): void; - ObservationLastn(callback: BodyResponseCallback): void; - ObservationLastn( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha2/{+parent}/fhir/Observation/$lastn' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to update. - * @param {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything - * @desc Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment. Implements the FHIR extended operation [Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. - * @param {string} params.name Name of the `Patient` 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' url. 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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - PatientEverything( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, - options?: MethodOptions - ): GaxiosPromise; - PatientEverything( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - PatientEverything( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, - callback: BodyResponseCallback - ): void; - PatientEverything(callback: BodyResponseCallback): void; - PatientEverything( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/$everything').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * 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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.read - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - read( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, - options?: MethodOptions - ): GaxiosPromise; - read( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - read( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, - callback: BodyResponseCallback - ): void; - read(callback: BodyResponseCallback): void; - read( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge - * @desc Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to purge. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - ResourcePurge( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, - options?: MethodOptions - ): GaxiosPromise; - ResourcePurge( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - ResourcePurge( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, - callback: BodyResponseCallback - ): void; - ResourcePurge(callback: BodyResponseCallback): void; - ResourcePurge( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/$purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.fhir.search - * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.search - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources from. - * @param {().SearchResourcesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - search( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, - options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, - callback: BodyResponseCallback - ): void; - search(callback: BodyResponseCallback): void; - search( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhir/_search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to update. - * @param {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.fhirStores.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. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.vread - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource version to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - vread( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, - options?: MethodOptions - ): GaxiosPromise; - vread( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - vread( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, - callback: BodyResponseCallback - ): void; - vread(callback: BodyResponseCallback): void; - vread( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve the capabilities for. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The 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). - */ - type?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The 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). - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The 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. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The 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. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store in which this bundle will be executed. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` - */ - at?: string; - /** - * The maximum number of search results on a page. Defaults to 1000. - */ - count?: number; - /** - * The name of the resource to retrieve. - */ - name?: string; - /** - * Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. - */ - page?: string; - /** - * Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. - */ - since?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. - */ - end?: string; - /** - * Name of the `Patient` 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' url. 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. - */ - start?: string; - /** - * Maximum number of resources in a page. Defaults to 100. - */ - _count?: number; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to purge. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SearchResourcesRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource version to retrieve. - */ - name?: string; - } - - export class Resource$Projects$Locations$Datasets$Hl7v2stores { - context: APIRequestContext; - messages: Resource$Projects$Locations$Datasets$Hl7v2stores$Messages; - constructor(context: APIRequestContext) { - this.context = context; - this.messages = new Resource$Projects$Locations$Datasets$Hl7v2stores$Messages( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.create - * @desc Creates a new HL7v2 store within the parent dataset. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.hl7V2StoreId The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the dataset this HL7v2 store belongs to. - * @param {().Hl7V2Store} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/hl7V2Stores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.delete - * @desc Deletes the specified HL7v2 store and removes all messages that are contained within it. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 store to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.get - * @desc Gets the specified HL7v2 store. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 store to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - * @param {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$Hl7v2stores$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+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.hl7V2Stores.list - * @desc Lists the HL7v2 stores in the given dataset. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - * @param {integer=} params.pageSize Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/hl7V2Stores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.patch - * @desc Updates the HL7v2 store. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().Hl7V2Store} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+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.hl7V2Stores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+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$Hl7v2stores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - hl7V2StoreId?: string; - /** - * The name of the dataset this HL7v2 store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Hl7V2Store; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the HL7v2 store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the HL7v2 store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. - */ - '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$Hl7v2stores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - */ - filter?: string; - /** - * Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Hl7V2Store; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy - 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$Hl7v2stores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Hl7v2stores$Messages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.create - * @desc Creates a message and sends a notification to the Cloud Pub/Sub topic. If configured, the MLLP adapter listens to messages created by this method and sends those back to the hospital. A successful response indicates the message has been persisted to storage and a Cloud Pub/Sub notification has been sent. Sending to the hospital by the MLLP adapter happens asynchronously. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the dataset this message belongs to. - * @param {().CreateMessageRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/messages').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.delete - * @desc Deletes an HL7v2 message. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 message to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.get - * @desc Gets an HL7v2 message. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 message to retrieve. - * @param {string=} params.view Specifies which parts of the Message resource should be returned in the response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest - * @desc Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. If an identical HL7v2 message is created twice only one resource is created on the server and no error is reported. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the HL7v2 store this message belongs to. - * @param {().IngestMessageRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - ingest( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, - options?: MethodOptions - ): GaxiosPromise; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, - callback: BodyResponseCallback - ): void; - ingest(callback: BodyResponseCallback): void; - ingest( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/messages:ingest').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.list - * @desc Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care center that the message came from, from the MSH-4 segment; for example `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular expression matching of `expr` against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", "MRN")` * `labels.x`, a string value of the label with key `x` as set using the Message.labels map, for example `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label, for example `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. The HasLabel(x) and Label(x) syntax from previous API versions are deprecated; replaced by the `labels.x` syntax. - * @param {string=} params.orderBy Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * `send_time` - * @param {integer=} params.pageSize Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the HL7v2 store to retrieve messages from. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/messages').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.patch - * @desc Update the message. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Only the `labels` field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated. - * @param {().Message} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the dataset this message belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreateMessageRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the HL7v2 message to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the HL7v2 message to retrieve. - */ - name?: string; - /** - * Specifies which parts of the Message resource should be returned in the response. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the HL7v2 store this message belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$IngestMessageRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care center that the message came from, from the MSH-4 segment; for example `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular expression matching of `expr` against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", "MRN")` * `labels.x`, a string value of the label with key `x` as set using the Message.labels map, for example `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label, for example `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. The HasLabel(x) and Label(x) syntax from previous API versions are deprecated; replaced by the `labels.x` syntax. - */ - filter?: string; - /** - * Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * `send_time` - */ - orderBy?: string; - /** - * Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if any. - */ - pageToken?: string; - /** - * Name of the HL7v2 store to retrieve messages from. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Only the `labels` field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Message; - } - - export class Resource$Projects$Locations$Datasets$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.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 healthcare.projects.locations.datasets.operations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.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 healthcare.projects.locations.datasets.operations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter The standard list filter. - * @param {string} params.name The name of the operation's parent resource. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Operations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Operations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$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/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 540b9fe8850..3bc78c13578 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -128,7 +128,7 @@ export namespace healthcare_v1beta1 { /** * 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; + 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. @@ -137,11 +137,11 @@ export namespace healthcare_v1beta1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -154,11 +154,11 @@ export namespace healthcare_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Mask a string by replacing its characters with a fixed character. @@ -167,7 +167,7 @@ export namespace healthcare_v1beta1 { /** * Character to mask the sensitive values. If not supplied, defaults to "*". */ - maskingCharacter?: string; + maskingCharacter?: string | null; } /** * Creates a new message. @@ -185,7 +185,7 @@ export namespace healthcare_v1beta1 { /** * An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. */ - cryptoKey?: string; + cryptoKey?: string | null; } /** * A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data. @@ -194,11 +194,11 @@ export namespace healthcare_v1beta1 { /** * Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ - name?: string; + name?: string | null; /** * The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources (e.g., HL7 messages) where no explicit timezone is specified. */ - timeZone?: string; + timeZone?: string | null; } /** * Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. @@ -207,7 +207,7 @@ export namespace healthcare_v1beta1 { /** * An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. */ - cryptoKey?: string; + cryptoKey?: string | null; } /** * Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. @@ -241,7 +241,7 @@ export namespace healthcare_v1beta1 { /** * The name of the dataset resource to create and write the redacted data to (e.g., * The destination dataset must not exist. * The destination dataset must be in the same project as the source dataset. De-identifying data across multiple projects is not supported. */ - destinationDataset?: string; + destinationDataset?: string | null; } /** * Contains the status of the Deidentify operation. @@ -250,19 +250,19 @@ export namespace healthcare_v1beta1 { /** * Number of resources failed to process. */ - failureResourceCount?: string; + failureResourceCount?: string | null; /** * Number of stores failed to process. */ - failureStoreCount?: string; + failureStoreCount?: string | null; /** * Number of resources successfully processed. */ - successResourceCount?: string; + successResourceCount?: string | null; /** * Number of stores successfully processed. */ - successStoreCount?: string; + successStoreCount?: string | null; } /** * Contains a detailed summary of the Deidentify operation. @@ -271,11 +271,11 @@ export namespace healthcare_v1beta1 { /** * Number of resources successfully processed. */ - successResourceCount?: string; + successResourceCount?: string | null; /** * Number of stores successfully processed. */ - successStoreCount?: string; + successStoreCount?: string | null; } /** * Specifies the parameters needed for de-identification of DICOM stores. @@ -284,7 +284,7 @@ export namespace healthcare_v1beta1 { /** * Tag filtering profile that determines which tags to keep/remove. */ - filterProfile?: string; + filterProfile?: string | null; /** * List of tags to keep. Remove all other tags. */ @@ -296,7 +296,7 @@ export namespace healthcare_v1beta1 { /** * If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html */ - skipIdRedaction?: boolean; + skipIdRedaction?: boolean | null; } /** * Represents a DICOM store. @@ -305,11 +305,11 @@ export namespace healthcare_v1beta1 { /** * User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ - name?: string; + name?: string | null; /** * Notification destination for new DICOM instances. Supplied by the client. */ @@ -330,7 +330,7 @@ export namespace healthcare_v1beta1 { /** * The identifier of the resource. */ - resource?: string; + resource?: string | null; } /** * Exports data from the specified DICOM store. If a given resource (e.g., a DICOM object with the same SOPInstance UID) already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data will persist when the DICOM store from which it was exported is deleted. @@ -365,19 +365,19 @@ export namespace healthcare_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Specifies how de-identification of a FHIR store should be handled. @@ -395,27 +395,27 @@ export namespace healthcare_v1beta1 { /** * Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as GetPatientEverything, will not return all the results if broken references exist. */ - disableReferentialIntegrity?: boolean; + disableReferentialIntegrity?: boolean | null; /** * Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions. */ - disableResourceVersioning?: boolean; + disableResourceVersioning?: boolean | null; /** * Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. */ - enableHistoryImport?: boolean; + enableHistoryImport?: boolean | null; /** * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. */ - enableUpdateCreate?: boolean; + enableUpdateCreate?: boolean | null; /** * User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ - name?: string; + name?: string | null; /** * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes will contain a map with a string describing the action that has triggered the notification, e.g. "action":"CreateResource". */ @@ -428,11 +428,11 @@ export namespace healthcare_v1beta1 { /** * Deidentify action for one field. */ - action?: string; + action?: string | null; /** * List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. e.g. "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. */ - paths?: string[]; + paths?: string[] | null; } /** * The BigQuery table where the output should be written. @@ -441,11 +441,11 @@ export namespace healthcare_v1beta1 { /** * If the destination table already exists and this flag is `TRUE`, the table will be overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error. */ - force?: boolean; + force?: boolean | null; /** * BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` */ - tableUri?: string; + tableUri?: string | null; } /** * The Cloud Storage location where the output should be written, and the export configuration. @@ -454,11 +454,11 @@ export namespace healthcare_v1beta1 { /** * MIME types supported by DICOM spec. Each file will be written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component will exist only for multi-frame instances. Refer to the DICOM conformance statement for permissible MIME types: https://cloud.google.com/healthcare/docs/dicom#wado-rs The following extensions will be used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png If unspecified, the instances will be exported in their original DICOM format. */ - mimeType?: string; + mimeType?: string | null; /** * The Cloud Storage destination to export to. URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ - uriPrefix?: string; + uriPrefix?: string | null; } /** * Specifies the configuration for importing data from Cloud Storage. @@ -467,7 +467,7 @@ export namespace healthcare_v1beta1 { /** * Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm extensions in `my-directory/` and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata. */ - uri?: string; + uri?: string | null; } /** * The configuration for exporting to BigQuery. @@ -476,24 +476,49 @@ export namespace healthcare_v1beta1 { /** * BigQuery URI to a dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId` */ - datasetUri?: string; + datasetUri?: string | null; + /** + * If this flag is `TRUE`, all tables will be deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. + */ + force?: boolean | null; /** * The configuration for the exported BigQuery schema. */ schemaConfig?: Schema$SchemaConfig; } /** - * Final response of exporting resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes. + * Response when errors occur while exporting resources. This structure is included in the error details to describe the detailed outcome. It is only included when the operation finishes with errors. + */ + export interface Schema$GoogleCloudHealthcareV1beta1FhirRestExportResourcesErrorDetails { + /** + * The number of resources that had errors. + */ + errorCount?: string | null; + /** + * The name of the FHIR store where resources have been exported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + fhirStore?: string | null; + /** + * The total number of resources included in the export operation. This is the sum of the success and error counts. + */ + resourceCount?: string | null; + /** + * The number of resources that were exported. + */ + successCount?: string | null; + } + /** + * Response when all resources export successfully. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes successfully. */ export interface Schema$GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse { /** * The name of the FHIR store where resources have been exported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ - fhirStore?: string; + fhirStore?: string | null; /** * The total number of resources exported from the requested FHIR store. */ - resourceCount?: string; + resourceCount?: string | null; } /** * The configuration for exporting to Cloud Storage. @@ -502,7 +527,7 @@ export namespace healthcare_v1beta1 { /** * URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ - uriPrefix?: string; + uriPrefix?: string | null; } /** * Specifies the configuration for importing data from Cloud Storage. @@ -511,7 +536,7 @@ export namespace healthcare_v1beta1 { /** * Points to a Cloud Storage URI containing file(s) to import. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: * `*` to match 0 or more non-separator characters * `**` to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson` extensions in `my-directory/` and its sub-directories. * `?` to match 1 character Files matching the wildcard are expected to contain content only, no metadata. */ - uri?: string; + uri?: string | null; } /** * Error response of importing resources. This structure will be included in the error details to describe the detailed error. It will only be included when the operation finishes with some failure. @@ -520,19 +545,19 @@ export namespace healthcare_v1beta1 { /** * The number of resources that had errors. */ - errorCount?: string; + errorCount?: string | null; /** * The name of the FHIR store where resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ - fhirStore?: string; + fhirStore?: string | null; /** * The total number of resources included in the source data. This is the sum of the success and error counts. */ - inputSize?: string; + inputSize?: string | null; /** * The number of resources that have been imported. */ - successCount?: string; + successCount?: string | null; } /** * Final response of importing resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes successfully. @@ -541,11 +566,11 @@ export namespace healthcare_v1beta1 { /** * The name of the FHIR store where the resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ - fhirStore?: string; + fhirStore?: string | null; /** * The total number of resources included in the source data. */ - inputSize?: string; + inputSize?: string | null; } /** * Represents an HL7v2 store. @@ -554,11 +579,11 @@ export namespace healthcare_v1beta1 { /** * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. */ - name?: string; + name?: string | null; /** * The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications will be sent. Supplied by the client. */ @@ -575,15 +600,15 @@ export namespace healthcare_v1beta1 { /** * The HTTP Content-Type header value specifying the content type of the body. */ - contentType?: string; + contentType?: string | null; /** * The HTTP request/response body as raw binary. */ - data?: string; + data?: string | null; /** * Application specific response metadata. Must be set in the first response for streaming APIs. */ - extensions?: Array<{[key: string]: any}>; + extensions?: Array<{[key: string]: any}> | null; } /** * Specifies how de-identification of image pixel should be handled. @@ -592,7 +617,7 @@ export namespace healthcare_v1beta1 { /** * Determines how to redact text from image. */ - textRedactionMode?: string; + textRedactionMode?: string | null; } /** * Returns the errors encountered during DICOM store import. @@ -619,7 +644,7 @@ export namespace healthcare_v1beta1 { /** * The content structure in the source location. If not specified, the server treats the input source files as BUNDLE. */ - contentStructure?: string; + contentStructure?: string | null; /** * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains the format specified in ContentStructure. */ @@ -644,7 +669,7 @@ export namespace healthcare_v1beta1 { /** * InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type. */ - infoTypes?: string[]; + infoTypes?: string[] | null; /** * Config for text redaction. */ @@ -670,7 +695,7 @@ export namespace healthcare_v1beta1 { /** * HL7v2 ACK message. */ - hl7Ack?: string; + hl7Ack?: string | null; /** * Created message resource. */ @@ -687,7 +712,7 @@ export namespace healthcare_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Lists the DICOM stores in the given dataset. @@ -700,7 +725,7 @@ export namespace healthcare_v1beta1 { /** * Token to retrieve the next page of results or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Lists the FHIR stores in the given dataset. @@ -713,7 +738,7 @@ export namespace healthcare_v1beta1 { /** * Token to retrieve the next page of results or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Lists the HL7v2 stores in the given dataset. @@ -726,7 +751,7 @@ export namespace healthcare_v1beta1 { /** * Token to retrieve the next page of results or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -739,7 +764,7 @@ export namespace healthcare_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Lists the messages in the specified HL7v2 store. @@ -748,11 +773,11 @@ export namespace healthcare_v1beta1 { /** * The returned message names. Won't be more values than the value of page_size in the request. */ - messages?: string[]; + messages?: string[] | null; /** * Token to retrieve the next page of results or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -761,7 +786,7 @@ export namespace healthcare_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -774,23 +799,23 @@ export namespace healthcare_v1beta1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * A complete HL7v2 message. See http://www.hl7.org/implement/standards/index.cfm?ref=common for details on the standard. @@ -799,23 +824,23 @@ export namespace healthcare_v1beta1 { /** * Output only. The datetime when the message was created. Set by the server. */ - createTime?: string; + createTime?: string | null; /** * Raw message bytes. */ - data?: string; + data?: string | null; /** * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The message type and trigger event for this message. MSH-9. */ - messageType?: string; + messageType?: string | null; /** * Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. */ - name?: string; + name?: string | null; /** * Output only. The parsed version of the raw message data. */ @@ -827,11 +852,11 @@ export namespace healthcare_v1beta1 { /** * The hospital that this message came from. MSH-4. */ - sendFacility?: string; + sendFacility?: string | null; /** * The datetime the sending application sent this message. MSH-7. */ - sendTime?: string; + sendTime?: string | null; } /** * Specifies where notifications should be sent upon changes to a data store. @@ -840,7 +865,7 @@ export namespace healthcare_v1beta1 { /** * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail. */ - pubsubTopic?: string; + pubsubTopic?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -849,7 +874,7 @@ export namespace healthcare_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -857,15 +882,15 @@ export namespace healthcare_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field. @@ -874,16 +899,16 @@ export namespace healthcare_v1beta1 { /** * The name of the API method that initiated the operation. */ - apiMethodName?: string; + apiMethodName?: string | null; counter?: Schema$ProgressCounter; /** * The time at which the operation was created by the API. */ - createTime?: string; + createTime?: string | null; /** * The time at which execution was completed. */ - endTime?: string; + endTime?: string | null; } /** * The content of a HL7v2 message in a structured format. @@ -898,11 +923,11 @@ export namespace healthcare_v1beta1 { /** * Determines whether messages with no header are allowed. */ - allowNullHeader?: boolean; + allowNullHeader?: boolean | null; /** * Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as segment terminator. */ - segmentTerminator?: string; + segmentTerminator?: string | null; } /** * A patient identifier and associated type. @@ -911,11 +936,11 @@ export namespace healthcare_v1beta1 { /** * ID type, e.g. MRN or NHS. */ - type?: string; + type?: string | null; /** * The patient's unique identifier. */ - value?: string; + value?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -932,11 +957,11 @@ export namespace healthcare_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * ProgressCounter provides counters to describe an operation's progress. @@ -945,15 +970,15 @@ export namespace healthcare_v1beta1 { /** * The number of units that failed in the operation. */ - failure?: string; + failure?: string | null; /** * The number of units that are pending in the operation. */ - pending?: string; + pending?: string | null; /** * The number of units that succeeded in the operation. */ - success?: string; + success?: string | null; } /** * Define how to redact sensitive values. Default behaviour is erase, e.g. "My name is Jake." becomes "My name is ." @@ -970,11 +995,11 @@ export namespace healthcare_v1beta1 { /** * The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. */ - recursiveStructureDepth?: string; + recursiveStructureDepth?: string | null; /** * Specifies the output schema type. If unspecified, the default is `LOSSLESS`. */ - schemaType?: string; + schemaType?: string | null; } /** * Request to search the resources in the specified FHIR store. @@ -983,7 +1008,7 @@ export namespace healthcare_v1beta1 { /** * 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). */ - resourceType?: string; + resourceType?: string | null; } /** * A segment in a structured format. @@ -992,15 +1017,15 @@ export namespace healthcare_v1beta1 { /** * A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: - (0.1, "foo"): Component 1 of Field 0 has the value "foo". - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value "bar". - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, has the value "baz". */ - fields?: {[key: string]: string}; + fields?: {[key: string]: string} | null; /** * A string that indicates the type of segment, e.g., EVN, PID. */ - segmentId?: string; + segmentId?: string | null; /** * Set ID for segments that can be in a set. This can be empty if it is missing or it is not applicable. */ - setId?: string; + setId?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -1013,7 +1038,7 @@ export namespace healthcare_v1beta1 { /** * 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; + updateMask?: 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). @@ -1022,15 +1047,15 @@ export namespace healthcare_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * List of tags to be filtered. @@ -1039,7 +1064,7 @@ export namespace healthcare_v1beta1 { /** * Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". */ - tags?: string[]; + tags?: string[] | null; } /** * Request message for `TestIamPermissions` method. @@ -1048,7 +1073,7 @@ export namespace healthcare_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -1057,7 +1082,7 @@ export namespace healthcare_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export interface Schema$TextConfig { /** @@ -1525,7 +1550,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.deidentify - * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails. + * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). * @example * * // BEFORE RUNNING: * // --------------- @@ -7190,7 +7215,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.export - * @desc Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * @desc Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @example * * // BEFORE RUNNING: * // --------------- @@ -7554,7 +7579,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except for the special case of `history`, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. If history imports are enabled by setting enable_history_import in the FHIR store's configuration, this method can import historical versions of a resource by supplying a bundle of type `history` and using the `BUNDLE` format. The historical versions in the bundle must have `lastUpdated` timestamps, and the resulting resource history on the server will appear as if the versions had been created at those timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected to avoid creating an inconsistent sequence of resource versions. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except for the special case of `history`, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. If history imports are enabled by setting enable_history_import in the FHIR store's configuration, this method can import historical versions of a resource by supplying a bundle of type `history` and using the `BUNDLE` format. The historical versions in the bundle must have `lastUpdated` timestamps, and the resulting resource history on the server will appear as if the versions had been created at those timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected to avoid creating an inconsistent sequence of resource versions. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/homegraph/v1.ts b/src/apis/homegraph/v1.ts index aee7dd533d7..4be23199158 100644 --- a/src/apis/homegraph/v1.ts +++ b/src/apis/homegraph/v1.ts @@ -126,7 +126,7 @@ export namespace homegraph_v1 { /** * Third-party partner's device ID. */ - id?: string; + id?: string | null; } /** * Identifies a device in the third party or first party system. @@ -135,11 +135,11 @@ export namespace homegraph_v1 { /** * The agent's ID. Generally it is the agent's AoG project id. */ - agentId?: string; + agentId?: string | null; /** * Device ID defined by the agent. The device_id must be unique. */ - deviceId?: string; + deviceId?: string | null; } /** * Third-party partner's device definition. @@ -148,11 +148,11 @@ export namespace homegraph_v1 { /** * Attributes for the traits supported by the device. */ - attributes?: {[key: string]: any}; + attributes?: {[key: string]: any} | null; /** * Custom JSON data provided by the manufacturer and attached to QUERY and EXECUTE requests in AoG. */ - customData?: string; + customData?: string | null; /** * Device manufacturer, model, hardware version, and software version. */ @@ -160,7 +160,7 @@ export namespace homegraph_v1 { /** * Third-party partner's device ID. */ - id?: string; + id?: string | null; /** * Name of the device given by the third party. This includes names given to the device via third party device manufacturer's app, model names for the device, etc. */ @@ -172,23 +172,23 @@ export namespace homegraph_v1 { /** * If the third-party partner's cloud configuration includes placing devices in rooms, the name of the room can be provided here. */ - roomHint?: string; + roomHint?: string | null; /** * As in roomHint, for structures that users set up in the partner's system. */ - structureHint?: string; + structureHint?: string | null; /** * Traits supported by the device. */ - traits?: string[]; + traits?: string[] | null; /** * Hardware type of the device (e.g. light, outlet, etc). */ - type?: string; + type?: string | null; /** * Indicates whether the state of this device is being reported to Google through ReportStateAndNotification call. */ - willReportState?: boolean; + willReportState?: boolean | null; } /** * Device information. @@ -197,19 +197,19 @@ export namespace homegraph_v1 { /** * Device hardware version. */ - hwVersion?: string; + hwVersion?: string | null; /** * Device manufacturer. */ - manufacturer?: string; + manufacturer?: string | null; /** * Device model. */ - model?: string; + model?: string | null; /** * Device software version. */ - swVersion?: string; + swVersion?: string | null; } /** * Different names for the device. @@ -218,15 +218,15 @@ export namespace homegraph_v1 { /** * List of names provided by the partner rather than the user, often manufacturer names, SKUs, etc. */ - defaultNames?: string[]; + defaultNames?: string[] | null; /** * Primary name of the device, generally provided by the user. */ - name?: string; + name?: string | null; /** * Additional names provided by the user for the device. */ - nicknames?: string[]; + nicknames?: 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 `{}`. @@ -239,7 +239,7 @@ export namespace homegraph_v1 { /** * Required. Third-party user ID. */ - agentUserId?: string; + agentUserId?: string | null; /** * Required. Inputs containing third-party partner's device IDs for which to get the device states. */ @@ -247,7 +247,7 @@ export namespace homegraph_v1 { /** * Request ID used for debugging. */ - requestId?: string; + requestId?: string | null; } /** * Device ID inputs to QueryRequest. @@ -278,7 +278,7 @@ export namespace homegraph_v1 { /** * Request ID used for debugging. Copied from the request. */ - requestId?: string; + requestId?: string | null; } /** * Payload containing device states information. @@ -287,7 +287,7 @@ export namespace homegraph_v1 { /** * States of the devices. Map of third-party device ID to struct of device states. */ - devices?: {[key: string]: {[key: string]: any}}; + devices?: {[key: string]: {[key: string]: any}} | null; } /** * The states and notifications specific to a device. @@ -296,11 +296,11 @@ export namespace homegraph_v1 { /** * Notifications metadata for devices. */ - notifications?: {[key: string]: any}; + notifications?: {[key: string]: any} | null; /** * States of devices to update. */ - states?: {[key: string]: any}; + states?: {[key: string]: any} | null; } /** * Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include States, Notifications, or both. This request uses globally unique flattened state names instead of namespaces based on traits to align with the existing QUERY and EXECUTE APIs implemented by 90+ Smart Home partners. States and notifications are defined per `device_id` (for example, "123" and "456" in the following example). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", "payload": { "devices": { "states": { "123": { "on": true }, "456": { "on": true, "brightness": 10 } }, } } } ``` @@ -309,15 +309,15 @@ export namespace homegraph_v1 { /** * Required. Third-party user ID. */ - agentUserId?: string; + agentUserId?: string | null; /** * Unique identifier per event (for example, a doorbell press). */ - eventId?: string; + eventId?: string | null; /** * Token to maintain state in the follow up notification response. */ - followUpToken?: string; + followUpToken?: string | null; /** * State of devices to update and notification metadata for devices. For example, if a user turns a light on manually, a state update should be sent so that the information is always the current status of the device. Notifications are independent from the state and its piece of the payload should contain everything necessary to notify the user. Although it may be related to a state change, it does not need to be. For example, if a device can turn on/off and change temperature, the states reported would include both "on" and "70 degrees" but the 3p may choose not to send any notification for that, or to only say that the "the room is heating up", keeping state and notification independent. */ @@ -325,7 +325,7 @@ export namespace homegraph_v1 { /** * Request ID used for debugging. */ - requestId?: string; + requestId?: string | null; } /** * Response type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. @@ -334,7 +334,7 @@ export namespace homegraph_v1 { /** * Request ID copied from ReportStateAndNotificationRequest. */ - requestId?: string; + requestId?: string | null; } /** * Request type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call. @@ -343,11 +343,11 @@ export namespace homegraph_v1 { /** * Required. Third-party user ID issued by agent's third-party identity provider. */ - agentUserId?: string; + agentUserId?: string | null; /** * Optional. If set, the request will be added to a queue and a response will be returned immediately. The queue allows for de-duplication of simultaneous requests. */ - async?: boolean; + async?: boolean | null; } /** * Response type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call. Intentionally empty upon success. An HTTP response code is returned with more details upon failure. @@ -369,11 +369,11 @@ export namespace homegraph_v1 { /** * Required. Third-party user ID. */ - agentUserId?: string; + agentUserId?: string | null; /** * Request ID used for debugging. */ - requestId?: string; + requestId?: string | null; } /** * Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should follow the same format as the Actions on Google `action.devices.SYNC` [response](/actions/smarthome/create-app#actiondevicessync). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "agentUserId": "1836.15267389", "devices": [{ "id": "123", "type": "action.devices.types.OUTLET", "traits": [ "action.devices.traits.OnOff" ], "name": { "defaultNames": ["My Outlet 1234"], "name": "Night light", "nicknames": ["wall plug"] }, "willReportState": false, "deviceInfo": { "manufacturer": "lights-out-inc", "model": "hs1234", "hwVersion": "3.2", "swVersion": "11.4" }, "customData": { "fooValue": 74, "barValue": true, "bazValue": "foo" } }] } } ``` @@ -386,7 +386,7 @@ export namespace homegraph_v1 { /** * Request ID used for debugging. Copied from the request. */ - requestId?: string; + requestId?: string | null; } /** * Payload containing device information. @@ -395,7 +395,7 @@ export namespace homegraph_v1 { /** * Third-party user ID */ - agentUserId?: string; + agentUserId?: string | null; /** * Devices associated with the third-party user. */ diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index bb374cdf208..b7620426ae2 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -141,7 +141,7 @@ export namespace iam_v1 { /** * Public name of the service. For example, the service name for Cloud IAM is 'iam.googleapis.com'. */ - name?: string; + name?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -154,7 +154,7 @@ export namespace iam_v1 { /** * 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; + service?: string | null; } /** * Audit log information specific to Cloud IAM. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message. @@ -172,11 +172,11 @@ export namespace iam_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -189,11 +189,11 @@ export namespace iam_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry. @@ -202,7 +202,7 @@ export namespace iam_v1 { /** * The action that was performed on a Binding. Required */ - action?: string; + action?: string | null; /** * The condition that is associated with this binding. This field is logged only for Cloud Audit Logging. */ @@ -210,11 +210,11 @@ export namespace iam_v1 { /** * A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required */ - member?: string; + member?: string | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required */ - role?: string; + role?: string | null; } /** * The request to create a new role. @@ -227,7 +227,7 @@ export namespace iam_v1 { /** * The role ID to use for this role. */ - roleId?: string; + roleId?: string | null; } /** * The service account key create request. @@ -236,11 +236,11 @@ export namespace iam_v1 { /** * Which type of key and algorithm to use for the key. The default is currently a 2K RSA key. However this may change in the future. */ - keyAlgorithm?: string; + keyAlgorithm?: string | null; /** * The output format of the private key. The default value is `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File format. */ - privateKeyType?: string; + privateKeyType?: string | null; } /** * The service account create request. @@ -249,7 +249,7 @@ export namespace iam_v1 { /** * Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. */ - accountId?: string; + accountId?: string | null; /** * The ServiceAccount resource to create. Currently, only the following values are user assignable: `display_name` . */ @@ -274,19 +274,19 @@ export namespace iam_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * The request to lint a Cloud IAM policy object. LintPolicy is currently functional only for `lint_object` of type `condition`. @@ -303,11 +303,11 @@ export namespace iam_v1 { /** * `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}; + 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; + 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. */ @@ -329,31 +329,31 @@ export namespace iam_v1 { /** * 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; + bindingOrdinal?: number | null; /** * Human readable debug message associated with the issue. */ - debugMessage?: string; + 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). */ - fieldName?: string; + fieldName?: string | null; /** * The validation unit level. */ - level?: string; + level?: string | null; /** * 0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression. */ - locationOffset?: number; + locationOffset?: number | null; /** * The validation unit severity. */ - severity?: string; + severity?: string | null; /** * The validation unit name, for instance “lintValidationUnits/ConditionComplexityCheck”. */ - validationUnitName?: string; + validationUnitName?: string | null; } /** * The response containing the roles defined under a resource. @@ -362,7 +362,7 @@ export namespace iam_v1 { /** * To retrieve the next page of results, set `ListRolesRequest.page_token` to this value. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The Roles defined on this resource. */ @@ -388,14 +388,14 @@ export namespace iam_v1 { /** * To retrieve the next page of results, set ListServiceAccountsRequest.page_token to this value. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The patch service account request. */ export interface Schema$PatchServiceAccountRequest { serviceAccount?: Schema$ServiceAccount; - updateMask?: string; + updateMask?: string | null; } /** * A permission which can be included by a role. @@ -404,35 +404,35 @@ export namespace iam_v1 { /** * The service API associated with the permission is not enabled. */ - apiDisabled?: boolean; + apiDisabled?: boolean | null; /** * The current custom role support level. */ - customRolesSupportLevel?: string; + customRolesSupportLevel?: string | null; /** * A brief description of what this Permission is used for. */ - description?: string; + description?: string | null; /** * The name of this Permission. */ - name?: string; + name?: string | null; /** * This permission can ONLY be used in predefined roles. */ - onlyInPredefinedRoles?: boolean; + onlyInPredefinedRoles?: boolean | null; /** * The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission. */ - primaryPermission?: string; + primaryPermission?: string | null; /** * The current launch stage of the permission. */ - stage?: string; + stage?: string | null; /** * The title of this Permission. */ - title?: string; + title?: string | null; } /** * A PermissionDelta message to record the added_permissions and removed_permissions inside a role. @@ -441,11 +441,11 @@ export namespace iam_v1 { /** * Added permissions. */ - addedPermissions?: string[]; + addedPermissions?: string[] | null; /** * Removed permissions. */ - removedPermissions?: string[]; + removedPermissions?: string[] | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -462,11 +462,11 @@ export namespace iam_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * The difference delta between two policies. @@ -484,7 +484,7 @@ export namespace iam_v1 { /** * Required. The full resource name to query from the list of auditable services. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. */ - fullResourceName?: string; + fullResourceName?: string | null; } /** * A response containing a list of auditable services for a resource. @@ -502,16 +502,16 @@ export namespace iam_v1 { /** * Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. */ - fullResourceName?: string; + fullResourceName?: string | null; /** * Optional limit on the number of roles to include in the response. */ - pageSize?: number; + pageSize?: number | null; /** * Optional pagination token returned in an earlier QueryGrantableRolesResponse. */ - pageToken?: string; - view?: string; + pageToken?: string | null; + view?: string | null; } /** * The grantable role query response. @@ -520,7 +520,7 @@ export namespace iam_v1 { /** * To retrieve the next page of results, set `QueryGrantableRolesRequest.page_token` to this value. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of matching roles. */ @@ -533,15 +533,15 @@ export namespace iam_v1 { /** * Required. The full resource name to query from the list of testable permissions. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. */ - fullResourceName?: string; + fullResourceName?: string | null; /** * Optional limit on the number of permissions to include in the response. */ - pageSize?: number; + pageSize?: number | null; /** * Optional pagination token returned in an earlier QueryTestablePermissionsRequest. */ - pageToken?: string; + pageToken?: string | null; } /** * The response containing permissions which can be tested on a resource. @@ -550,7 +550,7 @@ export namespace iam_v1 { /** * To retrieve the next page of results, set `QueryTestableRolesRequest.page_token` to this value. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The Permissions testable on the requested resource. */ @@ -563,31 +563,31 @@ export namespace iam_v1 { /** * The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole. */ - deleted?: boolean; + deleted?: boolean | null; /** * Optional. A human-readable description for the role. */ - description?: string; + description?: string | null; /** * Used to perform a consistent read-modify-write. */ - etag?: string; + etag?: string | null; /** * The names of the permissions this role grants when bound in an IAM policy. */ - includedPermissions?: string[]; + includedPermissions?: string[] | null; /** * The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles. */ - name?: string; + name?: string | null; /** * The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role. */ - stage?: string; + stage?: string | null; /** * Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. */ - title?: string; + title?: string | null; } /** * A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the 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. @@ -596,39 +596,39 @@ export namespace iam_v1 { /** * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. */ - description?: string; + description?: string | null; /** * @OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase. */ - disabled?: boolean; + disabled?: boolean | null; /** * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. */ - displayName?: string; + displayName?: string | null; /** * @OutputOnly The email address of the service account. */ - email?: string; + email?: string | null; /** * Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility. */ - etag?: string; + etag?: string | null; /** * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. */ - name?: string; + name?: string | null; /** * @OutputOnly The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users. */ - oauth2ClientId?: string; + oauth2ClientId?: string | null; /** * @OutputOnly The id of the project that owns the service account. */ - projectId?: string; + projectId?: string | null; /** * @OutputOnly The unique and stable id of the service account. */ - uniqueId?: string; + uniqueId?: string | null; } /** * Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. We recommend caching the public key set for a service account for no more than 24 hours to ensure you have access to the latest keys. Public keys for all service accounts are also published at the OAuth2 Service Account API. @@ -637,35 +637,35 @@ export namespace iam_v1 { /** * Specifies the algorithm (and possibly key size) for the key. */ - keyAlgorithm?: string; + keyAlgorithm?: string | null; /** * The key origin. */ - keyOrigin?: string; + keyOrigin?: string | null; /** * The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. */ - name?: string; + name?: string | null; /** * The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud auth activate-service-account</a>. */ - privateKeyData?: string; + privateKeyData?: string | null; /** * The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys. */ - privateKeyType?: string; + privateKeyType?: string | null; /** * The public key data. Only provided in `GetServiceAccountKey` responses. */ - publicKeyData?: string; + publicKeyData?: string | null; /** * The key can be used after this timestamp. */ - validAfterTime?: string; + validAfterTime?: string | null; /** - * The key can be used before this timestamp. + * The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time. */ - validBeforeTime?: string; + validBeforeTime?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -678,7 +678,7 @@ export namespace iam_v1 { /** * 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; + updateMask?: string | null; } /** * The service account sign blob request. @@ -687,7 +687,7 @@ export namespace iam_v1 { /** * The bytes to sign. */ - bytesToSign?: string; + bytesToSign?: string | null; } /** * The service account sign blob response. @@ -696,11 +696,11 @@ export namespace iam_v1 { /** * The id of the key used to sign the blob. */ - keyId?: string; + keyId?: string | null; /** * The signed blob. */ - signature?: string; + signature?: string | null; } /** * The service account sign JWT request. @@ -709,7 +709,7 @@ export namespace iam_v1 { /** * The JWT payload to sign, a JSON JWT Claim set. */ - payload?: string; + payload?: string | null; } /** * The service account sign JWT response. @@ -718,11 +718,11 @@ export namespace iam_v1 { /** * The id of the key used to sign the JWT. */ - keyId?: string; + keyId?: string | null; /** * The signed JWT. */ - signedJwt?: string; + signedJwt?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -731,7 +731,7 @@ export namespace iam_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -740,7 +740,7 @@ export namespace iam_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The request to undelete an existing role. @@ -749,7 +749,7 @@ export namespace iam_v1 { /** * Used to perform a consistent read-modify-write. */ - etag?: string; + etag?: string | null; } /** * The service account undelete request. @@ -768,7 +768,7 @@ export namespace iam_v1 { /** * A field that allows clients to upload their own public key. If set, use this public key data to create a service account key for given service account. Please note, the expected format for this field is X509_PEM. */ - publicKeyData?: string; + publicKeyData?: string | null; } export class Resource$Iampolicies { @@ -3648,7 +3648,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4851,7 +4851,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index db2646afdf2..5b4dd6920d0 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -121,85 +121,85 @@ export namespace iamcredentials_v1 { /** * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ - delegates?: string[]; + delegates?: string[] | null; /** * The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour. */ - lifetime?: string; + 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. */ - scope?: string[]; + scope?: string[] | null; } export interface Schema$GenerateAccessTokenResponse { /** * The OAuth 2.0 access token. */ - accessToken?: string; + accessToken?: string | null; /** * Token expiration time. The expiration time is always set. */ - expireTime?: string; + expireTime?: string | null; } export interface Schema$GenerateIdTokenRequest { /** * The audience for the token, such as the API or account that this token grants access to. */ - audience?: string; + audience?: string | null; /** * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ - delegates?: string[]; + delegates?: string[] | null; /** * Include the service account email in the token. If set to `true`, the token will contain `email` and `email_verified` claims. */ - includeEmail?: boolean; + includeEmail?: boolean | null; } export interface Schema$GenerateIdTokenResponse { /** * The OpenId Connect ID token. */ - token?: string; + token?: string | null; } export interface Schema$SignBlobRequest { /** * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ - delegates?: string[]; + delegates?: string[] | null; /** * The bytes to sign. */ - payload?: string; + payload?: string | null; } export interface Schema$SignBlobResponse { /** * The ID of the key used to sign the blob. */ - keyId?: string; + keyId?: string | null; /** * The signed blob. */ - signedBlob?: string; + signedBlob?: string | null; } export interface Schema$SignJwtRequest { /** * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ - delegates?: string[]; + delegates?: string[] | null; /** * The JWT payload to sign: a JSON object that contains a JWT Claims Set. */ - payload?: string; + payload?: string | null; } export interface Schema$SignJwtResponse { /** * The ID of the key used to sign the JWT. */ - keyId?: string; + keyId?: string | null; /** * The signed JWT. */ - signedJwt?: string; + signedJwt?: string | null; } export class Resource$Projects { diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 896060b764c..0a31ae908a6 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -128,11 +128,11 @@ export namespace iap_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -141,19 +141,19 @@ export namespace iap_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -169,9 +169,9 @@ export namespace iap_v1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -184,11 +184,11 @@ export namespace iap_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -206,7 +206,7 @@ export namespace iap_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -215,7 +215,7 @@ export namespace iap_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$V1 { diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index 94f66876184..bdfe35b812a 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -128,11 +128,11 @@ export namespace iap_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -141,19 +141,19 @@ export namespace iap_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -169,9 +169,9 @@ export namespace iap_v1beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -184,11 +184,11 @@ export namespace iap_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -206,7 +206,7 @@ export namespace iap_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -215,7 +215,7 @@ export namespace iap_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$V1beta1 { diff --git a/src/apis/identitytoolkit/v3.ts b/src/apis/identitytoolkit/v3.ts index 65d4b5f38c1..c879a6ddd3a 100644 --- a/src/apis/identitytoolkit/v3.ts +++ b/src/apis/identitytoolkit/v3.ts @@ -108,39 +108,39 @@ export namespace identitytoolkit_v3 { /** * all providers the user has once used to do federated login */ - allProviders?: string[]; + allProviders?: string[] | null; /** * The URI used by the IDP to authenticate the user. */ - authUri?: string; + authUri?: string | null; /** * True if captcha is required. */ - captchaRequired?: boolean; + captchaRequired?: boolean | null; /** * True if the authUri is for user's existing provider. */ - forExistingProvider?: boolean; + forExistingProvider?: boolean | null; /** * The fixed string identitytoolkit#CreateAuthUriResponse". */ - kind?: string; + kind?: string | null; /** * The provider ID of the auth URI. */ - providerId?: string; + providerId?: string | null; /** * Whether the user is registered if the identifier is an email. */ - registered?: boolean; + registered?: boolean | null; /** * Session ID which should be passed in the following verifyAssertion request. */ - sessionId?: string; + sessionId?: string | null; /** * All sign-in methods this user has used. */ - signinMethods?: string[]; + signinMethods?: string[] | null; } /** * Respone of deleting account. @@ -149,7 +149,7 @@ export namespace identitytoolkit_v3 { /** * The fixed string "identitytoolkit#DeleteAccountResponse". */ - kind?: string; + kind?: string | null; } /** * Response of downloading accounts in batch. @@ -158,11 +158,11 @@ export namespace identitytoolkit_v3 { /** * The fixed string "identitytoolkit#DownloadAccountResponse". */ - kind?: string; + kind?: string | null; /** * The next page token. To be used in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The user accounts data. */ @@ -175,31 +175,31 @@ export namespace identitytoolkit_v3 { /** * The user's email. */ - email?: string; + email?: string | null; /** * Expiration time of STS id token in seconds. */ - expiresIn?: string; + expiresIn?: string | null; /** * The STS id token to login the newly signed in user. */ - idToken?: string; + idToken?: string | null; /** * Whether the user is new. */ - isNewUser?: boolean; + isNewUser?: boolean | null; /** * The fixed string "identitytoolkit#EmailLinkSigninResponse". */ - kind?: string; + kind?: string | null; /** * The RP local ID of the user. */ - localId?: string; + localId?: string | null; /** * The refresh token for the signed in user. */ - refreshToken?: string; + refreshToken?: string | null; } /** * Template for an email template. @@ -208,27 +208,27 @@ export namespace identitytoolkit_v3 { /** * Email body. */ - body?: string; + body?: string | null; /** * Email body format. */ - format?: string; + format?: string | null; /** * From address of the email. */ - from?: string; + from?: string | null; /** * From display name. */ - fromDisplayName?: string; + fromDisplayName?: string | null; /** * Reply-to address. */ - replyTo?: string; + replyTo?: string | null; /** * Subject of the email. */ - subject?: string; + subject?: string | null; } /** * Response of getting account information. @@ -237,7 +237,7 @@ export namespace identitytoolkit_v3 { /** * The fixed string "identitytoolkit#GetAccountInfoResponse". */ - kind?: string; + kind?: string | null; /** * The info of the users. */ @@ -250,15 +250,15 @@ export namespace identitytoolkit_v3 { /** * The email address that the email is sent to. */ - email?: string; + email?: string | null; /** * The fixed string "identitytoolkit#GetOobConfirmationCodeResponse". */ - kind?: string; + kind?: string | null; /** * The code to be send to the user. */ - oobCode?: string; + oobCode?: string | null; } /** * Response of getting recaptcha param. @@ -267,15 +267,15 @@ export namespace identitytoolkit_v3 { /** * The fixed string "identitytoolkit#GetRecaptchaParamResponse". */ - kind?: string; + kind?: string | null; /** * Site key registered at recaptcha. */ - recaptchaSiteKey?: string; + recaptchaSiteKey?: string | null; /** * The stoken field for the recaptcha widget, used to request captcha challenge. */ - recaptchaStoken?: string; + recaptchaStoken?: string | null; } /** * Request to get the IDP authentication URL. @@ -284,67 +284,67 @@ export namespace identitytoolkit_v3 { /** * The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS. */ - appId?: string; + appId?: string | null; /** * Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider. */ - authFlowType?: string; + authFlowType?: string | null; /** * The relying party OAuth client ID. */ - clientId?: string; + clientId?: string | null; /** * The opaque value used by the client to maintain context info between the authentication request and the IDP callback. */ - context?: string; + context?: string | null; /** * The URI to which the IDP redirects the user after the federated login flow. */ - continueUri?: string; + continueUri?: string | null; /** * The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token. */ - customParameter?: {[key: string]: string}; + customParameter?: {[key: string]: string} | null; /** * The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts. */ - hostedDomain?: string; + hostedDomain?: string | null; /** * The email or federated ID of the user. */ - identifier?: string; + identifier?: string | null; /** * The developer's consumer key for OpenId OAuth Extension */ - oauthConsumerKey?: string; + oauthConsumerKey?: string | null; /** * Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant */ - oauthScope?: string; + oauthScope?: string | null; /** * Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set. */ - openidRealm?: string; + openidRealm?: string | null; /** * The native app package for OTA installation. */ - otaApp?: string; + otaApp?: string | null; /** * The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier. */ - providerId?: string; + providerId?: string | null; /** * The session_id passed by client. */ - sessionId?: string; + sessionId?: string | null; /** * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ - tenantId?: string; + tenantId?: string | null; /** * Tenant project number to be used for idp discovery. */ - tenantProjectNumber?: string; + tenantProjectNumber?: string | null; } /** * Request to delete account. @@ -353,15 +353,15 @@ export namespace identitytoolkit_v3 { /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * The GITKit token or STS id token of the authenticated user. */ - idToken?: string; + idToken?: string | null; /** * The local ID of the user. */ - localId?: string; + localId?: string | null; } /** * Request to download user account in batch. @@ -370,19 +370,19 @@ export namespace identitytoolkit_v3 { /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * The max number of results to return in the response. */ - maxResults?: number; + maxResults?: number | null; /** * The token for the next page. This should be taken from the previous response. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Specify which project (field value is actually project id) to operate. Only used when provided credential. */ - targetProjectId?: string; + targetProjectId?: string | null; } /** * Request to sign in with email. @@ -391,15 +391,15 @@ export namespace identitytoolkit_v3 { /** * The email address of the user. */ - email?: string; + email?: string | null; /** * Token for linking flow. */ - idToken?: string; + idToken?: string | null; /** * The confirmation code. */ - oobCode?: string; + oobCode?: string | null; } /** * Request to get the account information. @@ -408,23 +408,23 @@ export namespace identitytoolkit_v3 { /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * The list of emails of the users to inquiry. */ - email?: string[]; + email?: string[] | null; /** * The GITKit token of the authenticated user. */ - idToken?: string; + idToken?: string | null; /** * The list of local ID's of the users to inquiry. */ - localId?: string[]; + localId?: string[] | null; /** * Privileged caller can query users by specified phone number. */ - phoneNumber?: string[]; + phoneNumber?: string[] | null; } /** * Response of getting the project configuration. @@ -433,24 +433,24 @@ export namespace identitytoolkit_v3 { /** * Whether to allow password user sign in or sign up. */ - allowPasswordUser?: boolean; + allowPasswordUser?: boolean | null; /** * Browser API key, needed when making http request to Apiary. */ - apiKey?: string; + apiKey?: string | null; /** * Authorized domains. */ - authorizedDomains?: string[]; + authorizedDomains?: string[] | null; /** * Change email template. */ changeEmailTemplate?: Schema$EmailTemplate; - dynamicLinksDomain?: string; + dynamicLinksDomain?: string | null; /** * Whether anonymous user is enabled. */ - enableAnonymousUser?: boolean; + enableAnonymousUser?: boolean | null; /** * OAuth2 provider configuration. */ @@ -462,7 +462,7 @@ export namespace identitytoolkit_v3 { /** * Project ID of the relying party. */ - projectId?: string; + projectId?: string | null; /** * Reset password email template. */ @@ -470,7 +470,7 @@ export namespace identitytoolkit_v3 { /** * Whether to use email sending provided by Firebear. */ - useEmailSending?: boolean; + useEmailSending?: boolean | null; /** * Verify email template. */ @@ -487,19 +487,19 @@ export namespace identitytoolkit_v3 { /** * The email address of the user. */ - email?: string; + email?: string | null; /** * The new password inputted by the user. */ - newPassword?: string; + newPassword?: string | null; /** * The old password inputted by the user. */ - oldPassword?: string; + oldPassword?: string | null; /** * The confirmation code. */ - oobCode?: string; + oobCode?: string | null; } /** * Request for Identitytoolkit-SendVerificationCode @@ -508,19 +508,19 @@ export namespace identitytoolkit_v3 { /** * Receipt of successful app token validation with APNS. */ - iosReceipt?: string; + iosReceipt?: string | null; /** * Secret delivered to iOS app via APNS. */ - iosSecret?: string; + iosSecret?: string | null; /** * The phone number to send the verification code to in E.164 format. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * Recaptcha solution. */ - recaptchaToken?: string; + recaptchaToken?: string | null; } /** * Response for Identitytoolkit-SendVerificationCode @@ -529,7 +529,7 @@ export namespace identitytoolkit_v3 { /** * Encrypted session information */ - sessionInfo?: string; + sessionInfo?: string | null; } /** * Request to set the account information. @@ -538,95 +538,95 @@ export namespace identitytoolkit_v3 { /** * The captcha challenge. */ - captchaChallenge?: string; + captchaChallenge?: string | null; /** * Response to the captcha. */ - captchaResponse?: string; + captchaResponse?: string | null; /** * The timestamp when the account is created. */ - createdAt?: string; + createdAt?: string | null; /** * The custom attributes to be set in the user's id token. */ - customAttributes?: string; + customAttributes?: string | null; /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * The attributes users request to delete. */ - deleteAttribute?: string[]; + deleteAttribute?: string[] | null; /** * The IDPs the user request to delete. */ - deleteProvider?: string[]; + deleteProvider?: string[] | null; /** * Whether to disable the user. */ - disableUser?: boolean; + disableUser?: boolean | null; /** * The name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email of the user. */ - email?: string; + email?: string | null; /** * Mark the email as verified or not. */ - emailVerified?: boolean; + emailVerified?: boolean | null; /** * The GITKit token of the authenticated user. */ - idToken?: string; + idToken?: string | null; /** * Instance id token of the app. */ - instanceId?: string; + instanceId?: string | null; /** * Last login timestamp. */ - lastLoginAt?: string; + lastLoginAt?: string | null; /** * The local ID of the user. */ - localId?: string; + localId?: string | null; /** * The out-of-band code of the change email request. */ - oobCode?: string; + oobCode?: string | null; /** * The new password of the user. */ - password?: string; + password?: string | null; /** * Privileged caller can update user with specified phone number. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * The photo url of the user. */ - photoUrl?: string; + photoUrl?: string | null; /** * The associated IDPs of the user. */ - provider?: string[]; + provider?: string[] | null; /** * Whether return sts id token and refresh token instead of gitkit token. */ - returnSecureToken?: boolean; + returnSecureToken?: boolean | null; /** * Mark the user to upgrade to federated login. */ - upgradeToFederatedLogin?: boolean; + upgradeToFederatedLogin?: boolean | null; /** * Timestamp in seconds for valid login token. */ - validSince?: string; + validSince?: string | null; } /** * Request to set the project configuration. @@ -635,15 +635,15 @@ export namespace identitytoolkit_v3 { /** * Whether to allow password user sign in or sign up. */ - allowPasswordUser?: boolean; + allowPasswordUser?: boolean | null; /** * Browser API key, needed when making http request to Apiary. */ - apiKey?: string; + apiKey?: string | null; /** * Authorized domains for widget redirect. */ - authorizedDomains?: string[]; + authorizedDomains?: string[] | null; /** * Change email template. */ @@ -651,11 +651,11 @@ export namespace identitytoolkit_v3 { /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * Whether to enable anonymous user. */ - enableAnonymousUser?: boolean; + enableAnonymousUser?: boolean | null; /** * Oauth2 provider configuration. */ @@ -671,7 +671,7 @@ export namespace identitytoolkit_v3 { /** * Whether to use email sending provided by Firebear. */ - useEmailSending?: boolean; + useEmailSending?: boolean | null; /** * Verify email template. */ @@ -684,7 +684,7 @@ export namespace identitytoolkit_v3 { /** * Project ID of the relying party. */ - projectId?: string; + projectId?: string | null; } /** * Request to sign out user. @@ -693,11 +693,11 @@ export namespace identitytoolkit_v3 { /** * Instance id token of the app. */ - instanceId?: string; + instanceId?: string | null; /** * The local ID of the user. */ - localId?: string; + localId?: string | null; } /** * Response of signing out user. @@ -706,7 +706,7 @@ export namespace identitytoolkit_v3 { /** * The local ID of the user. */ - localId?: string; + localId?: string | null; } /** * Request to signup new user, create anonymous user or anonymous user reauth. @@ -715,59 +715,59 @@ export namespace identitytoolkit_v3 { /** * The captcha challenge. */ - captchaChallenge?: string; + captchaChallenge?: string | null; /** * Response to the captcha. */ - captchaResponse?: string; + captchaResponse?: string | null; /** * Whether to disable the user. Only can be used by service account. */ - disabled?: boolean; + disabled?: boolean | null; /** * The name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email of the user. */ - email?: string; + email?: string | null; /** * Mark the email as verified or not. Only can be used by service account. */ - emailVerified?: boolean; + emailVerified?: boolean | null; /** * The GITKit token of the authenticated user. */ - idToken?: string; + idToken?: string | null; /** * Instance id token of the app. */ - instanceId?: string; + instanceId?: string | null; /** * Privileged caller can create user with specified user id. */ - localId?: string; + localId?: string | null; /** * The new password of the user. */ - password?: string; + password?: string | null; /** * Privileged caller can create user with specified phone number. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * The photo url of the user. */ - photoUrl?: string; + photoUrl?: string | null; /** * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ - tenantId?: string; + tenantId?: string | null; /** * Tenant project number to be used for idp discovery. */ - tenantProjectNumber?: string; + tenantProjectNumber?: string | null; } /** * Request to upload user account in batch. @@ -776,46 +776,46 @@ export namespace identitytoolkit_v3 { /** * Whether allow overwrite existing account when user local_id exists. */ - allowOverwrite?: boolean; - blockSize?: number; + allowOverwrite?: boolean | null; + blockSize?: number | null; /** * The following 4 fields are for standard scrypt algorithm. */ - cpuMemCost?: number; + cpuMemCost?: number | null; /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; - dkLen?: number; + delegatedProjectNumber?: string | null; + dkLen?: number | null; /** * The password hash algorithm. */ - hashAlgorithm?: string; + hashAlgorithm?: string | null; /** * Memory cost for hash calculation. Used by scrypt similar algorithms. */ - memoryCost?: number; - parallelization?: number; + memoryCost?: number | null; + parallelization?: number | null; /** * Rounds for hash calculation. Used by scrypt and similar algorithms. */ - rounds?: number; + rounds?: number | null; /** * The salt separator. */ - saltSeparator?: string; + saltSeparator?: string | null; /** * If true, backend will do sanity check(including duplicate email and federated id) when uploading account. */ - sanityCheck?: boolean; + sanityCheck?: boolean | null; /** * The key for to hash the password. */ - signerKey?: string; + signerKey?: string | null; /** * Specify which project (field value is actually project id) to operate. Only used when provided credential. */ - targetProjectId?: string; + targetProjectId?: string | null; /** * The account info to be stored. */ @@ -828,55 +828,55 @@ export namespace identitytoolkit_v3 { /** * When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist. */ - autoCreate?: boolean; + autoCreate?: boolean | null; /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * The GITKit token of the authenticated user. */ - idToken?: string; + idToken?: string | null; /** * Instance id token of the app. */ - instanceId?: string; + instanceId?: string | null; /** * The GITKit token for the non-trusted IDP pending to be confirmed by the user. */ - pendingIdToken?: string; + pendingIdToken?: string | null; /** * The post body if the request is a HTTP POST. */ - postBody?: string; + postBody?: string | null; /** * The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP. */ - requestUri?: string; + requestUri?: string | null; /** * Whether return 200 and IDP credential rather than throw exception when federated id is already linked. */ - returnIdpCredential?: boolean; + returnIdpCredential?: boolean | null; /** * Whether to return refresh tokens. */ - returnRefreshToken?: boolean; + returnRefreshToken?: boolean | null; /** * Whether return sts id token and refresh token instead of gitkit token. */ - returnSecureToken?: boolean; + returnSecureToken?: boolean | null; /** * Session ID, which should match the one in previous createAuthUri request. */ - sessionId?: string; + sessionId?: string | null; /** * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ - tenantId?: string; + tenantId?: string | null; /** * Tenant project number to be used for idp discovery. */ - tenantProjectNumber?: string; + tenantProjectNumber?: string | null; } /** * Request to verify a custom token @@ -885,19 +885,19 @@ export namespace identitytoolkit_v3 { /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * Instance id token of the app. */ - instanceId?: string; + instanceId?: string | null; /** * Whether return sts id token and refresh token instead of gitkit token. */ - returnSecureToken?: boolean; + returnSecureToken?: boolean | null; /** * The custom token to verify */ - token?: string; + token?: string | null; } /** * Request to verify the password. @@ -906,77 +906,77 @@ export namespace identitytoolkit_v3 { /** * The captcha challenge. */ - captchaChallenge?: string; + captchaChallenge?: string | null; /** * Response to the captcha. */ - captchaResponse?: string; + captchaResponse?: string | null; /** * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ - delegatedProjectNumber?: string; + delegatedProjectNumber?: string | null; /** * The email of the user. */ - email?: string; + email?: string | null; /** * The GITKit token of the authenticated user. */ - idToken?: string; + idToken?: string | null; /** * Instance id token of the app. */ - instanceId?: string; + instanceId?: string | null; /** * The password inputed by the user. */ - password?: string; + password?: string | null; /** * The GITKit token for the non-trusted IDP, which is to be confirmed by the user. */ - pendingIdToken?: string; + pendingIdToken?: string | null; /** * Whether return sts id token and refresh token instead of gitkit token. */ - returnSecureToken?: boolean; + returnSecureToken?: boolean | null; /** * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ - tenantId?: string; + tenantId?: string | null; /** * Tenant project number to be used for idp discovery. */ - tenantProjectNumber?: string; + tenantProjectNumber?: string | null; } /** * Request for Identitytoolkit-VerifyPhoneNumber */ export interface Schema$IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest { - code?: string; - idToken?: string; - operation?: string; - phoneNumber?: string; + code?: string | null; + idToken?: string | null; + operation?: string | null; + phoneNumber?: string | null; /** * The session info previously returned by IdentityToolkit-SendVerificationCode. */ - sessionInfo?: string; - temporaryProof?: string; - verificationProof?: string; + sessionInfo?: string | null; + temporaryProof?: string | null; + verificationProof?: string | null; } /** * Response for Identitytoolkit-VerifyPhoneNumber */ export interface Schema$IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse { - expiresIn?: string; - idToken?: string; - isNewUser?: boolean; - localId?: string; - phoneNumber?: string; - refreshToken?: string; - temporaryProof?: string; - temporaryProofExpiresIn?: string; - verificationProof?: string; - verificationProofExpiresIn?: string; + expiresIn?: string | null; + idToken?: string | null; + isNewUser?: boolean | null; + localId?: string | null; + phoneNumber?: string | null; + refreshToken?: string | null; + temporaryProof?: string | null; + temporaryProofExpiresIn?: string | null; + verificationProof?: string | null; + verificationProofExpiresIn?: string | null; } /** * Template for a single idp configuration. @@ -985,27 +985,27 @@ export namespace identitytoolkit_v3 { /** * OAuth2 client ID. */ - clientId?: string; + clientId?: string | null; /** * Whether this IDP is enabled. */ - enabled?: boolean; + enabled?: boolean | null; /** * Percent of users who will be prompted/redirected federated login for this IDP. */ - experimentPercent?: number; + experimentPercent?: number | null; /** * OAuth2 provider. */ - provider?: string; + provider?: string | null; /** * OAuth2 client secret. */ - secret?: string; + secret?: string | null; /** * Whitelisted client IDs for audience check. */ - whitelistedAudiences?: string[]; + whitelistedAudiences?: string[] | null; } /** * Request of getting a code for user confirmation (reset password, change email etc.) @@ -1014,63 +1014,63 @@ export namespace identitytoolkit_v3 { /** * whether or not to install the android app on the device where the link is opened */ - androidInstallApp?: boolean; + androidInstallApp?: boolean | null; /** * minimum version of the app. if the version on the device is lower than this version then the user is taken to the play store to upgrade the app */ - androidMinimumVersion?: string; + androidMinimumVersion?: string | null; /** * android package name of the android app to handle the action code */ - androidPackageName?: string; + androidPackageName?: string | null; /** * whether or not the app can handle the oob code without first going to web */ - canHandleCodeInApp?: boolean; + canHandleCodeInApp?: boolean | null; /** * The recaptcha response from the user. */ - captchaResp?: string; + captchaResp?: string | null; /** * The recaptcha challenge presented to the user. */ - challenge?: string; + challenge?: string | null; /** * The url to continue to the Gitkit app */ - continueUrl?: string; + continueUrl?: string | null; /** * The email of the user. */ - email?: string; + email?: string | null; /** * The user's Gitkit login token for email change. */ - idToken?: string; + idToken?: string | null; /** * iOS app store id to download the app if it's not already installed */ - iOSAppStoreId?: string; + iOSAppStoreId?: string | null; /** * the iOS bundle id of iOS app to handle the action code */ - iOSBundleId?: string; + iOSBundleId?: string | null; /** * The fixed string "identitytoolkit#relyingparty". */ - kind?: string; + kind?: string | null; /** * The new email if the code is for email change. */ - newEmail?: string; + newEmail?: string | null; /** * The request type. */ - requestType?: string; + requestType?: string | null; /** * The IP address of the user. */ - userIp?: string; + userIp?: string | null; } /** * Response of resetting the password. @@ -1079,19 +1079,19 @@ export namespace identitytoolkit_v3 { /** * The user's email. If the out-of-band code is for email recovery, the user's original email. */ - email?: string; + email?: string | null; /** * The fixed string "identitytoolkit#ResetPasswordResponse". */ - kind?: string; + kind?: string | null; /** * If the out-of-band code is for email recovery, the user's new email. */ - newEmail?: string; + newEmail?: string | null; /** * The request type. */ - requestType?: string; + requestType?: string | null; } /** * Respone of setting the account information. @@ -1100,43 +1100,43 @@ export namespace identitytoolkit_v3 { /** * The name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email of the user. */ - email?: string; + email?: string | null; /** * If email has been verified. */ - emailVerified?: boolean; + emailVerified?: boolean | null; /** * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ - expiresIn?: string; + expiresIn?: string | null; /** * The Gitkit id token to login the newly sign up user. */ - idToken?: string; + idToken?: string | null; /** * The fixed string "identitytoolkit#SetAccountInfoResponse". */ - kind?: string; + kind?: string | null; /** * The local ID of the user. */ - localId?: string; + localId?: string | null; /** * The new email the user attempts to change to. */ - newEmail?: string; + newEmail?: string | null; /** * The user's hashed password. */ - passwordHash?: string; + passwordHash?: string | null; /** * The photo url of the user. */ - photoUrl?: string; + photoUrl?: string | null; /** * The user's profiles at the associated IdPs. */ @@ -1145,11 +1145,11 @@ export namespace identitytoolkit_v3 { federatedId?: string; photoUrl?: string; providerId?: string; - }>; + }> | null; /** * If idToken is STS id token, then this field will be refresh token. */ - refreshToken?: string; + refreshToken?: string | null; } /** * Response of signing up new user, creating anonymous user or anonymous user reauth. @@ -1158,31 +1158,31 @@ export namespace identitytoolkit_v3 { /** * The name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email of the user. */ - email?: string; + email?: string | null; /** * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ - expiresIn?: string; + expiresIn?: string | null; /** * The Gitkit id token to login the newly sign up user. */ - idToken?: string; + idToken?: string | null; /** * The fixed string "identitytoolkit#SignupNewUserResponse". */ - kind?: string; + kind?: string | null; /** * The RP local ID of the user. */ - localId?: string; + localId?: string | null; /** * If idToken is STS id token, then this field will be refresh token. */ - refreshToken?: string; + refreshToken?: string | null; } /** * Respone of uploading accounts in batch. @@ -1191,11 +1191,11 @@ export namespace identitytoolkit_v3 { /** * The error encountered while processing the account info. */ - error?: Array<{index?: number; message?: string}>; + error?: Array<{index?: number; message?: string}> | null; /** * The fixed string "identitytoolkit#UploadAccountResponse". */ - kind?: string; + kind?: string | null; } /** * Template for an individual account info. @@ -1204,55 +1204,55 @@ export namespace identitytoolkit_v3 { /** * User creation timestamp. */ - createdAt?: string; + createdAt?: string | null; /** * The custom attributes to be set in the user's id token. */ - customAttributes?: string; + customAttributes?: string | null; /** * Whether the user is authenticated by the developer. */ - customAuth?: boolean; + customAuth?: boolean | null; /** * Whether the user is disabled. */ - disabled?: boolean; + disabled?: boolean | null; /** * The name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email of the user. */ - email?: string; + email?: string | null; /** * Whether the email has been verified. */ - emailVerified?: boolean; + emailVerified?: boolean | null; /** * last login timestamp. */ - lastLoginAt?: string; + lastLoginAt?: string | null; /** * The local ID of the user. */ - localId?: string; + localId?: string | null; /** * The user's hashed password. */ - passwordHash?: string; + passwordHash?: string | null; /** * The timestamp when the password was last updated. */ - passwordUpdatedAt?: number; + passwordUpdatedAt?: number | null; /** * User's phone number. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * The URL of the user profile photo. */ - photoUrl?: string; + photoUrl?: string | null; /** * The IDP of the user. */ @@ -1265,27 +1265,27 @@ export namespace identitytoolkit_v3 { providerId?: string; rawId?: string; screenName?: string; - }>; + }> | null; /** * The user's plain text password. */ - rawPassword?: string; + rawPassword?: string | null; /** * The user's password salt. */ - salt?: string; + salt?: string | null; /** * User's screen name at Twitter or login name at Github. */ - screenName?: string; + screenName?: string | null; /** * Timestamp in seconds for valid login token. */ - validSince?: string; + validSince?: string | null; /** * Version of the user's password. */ - version?: number; + version?: number | null; } /** * Response of verifying the IDP assertion. @@ -1294,159 +1294,159 @@ export namespace identitytoolkit_v3 { /** * The action code. */ - action?: string; + action?: string | null; /** * URL for OTA app installation. */ - appInstallationUrl?: string; + appInstallationUrl?: string | null; /** * The custom scheme used by mobile app. */ - appScheme?: string; + appScheme?: string | null; /** * The opaque value used by the client to maintain context info between the authentication request and the IDP callback. */ - context?: string; + context?: string | null; /** * The birth date of the IdP account. */ - dateOfBirth?: string; + dateOfBirth?: string | null; /** * The display name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email returned by the IdP. NOTE: The federated login user may not own the email. */ - email?: string; + email?: string | null; /** * It's true if the email is recycled. */ - emailRecycled?: boolean; + emailRecycled?: boolean | null; /** * The value is true if the IDP is also the email provider. It means the user owns the email. */ - emailVerified?: boolean; + emailVerified?: boolean | null; /** * Client error code. */ - errorMessage?: string; + errorMessage?: string | null; /** * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ - expiresIn?: string; + expiresIn?: string | null; /** * The unique ID identifies the IdP account. */ - federatedId?: string; + federatedId?: string | null; /** * The first name of the user. */ - firstName?: string; + firstName?: string | null; /** * The full name of the user. */ - fullName?: string; + fullName?: string | null; /** * The ID token. */ - idToken?: string; + idToken?: string | null; /** * It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email. */ - inputEmail?: string; + inputEmail?: string | null; /** * True if it's a new user sign-in, false if it's a returning user. */ - isNewUser?: boolean; + isNewUser?: boolean | null; /** * The fixed string "identitytoolkit#VerifyAssertionResponse". */ - kind?: string; + kind?: string | null; /** * The language preference of the user. */ - language?: string; + language?: string | null; /** * The last name of the user. */ - lastName?: string; + lastName?: string | null; /** * The RP local ID if it's already been mapped to the IdP account identified by the federated ID. */ - localId?: string; + localId?: string | null; /** * Whether the assertion is from a non-trusted IDP and need account linking confirmation. */ - needConfirmation?: boolean; + needConfirmation?: boolean | null; /** * Whether need client to supply email to complete the federated login flow. */ - needEmail?: boolean; + needEmail?: boolean | null; /** * The nick name of the user. */ - nickName?: string; + nickName?: string | null; /** * The OAuth2 access token. */ - oauthAccessToken?: string; + oauthAccessToken?: string | null; /** * The OAuth2 authorization code. */ - oauthAuthorizationCode?: string; + oauthAuthorizationCode?: string | null; /** * The lifetime in seconds of the OAuth2 access token. */ - oauthExpireIn?: number; + oauthExpireIn?: number | null; /** * The OIDC id token. */ - oauthIdToken?: string; + oauthIdToken?: string | null; /** * The user approved request token for the OpenID OAuth extension. */ - oauthRequestToken?: string; + oauthRequestToken?: string | null; /** * The scope for the OpenID OAuth extension. */ - oauthScope?: string; + oauthScope?: string | null; /** * The OAuth1 access token secret. */ - oauthTokenSecret?: string; + oauthTokenSecret?: string | null; /** * The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email. */ - originalEmail?: string; + originalEmail?: string | null; /** * The URI of the public accessible profiel picture. */ - photoUrl?: string; + photoUrl?: string | null; /** * The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned. */ - providerId?: string; + providerId?: string | null; /** * Raw IDP-returned user info. */ - rawUserInfo?: string; + rawUserInfo?: string | null; /** * If idToken is STS id token, then this field will be refresh token. */ - refreshToken?: string; + refreshToken?: string | null; /** * The screen_name of a Twitter user or the login name at Github. */ - screenName?: string; + screenName?: string | null; /** * The timezone of the user. */ - timeZone?: string; + timeZone?: string | null; /** * When action is 'map', contains the idps which can be used for confirmation. */ - verifiedProvider?: string[]; + verifiedProvider?: string[] | null; } /** * Response from verifying a custom token @@ -1455,23 +1455,23 @@ export namespace identitytoolkit_v3 { /** * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ - expiresIn?: string; + expiresIn?: string | null; /** * The GITKit token for authenticated user. */ - idToken?: string; + idToken?: string | null; /** * True if it's a new user sign-in, false if it's a returning user. */ - isNewUser?: boolean; + isNewUser?: boolean | null; /** * The fixed string "identitytoolkit#VerifyCustomTokenResponse". */ - kind?: string; + kind?: string | null; /** * If idToken is STS id token, then this field will be refresh token. */ - refreshToken?: string; + refreshToken?: string | null; } /** * Request of verifying the password. @@ -1480,51 +1480,51 @@ export namespace identitytoolkit_v3 { /** * The name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email returned by the IdP. NOTE: The federated login user may not own the email. */ - email?: string; + email?: string | null; /** * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ - expiresIn?: string; + expiresIn?: string | null; /** * The GITKit token for authenticated user. */ - idToken?: string; + idToken?: string | null; /** * The fixed string "identitytoolkit#VerifyPasswordResponse". */ - kind?: string; + kind?: string | null; /** * The RP local ID if it's already been mapped to the IdP account identified by the federated ID. */ - localId?: string; + localId?: string | null; /** * The OAuth2 access token. */ - oauthAccessToken?: string; + oauthAccessToken?: string | null; /** * The OAuth2 authorization code. */ - oauthAuthorizationCode?: string; + oauthAuthorizationCode?: string | null; /** * The lifetime in seconds of the OAuth2 access token. */ - oauthExpireIn?: number; + oauthExpireIn?: number | null; /** * The URI of the user's photo at IdP */ - photoUrl?: string; + photoUrl?: string | null; /** * If idToken is STS id token, then this field will be refresh token. */ - refreshToken?: string; + refreshToken?: string | null; /** * Whether the email is registered. */ - registered?: boolean; + registered?: boolean | null; } export class Resource$Relyingparty { diff --git a/src/apis/index.ts b/src/apis/index.ts index 9dcff723d44..9616ad827a9 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -33,6 +33,7 @@ import * as androidpublisher from './androidpublisher'; import * as appengine from './appengine'; import * as appsactivity from './appsactivity'; import * as bigquery from './bigquery'; +import * as bigqueryconnection from './bigqueryconnection'; import * as bigquerydatatransfer from './bigquerydatatransfer'; import * as bigqueryreservation from './bigqueryreservation'; import * as bigtableadmin from './bigtableadmin'; @@ -201,6 +202,7 @@ export const APIS: APIList = { appengine: appengine.VERSIONS, appsactivity: appsactivity.VERSIONS, bigquery: bigquery.VERSIONS, + bigqueryconnection: bigqueryconnection.VERSIONS, bigquerydatatransfer: bigquerydatatransfer.VERSIONS, bigqueryreservation: bigqueryreservation.VERSIONS, bigtableadmin: bigtableadmin.VERSIONS, @@ -366,6 +368,7 @@ export class GeneratedAPIs { appengine = appengine.appengine; appsactivity = appsactivity.appsactivity; bigquery = bigquery.bigquery; + bigqueryconnection = bigqueryconnection.bigqueryconnection; bigquerydatatransfer = bigquerydatatransfer.bigquerydatatransfer; bigqueryreservation = bigqueryreservation.bigqueryreservation; bigtableadmin = bigtableadmin.bigtableadmin; diff --git a/src/apis/indexing/v3.ts b/src/apis/indexing/v3.ts index 11695cb6e5f..e4b82c115f4 100644 --- a/src/apis/indexing/v3.ts +++ b/src/apis/indexing/v3.ts @@ -133,15 +133,15 @@ export namespace indexing_v3 { /** * Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. */ - notifyTime?: string; + notifyTime?: string | null; /** * The URL life cycle event that Google is being notified about. */ - type?: string; + type?: string | null; /** * The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. */ - url?: string; + url?: string | null; } /** * Summary of the most recent Indexing API notifications successfully received, for a given URL. @@ -158,7 +158,7 @@ export namespace indexing_v3 { /** * URL to which this metadata refers. */ - url?: string; + url?: string | null; } export class Resource$Urlnotifications { diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index 28a06927cea..7c032af25b3 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -128,7 +128,7 @@ export namespace jobs_v2 { /** * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "companies/123" AND requisitionId = "req-1" */ - filter?: string; + filter?: string | null; } /** * Represents count of jobs within one bucket. @@ -137,7 +137,7 @@ export namespace jobs_v2 { /** * Number of jobs whose numeric field value fall into `range`. */ - count?: number; + count?: number | null; /** * Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range. */ @@ -150,11 +150,11 @@ export namespace jobs_v2 { /** * Starting value of the bucket range. */ - from?: number; + from?: number | null; /** * Ending value of the bucket range. */ - to?: number; + to?: number | null; } /** * Output only. Commute details related to this job. @@ -167,7 +167,7 @@ export namespace jobs_v2 { /** * The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. */ - travelDuration?: string; + travelDuration?: string | null; } /** * Input only. Parameters needed for commute search. @@ -176,19 +176,19 @@ export namespace jobs_v2 { /** * Optional. If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or is not specified, only jobs that include street level addresses will be returned by commute search. */ - allowNonStreetLevelAddress?: boolean; + allowNonStreetLevelAddress?: boolean | null; /** * Optional. The departure hour to use to calculate traffic impact. Accepts an integer between 0 and 23, representing the hour in the time zone of the start_location. Must not be present if road_traffic is specified. */ - departureHourLocal?: number; + departureHourLocal?: number | null; /** * Required. The method of transportation for which to calculate the commute time. */ - method?: string; + method?: string | null; /** * Optional. Specifies the traffic density to use when calculating commute time. Must not be present if departure_hour_local is specified. */ - roadTraffic?: string; + roadTraffic?: string | null; /** * Required. The latitude and longitude of the location from which to calculate the commute time. */ @@ -196,7 +196,7 @@ export namespace jobs_v2 { /** * Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. */ - travelTime?: string; + travelTime?: string | null; } /** * A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position. @@ -205,7 +205,7 @@ export namespace jobs_v2 { /** * Optional. The URL to employer's career site or careers page on the employer's web site. */ - careerPageLink?: string; + careerPageLink?: string | null; /** * Optional. Identifiers external to the application that help to further identify the employer. */ @@ -213,51 +213,51 @@ export namespace jobs_v2 { /** * Optional. The employer's company size. */ - companySize?: string; + companySize?: string | null; /** * Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored. */ - disableLocationOptimization?: boolean; + disableLocationOptimization?: boolean | null; /** * Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". */ - displayName?: string; + displayName?: string | null; /** * Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided. */ - distributorBillingCompanyId?: string; + distributorBillingCompanyId?: string | null; /** * Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255. */ - distributorCompanyId?: string; + distributorCompanyId?: string | null; /** * Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. */ - eeoText?: string; + eeoText?: string | null; /** * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ - hiringAgency?: boolean; + hiringAgency?: boolean | null; /** * Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in structured_company_hq_location. */ - hqLocation?: string; + hqLocation?: string | null; /** * Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted. */ - imageUrl?: string; + imageUrl?: string | null; /** * Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. */ - keywordSearchableCustomAttributes?: string[]; + keywordSearchableCustomAttributes?: string[] | null; /** * Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. */ - keywordSearchableCustomFields?: number[]; + keywordSearchableCustomFields?: number[] | null; /** * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ - name?: string; + name?: string | null; /** * Output only. A structured headquarters location of the company, resolved from hq_location if possible. */ @@ -265,15 +265,15 @@ export namespace jobs_v2 { /** * Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. */ - suspended?: boolean; + suspended?: boolean | null; /** * Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". */ - title?: string; + title?: string | null; /** * Optional. The URL representing the company's primary web site or home page, such as, "www.google.com". */ - website?: string; + website?: string | null; } /** * A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`. @@ -282,19 +282,19 @@ export namespace jobs_v2 { /** * Optional. The Google's Knowledge Graph value for the employer's company. */ - freebaseMid?: string; + freebaseMid?: string | null; /** * Optional. The numeric identifier for the employer's Google+ business page. */ - gplusId?: string; + gplusId?: string | null; /** * Optional. The numeric identifier for the employer's headquarters on Google Maps, namely, the Google Maps CID (cell id). */ - mapsCid?: string; + mapsCid?: string | null; /** * Optional. A Google identifier that does not match any of the other types. */ - unknownTypeId?: string; + unknownTypeId?: string | null; } /** * A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. @@ -307,11 +307,11 @@ export namespace jobs_v2 { /** * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ - description?: string; + description?: string | null; /** * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ - expectedUnitsPerYear?: number; + expectedUnitsPerYear?: number | null; /** * Optional. Compensation range. */ @@ -319,11 +319,11 @@ export namespace jobs_v2 { /** * Required. Compensation type. */ - type?: string; + type?: string | null; /** * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ - unit?: string; + unit?: string | null; } /** * Input only. Filter on job compensation type and amount. @@ -332,7 +332,7 @@ export namespace jobs_v2 { /** * Optional. Whether to include jobs whose compensation range is unspecified. */ - includeJobsWithUnspecifiedCompensationRange?: boolean; + includeJobsWithUnspecifiedCompensationRange?: boolean | null; /** * Optional. Compensation range. */ @@ -340,11 +340,11 @@ export namespace jobs_v2 { /** * Required. Type of filter. */ - type?: string; + type?: string | null; /** * Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit. */ - units?: string[]; + units?: string[] | null; } /** * Input only. Compensation based histogram request. @@ -357,7 +357,7 @@ export namespace jobs_v2 { /** * Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`. */ - type?: string; + type?: string | null; } /** * Output only. Compensation based histogram result. @@ -370,7 +370,7 @@ export namespace jobs_v2 { /** * Type of the request, corresponding to CompensationHistogramRequest.type. */ - type?: string; + type?: string | null; } /** * Job compensation details. @@ -403,7 +403,7 @@ export namespace jobs_v2 { /** * Deprecated. Use entries instead. Optional. Type of job compensation. */ - type?: string; + type?: string | null; } /** * Compensation range. @@ -438,15 +438,15 @@ export namespace jobs_v2 { /** * The URL for the company logo if `type=COMPANY_NAME`. */ - imageUrl?: string; + imageUrl?: string | null; /** * The suggestion for the query. */ - suggestion?: string; + suggestion?: string | null; /** * The completion topic. */ - type?: string; + type?: string | null; } /** * Input only. Create job request. @@ -455,7 +455,7 @@ export namespace jobs_v2 { /** * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ - disableStreetAddressResolution?: boolean; + disableStreetAddressResolution?: boolean | null; /** * Required. The Job to be created. */ @@ -472,11 +472,11 @@ export namespace jobs_v2 { /** * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ - filterable?: boolean; + filterable?: boolean | null; /** * Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed. */ - longValue?: string; + longValue?: string | null; /** * Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed. */ @@ -489,7 +489,7 @@ export namespace jobs_v2 { /** * Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values. */ - key?: string; + key?: string | null; /** * Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements. */ @@ -497,7 +497,7 @@ export namespace jobs_v2 { /** * Optional. If set to true, the response will include the histogram value for each key as a string. */ - stringValueHistogram?: boolean; + stringValueHistogram?: boolean | null; } /** * Output only. Custom attribute histogram result. @@ -506,7 +506,7 @@ export namespace jobs_v2 { /** * Stores the key of custom attribute the histogram is performed on. */ - key?: string; + key?: string | null; /** * Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`. */ @@ -514,7 +514,7 @@ export namespace jobs_v2 { /** * Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result. */ - stringValueHistogramResult?: {[key: string]: number}; + stringValueHistogramResult?: {[key: string]: number} | null; } /** * Resource that represents the custom data not captured by the standard fields. @@ -523,7 +523,7 @@ export namespace jobs_v2 { /** * Optional. The values of the custom data. */ - values?: string[]; + values?: string[] | null; } /** * Input only. Custom field filter of the search. @@ -532,11 +532,11 @@ export namespace jobs_v2 { /** * Required. The query strings for the filter. */ - queries?: string[]; + queries?: string[] | null; /** * Optional. The type of filter. Defaults to FilterType.OR. */ - type?: string; + type?: 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 date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. @@ -545,15 +545,15 @@ export namespace jobs_v2 { /** * 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; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes. @@ -562,7 +562,7 @@ export namespace jobs_v2 { /** * Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. */ - disableFastProcess?: boolean; + disableFastProcess?: boolean | null; /** * Required. Restrictions on the scope of the delete request. */ @@ -575,11 +575,11 @@ export namespace jobs_v2 { /** * Optional. Type of the device. */ - deviceType?: string; + deviceType?: string | null; /** * Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. */ - id?: string; + id?: 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 `{}`. @@ -596,19 +596,19 @@ export namespace jobs_v2 { /** * Required. Specify desired `base compensation entry's` ExtendedCompensationInfo.CompensationUnit. */ - compensationUnits?: string[]; + compensationUnits?: string[] | null; /** * Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If unspecified, jobs are returned regardless of currency. */ - currency?: string; + currency?: string | null; /** * Optional. Whether to include jobs whose compensation range is unspecified. */ - includeJobWithUnspecifiedCompensationRange?: boolean; + includeJobWithUnspecifiedCompensationRange?: boolean | null; /** * Required. Type of filter. */ - type?: string; + type?: string | null; } /** * Deprecated. Use CompensationInfo. Describes job compensation. @@ -621,7 +621,7 @@ export namespace jobs_v2 { /** * Output only. Indicates annualized base compensation range cannot be derived, due to the job's base compensation entry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry. */ - annualizedBaseCompensationUnspecified?: boolean; + annualizedBaseCompensationUnspecified?: boolean | null; /** * Output only. Annualized total compensation range. */ @@ -629,11 +629,11 @@ export namespace jobs_v2 { /** * Output only. Indicates annualized total compensation range cannot be derived, due to the job's all CompensationEntry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry. */ - annualizedTotalCompensationUnspecified?: boolean; + annualizedTotalCompensationUnspecified?: boolean | null; /** * Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. */ - currency?: string; + currency?: string | null; /** * Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ @@ -650,7 +650,7 @@ export namespace jobs_v2 { /** * Optional. Compensation description. */ - description?: string; + description?: string | null; /** * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ @@ -662,15 +662,15 @@ export namespace jobs_v2 { /** * Required. Compensation type. */ - type?: string; + type?: string | null; /** * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ - unit?: string; + unit?: string | null; /** * Optional. Indicates compensation amount and range are unset. */ - unspecified?: boolean; + unspecified?: boolean | null; } /** * Deprecated. See CompensationInfo. Compensation range. @@ -692,11 +692,11 @@ export namespace jobs_v2 { /** * Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. If `units` is positive, `micros` must be positive or zero. If `units` is zero, `micros` can be positive, zero, or negative. If `units` is negative, `micros` must be negative or zero. For example -1.75 is represented as `units`=-1 and `micros`=-750,000. */ - micros?: number; + micros?: number | null; /** * Whole units. */ - units?: string; + units?: string | null; } /** * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted. @@ -705,7 +705,7 @@ export namespace jobs_v2 { /** * Required. The requisition ID (or posting ID) assigned by the client to identify a job. This is intended for client identification and tracking of listings. name takes precedence over this field The maximum number of allowed characters is 225. */ - requisitionId?: string; + requisitionId?: string | null; } /** * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method. @@ -714,7 +714,7 @@ export namespace jobs_v2 { /** * Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false. */ - allowBroadening?: boolean; + allowBroadening?: boolean | null; /** * Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram. */ @@ -730,7 +730,7 @@ export namespace jobs_v2 { /** * Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution. */ - searchTypes?: string[]; + searchTypes?: string[] | null; } /** * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method. @@ -760,7 +760,7 @@ export namespace jobs_v2 { /** * Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to GetHistogramRequest. */ - simpleHistogramFacets?: string[]; + simpleHistogramFacets?: string[] | null; } /** * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. @@ -769,11 +769,11 @@ export namespace jobs_v2 { /** * The Histogram search filters. */ - searchType?: string; + searchType?: string | null; /** * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ - values?: {[key: string]: number}; + values?: {[key: string]: number} | null; } /** * Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest. @@ -799,31 +799,31 @@ export namespace jobs_v2 { /** * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255. */ - applicationEmailList?: string[]; + applicationEmailList?: string[] | null; /** * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. */ - applicationInstruction?: string; + applicationInstruction?: string | null; /** * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000. */ - applicationUrls?: string[]; + applicationUrls?: string[] | null; /** * Optional. The benefits included with the job. */ - benefits?: string[]; + benefits?: string[] | null; /** * Output only. The name of the company listing the job. */ - companyDisplayName?: string; + companyDisplayName?: string | null; /** * Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id. */ - companyName?: string; + companyName?: string | null; /** * Deprecated. Use company_display_name instead. Output only. The name of the company listing the job. */ - companyTitle?: string; + companyTitle?: string | null; /** * Optional. Job compensation information. */ @@ -831,31 +831,31 @@ export namespace jobs_v2 { /** * Output only. The timestamp when this job was created. */ - createTime?: string; + createTime?: string | null; /** * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ - customAttributes?: {[key: string]: Schema$CustomAttribute}; + customAttributes?: {[key: string]: Schema$CustomAttribute} | null; /** * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ - department?: string; + department?: string | null; /** * Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. */ - description?: string; + description?: string | null; /** * Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255. */ - distributorCompanyId?: string; + distributorCompanyId?: string | null; /** * Optional. The desired education level for the job, such as "Bachelors", "Masters", "Doctorate". */ - educationLevels?: string[]; + educationLevels?: string[] | null; /** * Optional. The employment type(s) of a job, for example, full time or part time. */ - employmentTypes?: string[]; + employmentTypes?: string[] | null; /** * Optional. The end date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored. */ @@ -863,7 +863,7 @@ export namespace jobs_v2 { /** * Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ - expireTime?: string; + expireTime?: string | null; /** * Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ @@ -875,11 +875,11 @@ export namespace jobs_v2 { /** * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned. */ - filterableCustomFields?: {[key: string]: Schema$CustomField}; + filterableCustomFields?: {[key: string]: Schema$CustomField} | null; /** * Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. */ - incentives?: string; + incentives?: string | null; /** * Output only. Structured locations of the job, resolved from locations. */ @@ -887,27 +887,27 @@ export namespace jobs_v2 { /** * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ - jobTitle?: string; + jobTitle?: string | null; /** * Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ - languageCode?: string; + languageCode?: string | null; /** * Optional. The experience level associated with the job, such as "Entry Level". */ - level?: string; + level?: string | null; /** * Optional but strongly recommended for the best service experience. Location(s) where the emploeyer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. */ - locations?: string[]; + locations?: string[] | null; /** * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ - name?: string; + name?: string | null; /** * Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. */ - promotionValue?: number; + promotionValue?: number | null; /** * Optional. The date this job was most recently published in UTC format. The default value is the time the request arrives at the server. */ @@ -915,23 +915,23 @@ export namespace jobs_v2 { /** * Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ - qualifications?: string; + qualifications?: string | null; /** * Output only. The URL of a web page that displays job details. */ - referenceUrl?: string; + referenceUrl?: string | null; /** * Optional. The job Region (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job if an exact location match is not specified. If this field is set, setting job locations to the same location level as this field is strongly recommended. */ - region?: string; + region?: string | null; /** * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255. */ - requisitionId?: string; + requisitionId?: string | null; /** * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ - responsibilities?: string; + responsibilities?: string | null; /** * Optional. The start date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored. */ @@ -939,15 +939,15 @@ export namespace jobs_v2 { /** * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string. */ - unindexedCustomFields?: {[key: string]: Schema$CustomField}; + unindexedCustomFields?: {[key: string]: Schema$CustomField} | null; /** * Output only. The timestamp when this job was last updated. */ - updateTime?: string; + updateTime?: string | null; /** * Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE if not specified. Currently only JobVisibility.PRIVATE is supported. */ - visibility?: string; + visibility?: string | null; } /** * Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram. @@ -956,7 +956,7 @@ export namespace jobs_v2 { /** * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ - categories?: string[]; + categories?: string[] | null; /** * Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time. */ @@ -964,11 +964,11 @@ export namespace jobs_v2 { /** * Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed. */ - companyNames?: string[]; + companyNames?: string[] | null; /** * Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company title filters are allowed. */ - companyTitles?: string[]; + companyTitles?: string[] | null; /** * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet this criteria are searched. If a filter is not defined, all open jobs are searched. */ @@ -976,19 +976,19 @@ export namespace jobs_v2 { /** * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 */ - customAttributeFilter?: string; + customAttributeFilter?: string | null; /** * Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown. */ - customFieldFilters?: {[key: string]: Schema$CustomFieldFilter}; + customFieldFilters?: {[key: string]: Schema$CustomFieldFilter} | null; /** * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ - disableSpellCheck?: boolean; + disableSpellCheck?: boolean | null; /** * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ - employmentTypes?: string[]; + employmentTypes?: string[] | null; /** * Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched. */ @@ -996,7 +996,7 @@ export namespace jobs_v2 { /** * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ - languageCodes?: string[]; + languageCodes?: string[] | null; /** * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value is not specified, jobs are retrieved from all locations. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ @@ -1004,15 +1004,15 @@ export namespace jobs_v2 { /** * Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value is not specified, all open jobs are searched against regardless of the date they were published. */ - publishDateRange?: string; + publishDateRange?: string | null; /** * Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters. */ - query?: string; + query?: string | null; /** * Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against. */ - tenantJobOnly?: boolean; + tenantJobOnly?: boolean | null; } /** * Output only. A resource that represents a location with full geographic information. @@ -1025,7 +1025,7 @@ export namespace jobs_v2 { /** * The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. */ - locationType?: string; + locationType?: string | null; /** * Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. */ @@ -1033,7 +1033,7 @@ export namespace jobs_v2 { /** * Radius in meters of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng coves the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 7885.79 meters. */ - radiusMeters?: number; + radiusMeters?: number | null; } /** * Input only. Options for job processing. @@ -1042,11 +1042,11 @@ export namespace jobs_v2 { /** * Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ - disableStreetAddressResolution?: boolean; + disableStreetAddressResolution?: boolean | null; /** * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ - htmlSanitization?: string; + htmlSanitization?: string | null; } /** * Input only. The query required to perform a search query or histogram. @@ -1055,7 +1055,7 @@ export namespace jobs_v2 { /** * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ - categories?: string[]; + categories?: string[] | null; /** * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. */ @@ -1063,11 +1063,11 @@ export namespace jobs_v2 { /** * Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. */ - companyDisplayNames?: string[]; + companyDisplayNames?: string[] | null; /** * Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. At most 20 company filters are allowed. */ - companyNames?: string[]; + companyNames?: string[] | null; /** * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. */ @@ -1075,19 +1075,19 @@ export namespace jobs_v2 { /** * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 */ - customAttributeFilter?: string; + customAttributeFilter?: string | null; /** * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ - disableSpellCheck?: boolean; + disableSpellCheck?: boolean | null; /** * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ - employmentTypes?: string[]; + employmentTypes?: string[] | null; /** * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ - languageCodes?: string[]; + languageCodes?: string[] | null; /** * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ @@ -1095,11 +1095,11 @@ export namespace jobs_v2 { /** * Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value isn't specified, all open jobs are searched against regardless of their published date. */ - publishDateRange?: string; + publishDateRange?: string | null; /** * Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes. */ - query?: string; + query?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -1108,11 +1108,11 @@ export namespace jobs_v2 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Output only. The List companies response object. @@ -1129,7 +1129,7 @@ export namespace jobs_v2 { /** * A token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object. @@ -1146,11 +1146,11 @@ export namespace jobs_v2 { /** * A token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of open jobs. The result will be empty if ListCompanyJobsRequest.include_jobs_count is not enabled or if no open jobs are available. */ - totalSize?: string; + totalSize?: string | null; } /** * Output only. List jobs response. @@ -1167,7 +1167,7 @@ export namespace jobs_v2 { /** * A token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Input only. Geographic region of the search. @@ -1176,11 +1176,11 @@ export namespace jobs_v2 { /** * Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. */ - distanceInMiles?: number; + distanceInMiles?: number | null; /** * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.allow_telecommute indicates if a job permits telecommuting. If this field is true, telecommuting jobs are searched, and name and lat_lng are ignored. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ - isTelecommute?: boolean; + isTelecommute?: boolean | null; /** * Optional. The latitude and longitude of the geographic center from which to search. This field is ignored if `location_name` is provided. */ @@ -1188,11 +1188,11 @@ export namespace jobs_v2 { /** * Optional. The address name, such as "Mountain View" or "Bay Area". */ - name?: string; + name?: string | null; /** * Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ - regionCode?: string; + regionCode?: string | null; } /** * Output only. Job entry with metadata inside SearchJobsResponse. @@ -1209,15 +1209,15 @@ export namespace jobs_v2 { /** * A summary of the job with core information that's displayed on the search results listing page. */ - jobSummary?: string; + jobSummary?: string | null; /** * Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags. */ - jobTitleSnippet?: string; + jobTitleSnippet?: string | null; /** * Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. */ - searchTextSnippet?: string; + searchTextSnippet?: string | null; } /** * Represents an amount of money with its currency type. @@ -1226,15 +1226,15 @@ export namespace jobs_v2 { /** * The 3-letter currency code defined in ISO 4217. */ - currencyCode?: string; + currencyCode?: string | null; /** * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ - nanos?: number; + nanos?: number | null; /** * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ - units?: string; + units?: string | null; } /** * Input only. Use this field to specify bucketing option for the histogram search response. @@ -1243,11 +1243,11 @@ export namespace jobs_v2 { /** * Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported. */ - bucketBounds?: number[]; + bucketBounds?: number[] | null; /** * Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field. */ - requiresMinMax?: boolean; + requiresMinMax?: boolean | null; } /** * Output only. Custom numeric bucketing result. @@ -1260,11 +1260,11 @@ export namespace jobs_v2 { /** * Stores the maximum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ - maxValue?: number; + maxValue?: number | null; /** * Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ - minValue?: number; + minValue?: number | null; } /** * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 @@ -1273,47 +1273,47 @@ export namespace jobs_v2 { /** * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ - addressLines?: string[]; + addressLines?: string[] | null; /** * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. */ - administrativeArea?: string; + administrativeArea?: string | null; /** * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ - languageCode?: string; + languageCode?: string | null; /** * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. */ - locality?: string; + locality?: string | null; /** * Optional. The name of the organization at the address. */ - organization?: string; + organization?: string | null; /** * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). */ - postalCode?: string; + postalCode?: string | null; /** * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. */ - recipients?: string[]; + recipients?: string[] | null; /** * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ - regionCode?: string; + regionCode?: string | null; /** * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ - revision?: number; + revision?: number | null; /** * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). */ - sortingCode?: string; + sortingCode?: string | null; /** * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. */ - sublocality?: string; + sublocality?: string | null; } /** * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. @@ -1326,15 +1326,15 @@ export namespace jobs_v2 { /** * Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain. */ - domain?: string; + domain?: string | null; /** * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id. */ - sessionId?: string; + sessionId?: string | null; /** * Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id. */ - userId?: string; + userId?: string | null; } /** * Output only. Additional information returned to client, such as debugging information. @@ -1343,15 +1343,15 @@ export namespace jobs_v2 { /** * Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only. */ - experimentIdList?: number[]; + experimentIdList?: number[] | null; /** * For search response only. Indicates the mode of a performed search. */ - mode?: string; + mode?: string | null; /** * A unique id associated with this call. This id is logged for tracking purposes. */ - requestId?: string; + requestId?: string | null; } /** * Input only. The Request body of the `SearchJobs` call. @@ -1360,15 +1360,15 @@ export namespace jobs_v2 { /** * Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing "Assistant to the CEO" positions from the search results of a search for "CEO". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false. */ - disableRelevanceThresholding?: boolean; + disableRelevanceThresholding?: boolean | null; /** * Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. */ - enableBroadening?: boolean; + enableBroadening?: boolean | null; /** * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. */ - enablePreciseResultSize?: boolean; + enablePreciseResultSize?: boolean | null; /** * Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location. */ @@ -1380,27 +1380,27 @@ export namespace jobs_v2 { /** * Optional. The number of job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. */ - jobView?: string; + jobView?: string | null; /** * Required. Mode of a search. */ - mode?: string; + mode?: string | null; /** * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ - offset?: number; + offset?: number | null; /** * Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. */ - orderBy?: string; + orderBy?: string | null; /** * Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. */ - pageSize?: number; + pageSize?: number | null; /** * Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. */ - pageToken?: string; + pageToken?: string | null; /** * Optional. Query used to search against jobs, such as keyword, location filters, etc. */ @@ -1412,7 +1412,7 @@ export namespace jobs_v2 { /** * Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. */ - sortBy?: string; + sortBy?: string | null; } /** * Output only. Response for SearchJob method. @@ -1429,7 +1429,7 @@ export namespace jobs_v2 { /** * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size. */ - estimatedTotalSize?: string; + estimatedTotalSize?: string | null; /** * The histogram results that match specified SearchJobsRequest.HistogramFacets. */ @@ -1437,7 +1437,7 @@ export namespace jobs_v2 { /** * Corresponds to SearchJobsRequest.job_view. */ - jobView?: string; + jobView?: string | null; /** * The Job entities that match the specified SearchJobsRequest. */ @@ -1449,11 +1449,11 @@ export namespace jobs_v2 { /** * The token that specifies the starting position of the next page of results. This field is empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0 means all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results. */ - numJobsFromBroadenedQuery?: number; + numJobsFromBroadenedQuery?: number | null; /** * The spell checking result, and correction. */ @@ -1461,7 +1461,7 @@ export namespace jobs_v2 { /** * The precise result count, which is available only if the client set enable_precise_result_size to `true` or if the response is the last page of results. Otherwise, the value will be `-1`. */ - totalSize?: string; + totalSize?: string | null; } /** * Output only. Spell check result. @@ -1470,11 +1470,11 @@ export namespace jobs_v2 { /** * Indicates if the query was corrected by the spell checker. */ - corrected?: boolean; + corrected?: boolean | null; /** * Correction output consisting of the corrected keyword string. */ - correctedText?: string; + correctedText?: string | null; } /** * Represents array of string values. @@ -1483,7 +1483,7 @@ export namespace jobs_v2 { /** * Required. String values. */ - values?: string[]; + values?: string[] | null; } /** * Input only. Update job request. @@ -1492,7 +1492,7 @@ export namespace jobs_v2 { /** * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job. */ - disableStreetAddressResolution?: boolean; + disableStreetAddressResolution?: boolean | null; /** * Required. The Job to be updated. */ @@ -1504,7 +1504,7 @@ export namespace jobs_v2 { /** * Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated) */ - updateJobFields?: string; + updateJobFields?: string | null; } export class Resource$Companies { diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index ecca84c1bae..e452db126e7 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -124,15 +124,15 @@ export namespace jobs_v3 { /** * Optional but at least one of uris, emails or instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255. */ - emails?: string[]; + emails?: string[] | null; /** * Optional but at least one of uris, emails or instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. */ - instruction?: string; + instruction?: string | null; /** * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. */ - uris?: string[]; + uris?: string[] | null; } /** * Input only. Batch delete jobs request. @@ -141,7 +141,7 @@ export namespace jobs_v3 { /** * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ - filter?: string; + filter?: string | null; } /** * Represents count of jobs within one bucket. @@ -150,7 +150,7 @@ export namespace jobs_v3 { /** * Number of jobs whose numeric field value fall into `range`. */ - count?: number; + count?: number | null; /** * Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range. */ @@ -163,11 +163,11 @@ export namespace jobs_v3 { /** * Starting value of the bucket range. */ - from?: number; + from?: number | null; /** * Ending value of the bucket range. */ - to?: number; + to?: number | null; } /** * An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client. @@ -176,15 +176,15 @@ export namespace jobs_v3 { /** * Required. The timestamp of the event. */ - createTime?: string; + createTime?: string | null; /** * Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id). */ - eventId?: string; + eventId?: string | null; /** * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. */ - extraInfo?: {[key: string]: string}; + extraInfo?: {[key: string]: string} | null; /** * A event issued when a job seeker interacts with the application that implements Cloud Talent Solution. */ @@ -192,11 +192,11 @@ export namespace jobs_v3 { /** * Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view). */ - parentEventId?: string; + parentEventId?: string | null; /** * Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id. */ - requestId?: string; + requestId?: string | null; } /** * Input only. Parameters needed for commute search. @@ -205,11 +205,11 @@ export namespace jobs_v3 { /** * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. */ - allowImpreciseAddresses?: boolean; + allowImpreciseAddresses?: boolean | null; /** * Required. The method of transportation for which to calculate the commute time. */ - commuteMethod?: string; + commuteMethod?: string | null; /** * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. */ @@ -217,7 +217,7 @@ export namespace jobs_v3 { /** * Optional. Specifies the traffic density to use when calculating commute time. */ - roadTraffic?: string; + roadTraffic?: string | null; /** * Required. The latitude and longitude of the location from which to calculate the commute time. */ @@ -225,7 +225,7 @@ export namespace jobs_v3 { /** * Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. */ - travelDuration?: string; + travelDuration?: string | null; } /** * Output only. Commute details related to this job. @@ -238,7 +238,7 @@ export namespace jobs_v3 { /** * The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. */ - travelDuration?: string; + travelDuration?: string | null; } /** * A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position. @@ -247,7 +247,7 @@ export namespace jobs_v3 { /** * Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". */ - careerSiteUri?: string; + careerSiteUri?: string | null; /** * Output only. Derived details about the company. */ @@ -255,47 +255,47 @@ export namespace jobs_v3 { /** * Required. The display name of the company, for example, "Google LLC". */ - displayName?: string; + displayName?: string | null; /** * Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. */ - eeoText?: string; + eeoText?: string | null; /** * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. */ - externalId?: string; + externalId?: string | null; /** * Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location. */ - headquartersAddress?: string; + headquartersAddress?: string | null; /** * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ - hiringAgency?: boolean; + hiringAgency?: boolean | null; /** * Optional. A URI that hosts the employer's company logo. */ - imageUri?: string; + imageUri?: string | null; /** * Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes. */ - keywordSearchableJobCustomAttributes?: string[]; + keywordSearchableJobCustomAttributes?: string[] | null; /** * Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ - name?: string; + name?: string | null; /** * Optional. The employer's company size. */ - size?: string; + size?: string | null; /** * Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. */ - suspended?: boolean; + suspended?: boolean | null; /** * Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. */ - websiteUri?: string; + websiteUri?: string | null; } /** * Derived details about the company. @@ -317,11 +317,11 @@ export namespace jobs_v3 { /** * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ - description?: string; + description?: string | null; /** * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ - expectedUnitsPerYear?: number; + expectedUnitsPerYear?: number | null; /** * Optional. Compensation range. */ @@ -329,11 +329,11 @@ export namespace jobs_v3 { /** * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. */ - type?: string; + type?: string | null; /** * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ - unit?: string; + unit?: string | null; } /** * Input only. Filter on job compensation type and amount. @@ -342,7 +342,7 @@ export namespace jobs_v3 { /** * Optional. If set to true, jobs with unspecified compensation range fields are included. */ - includeJobsWithUnspecifiedCompensationRange?: boolean; + includeJobsWithUnspecifiedCompensationRange?: boolean | null; /** * Optional. Compensation range. */ @@ -350,11 +350,11 @@ export namespace jobs_v3 { /** * Required. Type of filter. */ - type?: string; + type?: string | null; /** * Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit. */ - units?: string[]; + units?: string[] | null; } /** * Input only. Compensation based histogram request. @@ -367,7 +367,7 @@ export namespace jobs_v3 { /** * Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`. */ - type?: string; + type?: string | null; } /** * Output only. Compensation based histogram result. @@ -380,7 +380,7 @@ export namespace jobs_v3 { /** * Type of the request, corresponding to CompensationHistogramRequest.type. */ - type?: string; + type?: string | null; } /** * Job compensation details. @@ -432,15 +432,15 @@ export namespace jobs_v3 { /** * The URI of the company image for CompletionType.COMPANY_NAME. */ - imageUri?: string; + imageUri?: string | null; /** * The suggestion for the query. */ - suggestion?: string; + suggestion?: string | null; /** * The completion topic. */ - type?: string; + type?: string | null; } /** * The report event request. @@ -476,15 +476,15 @@ export namespace jobs_v3 { /** * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ - filterable?: boolean; + filterable?: boolean | null; /** * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. */ - longValues?: string[]; + longValues?: string[] | null; /** * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. */ - stringValues?: string[]; + stringValues?: string[] | null; } /** * Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined. @@ -493,7 +493,7 @@ export namespace jobs_v3 { /** * Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values. */ - key?: string; + key?: string | null; /** * Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements. */ @@ -501,7 +501,7 @@ export namespace jobs_v3 { /** * Optional. If set to true, the response includes the histogram value for each key as a string. */ - stringValueHistogram?: boolean; + stringValueHistogram?: boolean | null; } /** * Output only. Custom attribute histogram result. @@ -510,7 +510,7 @@ export namespace jobs_v3 { /** * Stores the key of custom attribute the histogram is performed on. */ - key?: string; + key?: string | null; /** * Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`. */ @@ -518,7 +518,7 @@ export namespace jobs_v3 { /** * Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result. */ - stringValueHistogramResult?: {[key: string]: number}; + stringValueHistogramResult?: {[key: string]: number} | null; } /** * Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices. @@ -527,11 +527,11 @@ export namespace jobs_v3 { /** * Optional. Type of the device. */ - deviceType?: string; + deviceType?: string | null; /** * Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. */ - id?: string; + id?: 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 `{}`. @@ -552,7 +552,7 @@ export namespace jobs_v3 { /** * Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. */ - simpleHistogramFacets?: string[]; + simpleHistogramFacets?: string[] | null; } /** * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. @@ -561,11 +561,11 @@ export namespace jobs_v3 { /** * The Histogram search filters. */ - searchType?: string; + searchType?: string | null; /** * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ - values?: {[key: string]: number}; + values?: {[key: string]: number} | null; } /** * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. @@ -591,7 +591,7 @@ export namespace jobs_v3 { /** * Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. */ - addresses?: string[]; + addresses?: string[] | null; /** * Required. At least one field within ApplicationInfo must be specified. Job application information. */ @@ -599,11 +599,11 @@ export namespace jobs_v3 { /** * Output only. Display name of the company listing the job. */ - companyDisplayName?: string; + companyDisplayName?: string | null; /** * Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo". */ - companyName?: string; + companyName?: string | null; /** * Optional. Job compensation information. */ @@ -611,15 +611,15 @@ export namespace jobs_v3 { /** * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ - customAttributes?: {[key: string]: Schema$CustomAttribute}; + customAttributes?: {[key: string]: Schema$CustomAttribute} | null; /** * Optional. The desired education degrees for the job, such as Bachelors, Masters. */ - degreeTypes?: string[]; + degreeTypes?: string[] | null; /** * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ - department?: string; + department?: string | null; /** * Output only. Derived details about the job posting. */ @@ -627,59 +627,59 @@ export namespace jobs_v3 { /** * Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. */ - description?: string; + description?: string | null; /** * Optional. The employment type(s) of a job, for example, full time or part time. */ - employmentTypes?: string[]; + employmentTypes?: string[] | null; /** * Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. */ - incentives?: string; + incentives?: string | null; /** * Optional. The benefits included with the job. */ - jobBenefits?: string[]; + jobBenefits?: string[] | null; /** * Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ - jobEndTime?: string; + jobEndTime?: string | null; /** * Optional. The experience level associated with the job, such as "Entry Level". */ - jobLevel?: string; + jobLevel?: string | null; /** * Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ - jobStartTime?: string; + jobStartTime?: string | null; /** * Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ - languageCode?: string; + languageCode?: string | null; /** * Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ - name?: string; + name?: string | null; /** * Output only. The timestamp when this job posting was created. */ - postingCreateTime?: string; + postingCreateTime?: string | null; /** * Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company_name, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ - postingExpireTime?: string; + postingExpireTime?: string | null; /** * Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. */ - postingPublishTime?: string; + postingPublishTime?: string | null; /** * Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. */ - postingRegion?: string; + postingRegion?: string | null; /** * Output only. The timestamp when this job posting was last updated. */ - postingUpdateTime?: string; + postingUpdateTime?: string | null; /** * Optional. Options for job processing. */ @@ -687,27 +687,27 @@ export namespace jobs_v3 { /** * Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. */ - promotionValue?: number; + promotionValue?: number | null; /** * Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ - qualifications?: string; + qualifications?: string | null; /** * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. */ - requisitionId?: string; + requisitionId?: string | null; /** * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ - responsibilities?: string; + responsibilities?: string | null; /** * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ - title?: string; + title?: string | null; /** * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. */ - visibility?: string; + visibility?: string | null; } /** * Output only. Derived details about the job posting. @@ -716,7 +716,7 @@ export namespace jobs_v3 { /** * Job categories derived from Job.title and Job.description. */ - jobCategories?: string[]; + jobCategories?: string[] | null; /** * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. */ @@ -729,11 +729,11 @@ export namespace jobs_v3 { /** * Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. */ - jobs?: string[]; + jobs?: string[] | null; /** * Required. The type of the event (see JobEventType). */ - type?: string; + type?: string | null; } /** * Input only. The query required to perform a search query. @@ -746,11 +746,11 @@ export namespace jobs_v3 { /** * Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. */ - companyDisplayNames?: string[]; + companyDisplayNames?: string[] | null; /** * Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. */ - companyNames?: string[]; + companyNames?: string[] | null; /** * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. */ @@ -758,23 +758,23 @@ export namespace jobs_v3 { /** * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` */ - customAttributeFilter?: string; + customAttributeFilter?: string | null; /** * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ - disableSpellCheck?: boolean; + disableSpellCheck?: boolean | null; /** * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ - employmentTypes?: string[]; + employmentTypes?: string[] | null; /** * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ - jobCategories?: string[]; + jobCategories?: string[] | null; /** * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ - languageCodes?: string[]; + languageCodes?: string[] | null; /** * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ @@ -786,7 +786,7 @@ export namespace jobs_v3 { /** * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ - query?: string; + query?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -795,11 +795,11 @@ export namespace jobs_v3 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Output only. The List companies response object. @@ -816,7 +816,7 @@ export namespace jobs_v3 { /** * A token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Output only. List jobs response. @@ -833,7 +833,7 @@ export namespace jobs_v3 { /** * A token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Output only. A resource that represents a location with full geographic information. @@ -846,7 +846,7 @@ export namespace jobs_v3 { /** * The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. */ - locationType?: string; + locationType?: string | null; /** * Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. */ @@ -854,7 +854,7 @@ export namespace jobs_v3 { /** * Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. */ - radiusInMiles?: number; + radiusInMiles?: number | null; } /** * Input only. Geographic region of the search. @@ -863,11 +863,11 @@ export namespace jobs_v3 { /** * Optional. The address name, such as "Mountain View" or "Bay Area". */ - address?: string; + address?: string | null; /** * Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. */ - distanceInMiles?: number; + distanceInMiles?: number | null; /** * Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if `address` is provided. */ @@ -875,11 +875,11 @@ export namespace jobs_v3 { /** * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ - regionCode?: string; + regionCode?: string | null; /** * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ - telecommutePreference?: string; + telecommutePreference?: string | null; } /** * Output only. Job entry with metadata inside SearchJobsResponse. @@ -896,15 +896,15 @@ export namespace jobs_v3 { /** * A summary of the job with core information that's displayed on the search results listing page. */ - jobSummary?: string; + jobSummary?: string | null; /** * Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags. */ - jobTitleSnippet?: string; + jobTitleSnippet?: string | null; /** * Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. */ - searchTextSnippet?: string; + searchTextSnippet?: string | null; } /** * Represents an amount of money with its currency type. @@ -913,15 +913,15 @@ export namespace jobs_v3 { /** * The 3-letter currency code defined in ISO 4217. */ - currencyCode?: string; + currencyCode?: string | null; /** * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ - nanos?: number; + nanos?: number | null; /** * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ - units?: string; + units?: string | null; } /** * Input only. Use this field to specify bucketing option for the histogram search response. @@ -930,11 +930,11 @@ export namespace jobs_v3 { /** * Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported. */ - bucketBounds?: number[]; + bucketBounds?: number[] | null; /** * Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field. */ - requiresMinMax?: boolean; + requiresMinMax?: boolean | null; } /** * Output only. Custom numeric bucketing result. @@ -947,11 +947,11 @@ export namespace jobs_v3 { /** * Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true. */ - maxValue?: number; + maxValue?: number | null; /** * Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ - minValue?: number; + minValue?: number | null; } /** * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 @@ -960,47 +960,47 @@ export namespace jobs_v3 { /** * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ - addressLines?: string[]; + addressLines?: string[] | null; /** * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. */ - administrativeArea?: string; + administrativeArea?: string | null; /** * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ - languageCode?: string; + languageCode?: string | null; /** * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. */ - locality?: string; + locality?: string | null; /** * Optional. The name of the organization at the address. */ - organization?: string; + organization?: string | null; /** * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). */ - postalCode?: string; + postalCode?: string | null; /** * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. */ - recipients?: string[]; + recipients?: string[] | null; /** * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ - regionCode?: string; + regionCode?: string | null; /** * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ - revision?: number; + revision?: number | null; /** * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). */ - sortingCode?: string; + sortingCode?: string | null; /** * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. */ - sublocality?: string; + sublocality?: string | null; } /** * Input only. Options for job processing. @@ -1009,11 +1009,11 @@ export namespace jobs_v3 { /** * Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ - disableStreetAddressResolution?: boolean; + disableStreetAddressResolution?: boolean | null; /** * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ - htmlSanitization?: string; + htmlSanitization?: string | null; } /** * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. @@ -1026,15 +1026,15 @@ export namespace jobs_v3 { /** * Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. */ - domain?: string; + domain?: string | null; /** * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. */ - sessionId?: string; + sessionId?: string | null; /** * Required. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to a unique user_id. The maximum number of allowed characters is 255. */ - userId?: string; + userId?: string | null; } /** * Output only. Additional information returned to client, such as debugging information. @@ -1043,7 +1043,7 @@ export namespace jobs_v3 { /** * A unique id associated with this call. This id is logged for tracking purposes. */ - requestId?: string; + requestId?: string | null; } /** * Input only. The Request body of the `SearchJobs` call. @@ -1052,15 +1052,15 @@ export namespace jobs_v3 { /** * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. */ - disableKeywordMatch?: boolean; + disableKeywordMatch?: boolean | null; /** * Optional. Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. */ - diversificationLevel?: string; + diversificationLevel?: string | null; /** * Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. */ - enableBroadening?: boolean; + enableBroadening?: boolean | null; /** * Optional. Histogram requests for jobs matching JobQuery. */ @@ -1072,23 +1072,23 @@ export namespace jobs_v3 { /** * Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. */ - jobView?: string; + jobView?: string | null; /** * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ - offset?: number; + offset?: number | null; /** * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * `"relevance desc"`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `"posting_publish_time desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_base_compensation desc"`: By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation"`: By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation desc"`: By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. */ - orderBy?: string; + orderBy?: string | null; /** * Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. */ - pageSize?: number; + pageSize?: number | null; /** * Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. */ - pageToken?: string; + pageToken?: string | null; /** * Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as `user_id`) are provided by users, and must be unique and consistent. */ @@ -1096,11 +1096,11 @@ export namespace jobs_v3 { /** * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. */ - requirePreciseResultSize?: boolean; + requirePreciseResultSize?: boolean | null; /** * Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. */ - searchMode?: string; + searchMode?: string | null; } /** * Output only. Response for SearchJob method. @@ -1109,11 +1109,11 @@ export namespace jobs_v3 { /** * If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results. */ - broadenedQueryJobsCount?: number; + broadenedQueryJobsCount?: number | null; /** * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see enable_precise_result_size. */ - estimatedTotalSize?: number; + estimatedTotalSize?: number | null; /** * The histogram results that match specified SearchJobsRequest.histogram_facets. */ @@ -1133,7 +1133,7 @@ export namespace jobs_v3 { /** * The token that specifies the starting position of the next page of results. This field is empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The spell checking result, and correction. */ @@ -1141,7 +1141,7 @@ export namespace jobs_v3 { /** * The precise result count, which is available only if the client set enable_precise_result_size to `true`, or if the response is the last page of results. Otherwise, the value is `-1`. */ - totalSize?: number; + totalSize?: number | null; } /** * Output only. Spell check result. @@ -1150,11 +1150,11 @@ export namespace jobs_v3 { /** * Indicates if the query was corrected by the spell checker. */ - corrected?: boolean; + corrected?: boolean | null; /** * Correction output consisting of the corrected keyword string. */ - correctedText?: string; + correctedText?: string | null; } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. @@ -1163,19 +1163,19 @@ export namespace jobs_v3 { /** * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ - hours?: number; + hours?: number | null; /** * Minutes of hour of day. Must be from 0 to 59. */ - minutes?: number; + minutes?: number | null; /** * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ - nanos?: number; + nanos?: number | null; /** * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ - seconds?: number; + seconds?: number | null; } /** * Message representing a period of time between two timestamps. @@ -1184,11 +1184,11 @@ export namespace jobs_v3 { /** * End of the period. */ - endTime?: string; + endTime?: string | null; /** * Begin of the period. */ - startTime?: string; + startTime?: string | null; } /** * Input only. Request for updating a specified company. @@ -1201,7 +1201,7 @@ export namespace jobs_v3 { /** * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported. */ - updateMask?: string; + updateMask?: string | null; } /** * Input only. Update job request. @@ -1214,7 +1214,7 @@ export namespace jobs_v3 { /** * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. */ - updateMask?: string; + updateMask?: string | null; } export class Resource$Projects { diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index 4ee849a38d5..a0561f486c0 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -124,15 +124,15 @@ export namespace jobs_v3p1beta1 { /** * Optional but at least one of uris, emails or instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255. */ - emails?: string[]; + emails?: string[] | null; /** * Optional but at least one of uris, emails or instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. */ - instruction?: string; + instruction?: string | null; /** * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. */ - uris?: string[]; + uris?: string[] | null; } /** * Input only. Batch delete jobs request. @@ -141,7 +141,7 @@ export namespace jobs_v3p1beta1 { /** * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ - filter?: string; + filter?: string | null; } /** * Represents count of jobs within one bucket. @@ -150,7 +150,7 @@ export namespace jobs_v3p1beta1 { /** * Number of jobs whose numeric field value fall into `range`. */ - count?: number; + count?: number | null; /** * Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range. */ @@ -163,11 +163,11 @@ export namespace jobs_v3p1beta1 { /** * Starting value of the bucket range. */ - from?: number; + from?: number | null; /** * Ending value of the bucket range. */ - to?: number; + to?: number | null; } /** * An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client. @@ -176,15 +176,15 @@ export namespace jobs_v3p1beta1 { /** * Required. The timestamp of the event. */ - createTime?: string; + createTime?: string | null; /** * Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id). */ - eventId?: string; + eventId?: string | null; /** * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. */ - extraInfo?: {[key: string]: string}; + extraInfo?: {[key: string]: string} | null; /** * A event issued when a job seeker interacts with the application that implements Cloud Talent Solution. */ @@ -192,11 +192,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view). */ - parentEventId?: string; + parentEventId?: string | null; /** * Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id. */ - requestId?: string; + requestId?: string | null; } /** * Input only. Parameters needed for commute search. @@ -205,11 +205,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. */ - allowImpreciseAddresses?: boolean; + allowImpreciseAddresses?: boolean | null; /** * Required. The method of transportation for which to calculate the commute time. */ - commuteMethod?: string; + commuteMethod?: string | null; /** * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. */ @@ -217,7 +217,7 @@ export namespace jobs_v3p1beta1 { /** * Optional. Specifies the traffic density to use when calculating commute time. */ - roadTraffic?: string; + roadTraffic?: string | null; /** * Required. The latitude and longitude of the location from which to calculate the commute time. */ @@ -225,7 +225,7 @@ export namespace jobs_v3p1beta1 { /** * Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. */ - travelDuration?: string; + travelDuration?: string | null; } /** * Output only. Commute details related to this job. @@ -238,7 +238,7 @@ export namespace jobs_v3p1beta1 { /** * The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. */ - travelDuration?: string; + travelDuration?: string | null; } /** * A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position. @@ -247,7 +247,7 @@ export namespace jobs_v3p1beta1 { /** * Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". */ - careerSiteUri?: string; + careerSiteUri?: string | null; /** * Output only. Derived details about the company. */ @@ -255,47 +255,47 @@ export namespace jobs_v3p1beta1 { /** * Required. The display name of the company, for example, "Google LLC". */ - displayName?: string; + displayName?: string | null; /** * Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. */ - eeoText?: string; + eeoText?: string | null; /** * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. */ - externalId?: string; + externalId?: string | null; /** * Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location. */ - headquartersAddress?: string; + headquartersAddress?: string | null; /** * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ - hiringAgency?: boolean; + hiringAgency?: boolean | null; /** * Optional. A URI that hosts the employer's company logo. */ - imageUri?: string; + imageUri?: string | null; /** * Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes. */ - keywordSearchableJobCustomAttributes?: string[]; + keywordSearchableJobCustomAttributes?: string[] | null; /** * Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ - name?: string; + name?: string | null; /** * Optional. The employer's company size. */ - size?: string; + size?: string | null; /** * Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. */ - suspended?: boolean; + suspended?: boolean | null; /** * Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. */ - websiteUri?: string; + websiteUri?: string | null; } /** * Derived details about the company. @@ -317,11 +317,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ - description?: string; + description?: string | null; /** * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ - expectedUnitsPerYear?: number; + expectedUnitsPerYear?: number | null; /** * Optional. Compensation range. */ @@ -329,11 +329,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. */ - type?: string; + type?: string | null; /** * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ - unit?: string; + unit?: string | null; } /** * Input only. Filter on job compensation type and amount. @@ -342,7 +342,7 @@ export namespace jobs_v3p1beta1 { /** * Optional. If set to true, jobs with unspecified compensation range fields are included. */ - includeJobsWithUnspecifiedCompensationRange?: boolean; + includeJobsWithUnspecifiedCompensationRange?: boolean | null; /** * Optional. Compensation range. */ @@ -350,11 +350,11 @@ export namespace jobs_v3p1beta1 { /** * Required. Type of filter. */ - type?: string; + type?: string | null; /** * Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit. */ - units?: string[]; + units?: string[] | null; } /** * Input only. Compensation based histogram request. @@ -367,7 +367,7 @@ export namespace jobs_v3p1beta1 { /** * Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`. */ - type?: string; + type?: string | null; } /** * Output only. Compensation based histogram result. @@ -380,7 +380,7 @@ export namespace jobs_v3p1beta1 { /** * Type of the request, corresponding to CompensationHistogramRequest.type. */ - type?: string; + type?: string | null; } /** * Job compensation details. @@ -432,15 +432,15 @@ export namespace jobs_v3p1beta1 { /** * The URI of the company image for CompletionType.COMPANY_NAME. */ - imageUri?: string; + imageUri?: string | null; /** * The suggestion for the query. */ - suggestion?: string; + suggestion?: string | null; /** * The completion topic. */ - type?: string; + type?: string | null; } /** * The report event request. @@ -476,15 +476,15 @@ export namespace jobs_v3p1beta1 { /** * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ - filterable?: boolean; + filterable?: boolean | null; /** * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. */ - longValues?: string[]; + longValues?: string[] | null; /** * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. */ - stringValues?: string[]; + stringValues?: string[] | null; } /** * Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined. @@ -493,7 +493,7 @@ export namespace jobs_v3p1beta1 { /** * Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values. */ - key?: string; + key?: string | null; /** * Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements. */ @@ -501,7 +501,7 @@ export namespace jobs_v3p1beta1 { /** * Optional. If set to true, the response includes the histogram value for each key as a string. */ - stringValueHistogram?: boolean; + stringValueHistogram?: boolean | null; } /** * Output only. Custom attribute histogram result. @@ -510,7 +510,7 @@ export namespace jobs_v3p1beta1 { /** * Stores the key of custom attribute the histogram is performed on. */ - key?: string; + key?: string | null; /** * Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`. */ @@ -518,7 +518,7 @@ export namespace jobs_v3p1beta1 { /** * Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result. */ - stringValueHistogramResult?: {[key: string]: number}; + stringValueHistogramResult?: {[key: string]: number} | null; } /** * Input only. Custom ranking information for SearchJobsRequest. @@ -527,11 +527,11 @@ export namespace jobs_v3p1beta1 { /** * Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified. */ - importanceLevel?: string; + importanceLevel?: string | null; /** * Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). The product of ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5) */ - rankingExpression?: string; + rankingExpression?: string | null; } /** * Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices. @@ -540,11 +540,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. Type of the device. */ - deviceType?: string; + deviceType?: string | null; /** * Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. */ - id?: string; + id?: 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 `{}`. @@ -565,7 +565,7 @@ export namespace jobs_v3p1beta1 { /** * Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. */ - simpleHistogramFacets?: string[]; + simpleHistogramFacets?: string[] | null; } /** * Input Only. The histogram request. @@ -574,7 +574,7 @@ export namespace jobs_v3p1beta1 { /** * An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level. For example, "Entry Level". * country: histogram by the country code of jobs. For example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country". For example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute["some-string-custom-attribute"]) * count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"]) */ - histogramQuery?: string; + histogramQuery?: string | null; } /** * Output only. Histogram result that matches HistogramSpec specified in searches. @@ -583,11 +583,11 @@ export namespace jobs_v3p1beta1 { /** * A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: * (for string histogram) string values stored in the field. * (for named numeric bucket) name specified in `bucket()` function, like for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for example, `0-1000`, `MIN-0`, and `0-MAX`. */ - histogram?: {[key: string]: string}; + histogram?: {[key: string]: string} | null; /** * Requested histogram expression. */ - histogramQuery?: string; + histogramQuery?: string | null; } /** * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. @@ -596,11 +596,11 @@ export namespace jobs_v3p1beta1 { /** * The Histogram search filters. */ - searchType?: string; + searchType?: string | null; /** * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ - values?: {[key: string]: number}; + values?: {[key: string]: number} | null; } /** * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. @@ -626,7 +626,7 @@ export namespace jobs_v3p1beta1 { /** * Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. */ - addresses?: string[]; + addresses?: string[] | null; /** * Required. At least one field within ApplicationInfo must be specified. Job application information. */ @@ -634,11 +634,11 @@ export namespace jobs_v3p1beta1 { /** * Output only. Display name of the company listing the job. */ - companyDisplayName?: string; + companyDisplayName?: string | null; /** * Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo". */ - companyName?: string; + companyName?: string | null; /** * Optional. Job compensation information. */ @@ -646,15 +646,15 @@ export namespace jobs_v3p1beta1 { /** * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ - customAttributes?: {[key: string]: Schema$CustomAttribute}; + customAttributes?: {[key: string]: Schema$CustomAttribute} | null; /** * Optional. The desired education degrees for the job, such as Bachelors, Masters. */ - degreeTypes?: string[]; + degreeTypes?: string[] | null; /** * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ - department?: string; + department?: string | null; /** * Output only. Derived details about the job posting. */ @@ -662,59 +662,59 @@ export namespace jobs_v3p1beta1 { /** * Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. */ - description?: string; + description?: string | null; /** * Optional. The employment type(s) of a job, for example, full time or part time. */ - employmentTypes?: string[]; + employmentTypes?: string[] | null; /** * Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. */ - incentives?: string; + incentives?: string | null; /** * Optional. The benefits included with the job. */ - jobBenefits?: string[]; + jobBenefits?: string[] | null; /** * Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ - jobEndTime?: string; + jobEndTime?: string | null; /** * Optional. The experience level associated with the job, such as "Entry Level". */ - jobLevel?: string; + jobLevel?: string | null; /** * Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ - jobStartTime?: string; + jobStartTime?: string | null; /** * Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ - languageCode?: string; + languageCode?: string | null; /** * Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ - name?: string; + name?: string | null; /** * Output only. The timestamp when this job posting was created. */ - postingCreateTime?: string; + postingCreateTime?: string | null; /** * Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company_name, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ - postingExpireTime?: string; + postingExpireTime?: string | null; /** * Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. */ - postingPublishTime?: string; + postingPublishTime?: string | null; /** * Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. */ - postingRegion?: string; + postingRegion?: string | null; /** * Output only. The timestamp when this job posting was last updated. */ - postingUpdateTime?: string; + postingUpdateTime?: string | null; /** * Optional. Options for job processing. */ @@ -722,27 +722,27 @@ export namespace jobs_v3p1beta1 { /** * Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. */ - promotionValue?: number; + promotionValue?: number | null; /** * Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ - qualifications?: string; + qualifications?: string | null; /** * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. */ - requisitionId?: string; + requisitionId?: string | null; /** * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ - responsibilities?: string; + responsibilities?: string | null; /** * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ - title?: string; + title?: string | null; /** * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. */ - visibility?: string; + visibility?: string | null; } /** * Output only. Derived details about the job posting. @@ -751,7 +751,7 @@ export namespace jobs_v3p1beta1 { /** * Job categories derived from Job.title and Job.description. */ - jobCategories?: string[]; + jobCategories?: string[] | null; /** * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. */ @@ -764,11 +764,11 @@ export namespace jobs_v3p1beta1 { /** * Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. */ - jobs?: string[]; + jobs?: string[] | null; /** * Required. The type of the event (see JobEventType). */ - type?: string; + type?: string | null; } /** * Input only. The query required to perform a search query. @@ -781,11 +781,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. */ - companyDisplayNames?: string[]; + companyDisplayNames?: string[] | null; /** * Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. */ - companyNames?: string[]; + companyNames?: string[] | null; /** * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. */ @@ -793,27 +793,27 @@ export namespace jobs_v3p1beta1 { /** * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` */ - customAttributeFilter?: string; + customAttributeFilter?: string | null; /** * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ - disableSpellCheck?: boolean; + disableSpellCheck?: boolean | null; /** * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ - employmentTypes?: string[]; + employmentTypes?: string[] | null; /** * Optional. This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed. */ - excludedJobs?: string[]; + excludedJobs?: string[] | null; /** * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ - jobCategories?: string[]; + jobCategories?: string[] | null; /** * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ - languageCodes?: string[]; + languageCodes?: string[] | null; /** * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ @@ -825,7 +825,7 @@ export namespace jobs_v3p1beta1 { /** * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ - query?: string; + query?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -834,11 +834,11 @@ export namespace jobs_v3p1beta1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Output only. The List companies response object. @@ -855,7 +855,7 @@ export namespace jobs_v3p1beta1 { /** * A token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Output only. List jobs response. @@ -872,7 +872,7 @@ export namespace jobs_v3p1beta1 { /** * A token to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Output only. A resource that represents a location with full geographic information. @@ -885,7 +885,7 @@ export namespace jobs_v3p1beta1 { /** * The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. */ - locationType?: string; + locationType?: string | null; /** * Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. */ @@ -893,7 +893,7 @@ export namespace jobs_v3p1beta1 { /** * Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. */ - radiusInMiles?: number; + radiusInMiles?: number | null; } /** * Input only. Geographic region of the search. @@ -902,11 +902,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. The address name, such as "Mountain View" or "Bay Area". */ - address?: string; + address?: string | null; /** * Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. */ - distanceInMiles?: number; + distanceInMiles?: number | null; /** * Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if `address` is provided. */ @@ -914,11 +914,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ - regionCode?: string; + regionCode?: string | null; /** * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ - telecommutePreference?: string; + telecommutePreference?: string | null; } /** * Output only. Job entry with metadata inside SearchJobsResponse. @@ -935,15 +935,15 @@ export namespace jobs_v3p1beta1 { /** * A summary of the job with core information that's displayed on the search results listing page. */ - jobSummary?: string; + jobSummary?: string | null; /** * Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags. */ - jobTitleSnippet?: string; + jobTitleSnippet?: string | null; /** * Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. */ - searchTextSnippet?: string; + searchTextSnippet?: string | null; } /** * Represents an amount of money with its currency type. @@ -952,15 +952,15 @@ export namespace jobs_v3p1beta1 { /** * The 3-letter currency code defined in ISO 4217. */ - currencyCode?: string; + currencyCode?: string | null; /** * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ - nanos?: number; + nanos?: number | null; /** * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ - units?: string; + units?: string | null; } /** * Input only. Use this field to specify bucketing option for the histogram search response. @@ -969,11 +969,11 @@ export namespace jobs_v3p1beta1 { /** * Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported. */ - bucketBounds?: number[]; + bucketBounds?: number[] | null; /** * Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field. */ - requiresMinMax?: boolean; + requiresMinMax?: boolean | null; } /** * Output only. Custom numeric bucketing result. @@ -986,11 +986,11 @@ export namespace jobs_v3p1beta1 { /** * Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true. */ - maxValue?: number; + maxValue?: number | null; /** * Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ - minValue?: number; + minValue?: number | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -999,7 +999,7 @@ export namespace jobs_v3p1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1007,15 +1007,15 @@ export namespace jobs_v3p1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 @@ -1024,47 +1024,47 @@ export namespace jobs_v3p1beta1 { /** * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ - addressLines?: string[]; + addressLines?: string[] | null; /** * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. */ - administrativeArea?: string; + administrativeArea?: string | null; /** * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ - languageCode?: string; + languageCode?: string | null; /** * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. */ - locality?: string; + locality?: string | null; /** * Optional. The name of the organization at the address. */ - organization?: string; + organization?: string | null; /** * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). */ - postalCode?: string; + postalCode?: string | null; /** * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. */ - recipients?: string[]; + recipients?: string[] | null; /** * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ - regionCode?: string; + regionCode?: string | null; /** * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ - revision?: number; + revision?: number | null; /** * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). */ - sortingCode?: string; + sortingCode?: string | null; /** * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. */ - sublocality?: string; + sublocality?: string | null; } /** * Input only. Options for job processing. @@ -1073,11 +1073,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ - disableStreetAddressResolution?: boolean; + disableStreetAddressResolution?: boolean | null; /** * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ - htmlSanitization?: string; + htmlSanitization?: string | null; } /** * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. @@ -1090,15 +1090,15 @@ export namespace jobs_v3p1beta1 { /** * Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. */ - domain?: string; + domain?: string | null; /** * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. */ - sessionId?: string; + sessionId?: string | null; /** * Required. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to a unique user_id. The maximum number of allowed characters is 255. */ - userId?: string; + userId?: string | null; } /** * Output only. Additional information returned to client, such as debugging information. @@ -1107,7 +1107,7 @@ export namespace jobs_v3p1beta1 { /** * A unique id associated with this call. This id is logged for tracking purposes. */ - requestId?: string; + requestId?: string | null; } /** * Input only. The Request body of the `SearchJobs` call. @@ -1120,15 +1120,15 @@ export namespace jobs_v3p1beta1 { /** * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. */ - disableKeywordMatch?: boolean; + disableKeywordMatch?: boolean | null; /** * Optional. Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. */ - diversificationLevel?: string; + diversificationLevel?: string | null; /** * Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. */ - enableBroadening?: boolean; + enableBroadening?: boolean | null; /** * Optional. Histogram requests for jobs matching JobQuery. */ @@ -1144,23 +1144,23 @@ export namespace jobs_v3p1beta1 { /** * Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. */ - jobView?: string; + jobView?: string | null; /** * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ - offset?: number; + offset?: number | null; /** * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * `"relevance desc"`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `"posting_publish_time desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_base_compensation desc"`: By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation"`: By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation desc"`: By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"custom_ranking desc"`: By the relevance score adjusted to the SearchJobsRequest.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.importance_level in descending order. * Location sorting: Use the special syntax to order jobs by distance:<br> "`distance_from('Hawaii')`": Order by distance from Hawaii.<br> "`distance_from(19.89, 155.5)`": Order by distance from a coordinate.<br> "`distance_from('Hawaii'), distance_from('Puerto Rico')`": Order by multiple locations. See details below.<br> "`distance_from('Hawaii'), distance_from(19.89, 155.5)`": Order by multiple locations. See details below.<br> The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level. */ - orderBy?: string; + orderBy?: string | null; /** * Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. */ - pageSize?: number; + pageSize?: number | null; /** * Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. */ - pageToken?: string; + pageToken?: string | null; /** * Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as `user_id`) are provided by users, and must be unique and consistent. */ @@ -1168,11 +1168,11 @@ export namespace jobs_v3p1beta1 { /** * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. */ - requirePreciseResultSize?: boolean; + requirePreciseResultSize?: boolean | null; /** * Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. */ - searchMode?: string; + searchMode?: string | null; } /** * Output only. Response for SearchJob method. @@ -1181,11 +1181,11 @@ export namespace jobs_v3p1beta1 { /** * If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results. */ - broadenedQueryJobsCount?: number; + broadenedQueryJobsCount?: number | null; /** * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see enable_precise_result_size. */ - estimatedTotalSize?: number; + estimatedTotalSize?: number | null; /** * The histogram results that match with specified SearchJobsRequest.histogram_queries. */ @@ -1209,7 +1209,7 @@ export namespace jobs_v3p1beta1 { /** * The token that specifies the starting position of the next page of results. This field is empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The spell checking result, and correction. */ @@ -1217,7 +1217,7 @@ export namespace jobs_v3p1beta1 { /** * The precise result count, which is available only if the client set enable_precise_result_size to `true`, or if the response is the last page of results. Otherwise, the value is `-1`. */ - totalSize?: number; + totalSize?: number | null; } /** * Output only. Spell check result. @@ -1226,11 +1226,11 @@ export namespace jobs_v3p1beta1 { /** * Indicates if the query was corrected by the spell checker. */ - corrected?: boolean; + corrected?: boolean | null; /** * Correction output consisting of the corrected keyword string. */ - correctedText?: string; + correctedText?: 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). @@ -1239,15 +1239,15 @@ export namespace jobs_v3p1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. @@ -1256,19 +1256,19 @@ export namespace jobs_v3p1beta1 { /** * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ - hours?: number; + hours?: number | null; /** * Minutes of hour of day. Must be from 0 to 59. */ - minutes?: number; + minutes?: number | null; /** * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ - nanos?: number; + nanos?: number | null; /** * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ - seconds?: number; + seconds?: number | null; } /** * Message representing a period of time between two timestamps. @@ -1277,11 +1277,11 @@ export namespace jobs_v3p1beta1 { /** * End of the period. */ - endTime?: string; + endTime?: string | null; /** * Begin of the period. */ - startTime?: string; + startTime?: string | null; } /** * Input only. Request for updating a specified company. @@ -1294,7 +1294,7 @@ export namespace jobs_v3p1beta1 { /** * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported. */ - updateMask?: string; + updateMask?: string | null; } /** * Input only. Update job request. @@ -1307,7 +1307,7 @@ export namespace jobs_v3p1beta1 { /** * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. */ - updateMask?: string; + updateMask?: string | null; } export class Resource$Projects { diff --git a/src/apis/kgsearch/v1.ts b/src/apis/kgsearch/v1.ts index 0178d066243..f2119293e09 100644 --- a/src/apis/kgsearch/v1.ts +++ b/src/apis/kgsearch/v1.ts @@ -124,15 +124,15 @@ export namespace kgsearch_v1 { /** * The local context applicable for the response. See more details at http://www.w3.org/TR/json-ld/#context-definitions. */ - '@context'?: any; + '@context'?: any | null; /** * The schema type of top-level JSON-LD object, e.g. ItemList. */ - '@type'?: any; + '@type'?: any | null; /** * The item list of search results. */ - itemListElement?: any[]; + itemListElement?: any[] | null; } export class Resource$Entities { diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index 00593958161..f16b9988afc 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -128,7 +128,7 @@ export namespace language_v1 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The entity analysis response message. @@ -141,7 +141,7 @@ export namespace language_v1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; } /** * The entity-level sentiment analysis request message. @@ -154,7 +154,7 @@ export namespace language_v1 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The entity-level sentiment analysis response message. @@ -167,7 +167,7 @@ export namespace language_v1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; } /** * The sentiment analysis request message. @@ -180,7 +180,7 @@ export namespace language_v1 { /** * The encoding type used by the API to calculate sentence offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The sentiment analysis response message. @@ -193,7 +193,7 @@ export namespace language_v1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * The sentiment for all the sentences in the document. */ @@ -210,7 +210,7 @@ export namespace language_v1 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The syntax analysis response message. @@ -219,7 +219,7 @@ export namespace language_v1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * Sentences in the input document. */ @@ -240,7 +240,7 @@ export namespace language_v1 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; /** * Required. The enabled features. */ @@ -265,7 +265,7 @@ export namespace language_v1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ @@ -282,11 +282,11 @@ export namespace language_v1 { /** * The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text. */ - confidence?: number; + confidence?: number | null; /** * The name of the category representing the document, from the [predefined taxonomy](/natural-language/docs/categories). */ - name?: string; + name?: string | null; } /** * The document classification request message. @@ -313,11 +313,11 @@ export namespace language_v1 { /** * Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index. */ - headTokenIndex?: number; + headTokenIndex?: number | null; /** * The parse label for the token. */ - label?: string; + label?: string | null; } /** * ################################################################ # Represents the input to API methods. @@ -326,19 +326,19 @@ export namespace language_v1 { /** * The content of the input in string format. Cloud audit logging exempt since it is based on user data. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported. */ - gcsContentUri?: string; + gcsContentUri?: string | null; /** * 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; + language?: string | null; /** * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error. */ - type?: string; + type?: string | null; } /** * Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities. @@ -351,15 +351,15 @@ export namespace language_v1 { /** * Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * The representative name for the entity. */ - name?: string; + name?: string | null; /** * The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. */ - salience?: number; + salience?: number | null; /** * For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document. */ @@ -367,7 +367,7 @@ export namespace language_v1 { /** * The entity type. */ - type?: string; + type?: string | null; } /** * Represents a mention for an entity in the text. Currently, proper noun mentions are supported. @@ -384,7 +384,7 @@ export namespace language_v1 { /** * The type of the entity mention. */ - type?: string; + type?: string | null; } /** * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. @@ -393,23 +393,23 @@ export namespace language_v1 { /** * Classify the full document into categories. */ - classifyText?: boolean; + classifyText?: boolean | null; /** * Extract document-level sentiment. */ - extractDocumentSentiment?: boolean; + extractDocumentSentiment?: boolean | null; /** * Extract entities. */ - extractEntities?: boolean; + extractEntities?: boolean | null; /** * Extract entities and their associated sentiment. */ - extractEntitySentiment?: boolean; + extractEntitySentiment?: boolean | null; /** * Extract syntax information. */ - extractSyntax?: boolean; + extractSyntax?: boolean | null; } /** * Represents part of speech information for a token. Parts of speech are as defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf @@ -418,51 +418,51 @@ export namespace language_v1 { /** * The grammatical aspect. */ - aspect?: string; + aspect?: string | null; /** * The grammatical case. */ - case?: string; + case?: string | null; /** * The grammatical form. */ - form?: string; + form?: string | null; /** * The grammatical gender. */ - gender?: string; + gender?: string | null; /** * The grammatical mood. */ - mood?: string; + mood?: string | null; /** * The grammatical number. */ - number?: string; + number?: string | null; /** * The grammatical person. */ - person?: string; + person?: string | null; /** * The grammatical properness. */ - proper?: string; + proper?: string | null; /** * The grammatical reciprocity. */ - reciprocity?: string; + reciprocity?: string | null; /** * The part of speech tag. */ - tag?: string; + tag?: string | null; /** * The grammatical tense. */ - tense?: string; + tense?: string | null; /** * The grammatical voice. */ - voice?: string; + voice?: string | null; } /** * Represents a sentence in the input document. @@ -484,11 +484,11 @@ export namespace language_v1 { /** * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative). */ - magnitude?: number; + magnitude?: number | null; /** * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ - score?: number; + score?: number | null; } /** * The `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). @@ -497,15 +497,15 @@ export namespace language_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents an output piece of text. @@ -514,11 +514,11 @@ export namespace language_v1 { /** * The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request. */ - beginOffset?: number; + beginOffset?: number | null; /** * The content of the output text. */ - content?: string; + content?: string | null; } /** * Represents the smallest syntactic building block of the text. @@ -531,7 +531,7 @@ export namespace language_v1 { /** * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. */ - lemma?: string; + lemma?: string | null; /** * Parts of speech tag for this token. */ diff --git a/src/apis/language/v1beta1.ts b/src/apis/language/v1beta1.ts index 8afeedd0abd..d2e6a5541d9 100644 --- a/src/apis/language/v1beta1.ts +++ b/src/apis/language/v1beta1.ts @@ -128,7 +128,7 @@ export namespace language_v1beta1 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The entity analysis response message. @@ -141,7 +141,7 @@ export namespace language_v1beta1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; } /** * The sentiment analysis request message. @@ -154,7 +154,7 @@ export namespace language_v1beta1 { /** * The encoding type used by the API to calculate sentence offsets for the sentence sentiment. */ - encodingType?: string; + encodingType?: string | null; } /** * The sentiment analysis response message. @@ -167,7 +167,7 @@ export namespace language_v1beta1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * The sentiment for all the sentences in the document. */ @@ -184,7 +184,7 @@ export namespace language_v1beta1 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The syntax analysis response message. @@ -193,7 +193,7 @@ export namespace language_v1beta1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * Sentences in the input document. */ @@ -214,7 +214,7 @@ export namespace language_v1beta1 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; /** * The enabled features. */ @@ -235,7 +235,7 @@ export namespace language_v1beta1 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ @@ -252,11 +252,11 @@ export namespace language_v1beta1 { /** * Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index. */ - headTokenIndex?: number; + headTokenIndex?: number | null; /** * The parse label for the token. */ - label?: string; + label?: string | null; } /** * ################################################################ # Represents the input to API methods. @@ -265,19 +265,19 @@ export namespace language_v1beta1 { /** * The content of the input in string format. Cloud audit logging exempt since it is based on user data. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported. */ - gcsContentUri?: string; + gcsContentUri?: string | null; /** * 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; + language?: string | null; /** * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error. */ - type?: string; + type?: string | null; } /** * Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities. @@ -290,19 +290,19 @@ export namespace language_v1beta1 { /** * Metadata associated with the entity. Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if available. The associated keys are "wikipedia_url" and "mid", respectively. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * The representative name for the entity. */ - name?: string; + name?: string | null; /** * The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. */ - salience?: number; + salience?: number | null; /** * The entity type. */ - type?: string; + type?: string | null; } /** * Represents a mention for an entity in the text. Currently, proper noun mentions are supported. @@ -315,7 +315,7 @@ export namespace language_v1beta1 { /** * The type of the entity mention. */ - type?: string; + type?: string | null; } /** * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. @@ -324,15 +324,15 @@ export namespace language_v1beta1 { /** * Extract document-level sentiment. */ - extractDocumentSentiment?: boolean; + extractDocumentSentiment?: boolean | null; /** * Extract entities. */ - extractEntities?: boolean; + extractEntities?: boolean | null; /** * Extract syntax information. */ - extractSyntax?: boolean; + extractSyntax?: boolean | null; } /** * Represents part of speech information for a token. @@ -341,51 +341,51 @@ export namespace language_v1beta1 { /** * The grammatical aspect. */ - aspect?: string; + aspect?: string | null; /** * The grammatical case. */ - case?: string; + case?: string | null; /** * The grammatical form. */ - form?: string; + form?: string | null; /** * The grammatical gender. */ - gender?: string; + gender?: string | null; /** * The grammatical mood. */ - mood?: string; + mood?: string | null; /** * The grammatical number. */ - number?: string; + number?: string | null; /** * The grammatical person. */ - person?: string; + person?: string | null; /** * The grammatical properness. */ - proper?: string; + proper?: string | null; /** * The grammatical reciprocity. */ - reciprocity?: string; + reciprocity?: string | null; /** * The part of speech tag. */ - tag?: string; + tag?: string | null; /** * The grammatical tense. */ - tense?: string; + tense?: string | null; /** * The grammatical voice. */ - voice?: string; + voice?: string | null; } /** * Represents a sentence in the input document. @@ -407,15 +407,15 @@ export namespace language_v1beta1 { /** * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative). */ - magnitude?: number; + magnitude?: number | null; /** * DEPRECATED FIELD - This field is being deprecated in favor of score. Please refer to our documentation at https://cloud.google.com/natural-language/docs for more information. */ - polarity?: number; + polarity?: number | null; /** * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ - score?: number; + score?: number | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -424,15 +424,15 @@ export namespace language_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents an output piece of text. @@ -441,11 +441,11 @@ export namespace language_v1beta1 { /** * The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request. */ - beginOffset?: number; + beginOffset?: number | null; /** * The content of the output text. */ - content?: string; + content?: string | null; } /** * Represents the smallest syntactic building block of the text. @@ -458,7 +458,7 @@ export namespace language_v1beta1 { /** * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. */ - lemma?: string; + lemma?: string | null; /** * Parts of speech tag for this token. */ diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index 8d9a6f0d0b4..62257d81ca2 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -128,7 +128,7 @@ export namespace language_v1beta2 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The entity analysis response message. @@ -141,7 +141,7 @@ export namespace language_v1beta2 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; } /** * The entity-level sentiment analysis request message. @@ -154,7 +154,7 @@ export namespace language_v1beta2 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The entity-level sentiment analysis response message. @@ -167,7 +167,7 @@ export namespace language_v1beta2 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; } /** * The sentiment analysis request message. @@ -180,7 +180,7 @@ export namespace language_v1beta2 { /** * The encoding type used by the API to calculate sentence offsets for the sentence sentiment. */ - encodingType?: string; + encodingType?: string | null; } /** * The sentiment analysis response message. @@ -193,7 +193,7 @@ export namespace language_v1beta2 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * The sentiment for all the sentences in the document. */ @@ -210,7 +210,7 @@ export namespace language_v1beta2 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; } /** * The syntax analysis response message. @@ -219,7 +219,7 @@ export namespace language_v1beta2 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * Sentences in the input document. */ @@ -240,7 +240,7 @@ export namespace language_v1beta2 { /** * The encoding type used by the API to calculate offsets. */ - encodingType?: string; + encodingType?: string | null; /** * Required. The enabled features. */ @@ -265,7 +265,7 @@ export namespace language_v1beta2 { /** * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ - language?: string; + language?: string | null; /** * Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ @@ -282,11 +282,11 @@ export namespace language_v1beta2 { /** * The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text. */ - confidence?: number; + confidence?: number | null; /** * The name of the category representing the document, from the [predefined taxonomy](/natural-language/docs/categories). */ - name?: string; + name?: string | null; } /** * The document classification request message. @@ -313,11 +313,11 @@ export namespace language_v1beta2 { /** * Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index. */ - headTokenIndex?: number; + headTokenIndex?: number | null; /** * The parse label for the token. */ - label?: string; + label?: string | null; } /** * ################################################################ # Represents the input to API methods. @@ -326,19 +326,19 @@ export namespace language_v1beta2 { /** * The content of the input in string format. Cloud audit logging exempt since it is based on user data. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported. */ - gcsContentUri?: string; + gcsContentUri?: string | null; /** * 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; + language?: string | null; /** * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error. */ - type?: string; + type?: string | null; } /** * Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities. @@ -351,15 +351,15 @@ export namespace language_v1beta2 { /** * Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * The representative name for the entity. */ - name?: string; + name?: string | null; /** * The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. */ - salience?: number; + salience?: number | null; /** * For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document. */ @@ -367,7 +367,7 @@ export namespace language_v1beta2 { /** * The entity type. */ - type?: string; + type?: string | null; } /** * Represents a mention for an entity in the text. Currently, proper noun mentions are supported. @@ -384,7 +384,7 @@ export namespace language_v1beta2 { /** * The type of the entity mention. */ - type?: string; + type?: string | null; } /** * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 10 @@ -393,23 +393,23 @@ export namespace language_v1beta2 { /** * Classify the full document into categories. If this is true, the API will use the default model which classifies into a [predefined taxonomy](/natural-language/docs/categories). */ - classifyText?: boolean; + classifyText?: boolean | null; /** * Extract document-level sentiment. */ - extractDocumentSentiment?: boolean; + extractDocumentSentiment?: boolean | null; /** * Extract entities. */ - extractEntities?: boolean; + extractEntities?: boolean | null; /** * Extract entities and their associated sentiment. */ - extractEntitySentiment?: boolean; + extractEntitySentiment?: boolean | null; /** * Extract syntax information. */ - extractSyntax?: boolean; + extractSyntax?: boolean | null; } /** * Represents part of speech information for a token. @@ -418,51 +418,51 @@ export namespace language_v1beta2 { /** * The grammatical aspect. */ - aspect?: string; + aspect?: string | null; /** * The grammatical case. */ - case?: string; + case?: string | null; /** * The grammatical form. */ - form?: string; + form?: string | null; /** * The grammatical gender. */ - gender?: string; + gender?: string | null; /** * The grammatical mood. */ - mood?: string; + mood?: string | null; /** * The grammatical number. */ - number?: string; + number?: string | null; /** * The grammatical person. */ - person?: string; + person?: string | null; /** * The grammatical properness. */ - proper?: string; + proper?: string | null; /** * The grammatical reciprocity. */ - reciprocity?: string; + reciprocity?: string | null; /** * The part of speech tag. */ - tag?: string; + tag?: string | null; /** * The grammatical tense. */ - tense?: string; + tense?: string | null; /** * The grammatical voice. */ - voice?: string; + voice?: string | null; } /** * Represents a sentence in the input document. @@ -484,11 +484,11 @@ export namespace language_v1beta2 { /** * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative). */ - magnitude?: number; + magnitude?: number | null; /** * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ - score?: number; + score?: number | null; } /** * The `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). @@ -497,15 +497,15 @@ export namespace language_v1beta2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents an output piece of text. @@ -514,11 +514,11 @@ export namespace language_v1beta2 { /** * The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request. */ - beginOffset?: number; + beginOffset?: number | null; /** * The content of the output text. */ - content?: string; + content?: string | null; } /** * Represents the smallest syntactic building block of the text. @@ -531,7 +531,7 @@ export namespace language_v1beta2 { /** * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. */ - lemma?: string; + lemma?: string | null; /** * Parts of speech tag for this token. */ diff --git a/src/apis/libraryagent/v1.ts b/src/apis/libraryagent/v1.ts index b10231e6c37..a2563771ffa 100644 --- a/src/apis/libraryagent/v1.ts +++ b/src/apis/libraryagent/v1.ts @@ -124,19 +124,19 @@ export namespace libraryagent_v1 { /** * The name of the book author. */ - author?: string; + author?: string | null; /** * The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book. */ - name?: string; + name?: string | null; /** * Value indicating whether the book has been read. */ - read?: boolean; + read?: boolean | null; /** * The title of the book. */ - title?: string; + title?: string | null; } /** * Response message for LibraryAgent.ListBooks. @@ -149,7 +149,7 @@ export namespace libraryagent_v1 { /** * A token to retrieve next page of results. Pass this value in the ListBooksRequest.page_token field in the subsequent call to `ListBooks` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for LibraryAgent.ListShelves. @@ -158,7 +158,7 @@ export namespace libraryagent_v1 { /** * A token to retrieve next page of results. Pass this value in the ListShelvesRequest.page_token field in the subsequent call to `ListShelves` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of shelves. */ @@ -171,11 +171,11 @@ export namespace libraryagent_v1 { /** * Output only. The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf. */ - name?: string; + name?: string | null; /** * The theme of the shelf */ - theme?: string; + theme?: string | null; } export class Resource$Shelves { diff --git a/src/apis/licensing/v1.ts b/src/apis/licensing/v1.ts index 1d743c9cc35..ad574ada3e8 100644 --- a/src/apis/licensing/v1.ts +++ b/src/apis/licensing/v1.ts @@ -108,35 +108,35 @@ export namespace licensing_v1 { /** * ETag of the resource. */ - etags?: string; + etags?: string | null; /** * Identifies the resource as a LicenseAssignment. */ - kind?: string; + kind?: string | null; /** * Id of the product. */ - productId?: string; + productId?: string | null; /** * Display Name of the product. */ - productName?: string; + productName?: string | null; /** * Link to this page. */ - selfLink?: string; + selfLink?: string | null; /** * Id of the sku of the product. */ - skuId?: string; + skuId?: string | null; /** * Display Name of the sku of the product. */ - skuName?: string; + skuName?: string | null; /** * Email id of the user. */ - userId?: string; + userId?: string | null; } /** * Template for LicenseAssignment Insert request @@ -145,7 +145,7 @@ export namespace licensing_v1 { /** * Email id of the user */ - userId?: string; + userId?: string | null; } /** * LicesnseAssignment List for a given product/sku for a customer. @@ -154,7 +154,7 @@ export namespace licensing_v1 { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * The LicenseAssignments in this page of results. */ @@ -162,11 +162,11 @@ export namespace licensing_v1 { /** * Identifies the resource as a collection of LicenseAssignments. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } export class Resource$Licenseassignments { diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 0137c801fad..c986c77c4c8 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -135,6 +135,15 @@ export namespace logging_v2 { } } + /** + * Options that change functionality of a sink exporting data to BigQuery. + */ + export interface Schema$BigQueryOptions { + /** + * Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone. + */ + usePartitionedTables?: boolean | null; + } /** * BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. */ @@ -163,7 +172,7 @@ export namespace logging_v2 { /** * The values must be monotonically increasing. */ - bounds?: number[]; + bounds?: number[] | null; } /** * Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). @@ -172,15 +181,15 @@ export namespace logging_v2 { /** * Must be greater than 1. */ - growthFactor?: number; + growthFactor?: number | null; /** * Must be greater than 0. */ - numFiniteBuckets?: number; + numFiniteBuckets?: number | null; /** * Must be greater than 0. */ - scale?: number; + scale?: number | null; } /** * A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. @@ -189,63 +198,63 @@ export namespace logging_v2 { /** * The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. */ - cacheFillBytes?: string; + cacheFillBytes?: string | null; /** * Whether or not an entity was served from cache (with or without validation). */ - cacheHit?: boolean; + cacheHit?: boolean | null; /** * Whether or not a cache lookup was attempted. */ - cacheLookup?: boolean; + cacheLookup?: boolean | null; /** * Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True. */ - cacheValidatedWithOriginServer?: boolean; + cacheValidatedWithOriginServer?: boolean | null; /** * The request processing latency on the server, from the time the request was received until the response was sent. */ - latency?: string; + latency?: string | null; /** * Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" */ - protocol?: string; + protocol?: string | null; /** * The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). */ - referer?: string; + referer?: string | null; /** * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329". */ - remoteIp?: string; + remoteIp?: string | null; /** * The request method. Examples: "GET", "HEAD", "PUT", "POST". */ - requestMethod?: string; + requestMethod?: string | null; /** * The size of the HTTP request message in bytes, including the request headers and the request body. */ - requestSize?: string; + requestSize?: string | null; /** * The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red". */ - requestUrl?: string; + requestUrl?: string | null; /** * The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. */ - responseSize?: string; + responseSize?: string | null; /** * The IP address (IPv4 or IPv6) of the origin server that the request was sent to. */ - serverIp?: string; + serverIp?: string | null; /** * The response code indicating the status of response. Examples: 200, 404. */ - status?: number; + status?: number | null; /** * The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". */ - userAgent?: string; + userAgent?: string | null; } /** * A description of a label. @@ -254,15 +263,15 @@ export namespace logging_v2 { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). @@ -271,15 +280,15 @@ export namespace logging_v2 { /** * Must be greater than 0. */ - numFiniteBuckets?: number; + numFiniteBuckets?: number | null; /** * Lower bound of the first bucket. */ - offset?: number; + offset?: number | null; /** * Must be greater than 0. */ - width?: number; + width?: number | null; } /** * Result returned from ListExclusions. @@ -292,7 +301,7 @@ export namespace logging_v2 { /** * If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The parameters to ListLogEntries. @@ -301,27 +310,27 @@ export namespace logging_v2 { /** * Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters. */ - filter?: string; + filter?: string | null; /** * Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc" (default) and "timestamp desc". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values. */ - orderBy?: string; + orderBy?: string | null; /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. */ - pageSize?: number; + pageSize?: number | null; /** * Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call. */ - pageToken?: string; + pageToken?: string | null; /** * Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A". */ - projectIds?: string[]; + projectIds?: string[] | null; /** * Required. Names of one or more parent resources from which to retrieve log entries: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Projects listed in the project_ids field are added to this list. */ - resourceNames?: string[]; + resourceNames?: string[] | null; } /** * Result returned from ListLogEntries. @@ -334,7 +343,7 @@ export namespace logging_v2 { /** * If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Result returned from ListLogMetrics. @@ -347,20 +356,20 @@ export namespace logging_v2 { /** * If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Result returned from ListLogs. */ export interface Schema$ListLogsResponse { /** - * A list of log names. For example, "projects/my-project/syslog" or "organizations/123/cloudresourcemanager.googleapis.com%2Factivity". + * A list of log names. For example, "projects/my-project/logs/syslog" or "organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity". */ - logNames?: string[]; + logNames?: string[] | null; /** * If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Result returned from ListMonitoredResourceDescriptors. @@ -369,7 +378,7 @@ export namespace logging_v2 { /** * If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of resource descriptors. */ @@ -382,7 +391,7 @@ export namespace logging_v2 { /** * If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of sinks. */ @@ -399,19 +408,19 @@ export namespace logging_v2 { /** * Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value. */ - insertId?: string; + insertId?: string | null; /** * The log entry payload, represented as a structure that is expressed as a JSON object. */ - jsonPayload?: {[key: string]: any}; + jsonPayload?: {[key: string]: any} | null; /** * Optional. A set of user-defined (key, value) data that provides additional information about the log entry. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. The resource name of the log to which this log entry belongs: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results. */ - logName?: string; + logName?: string | null; /** * Deprecated. Output only. Additional metadata about the monitored resource.Only k8s_container, k8s_pod, and k8s_node MonitoredResources have this field populated for GKE versions older than 1.12.6. For GKE versions 1.12.6 and above, the metadata field has been deprecated. The Kubernetes pod labels that used to be in metadata.userLabels will now be present in the labels field with a key prefix of k8s-pod/. The Stackdriver system labels that were present in the metadata.systemLabels field will no longer be available in the LogEntry. */ @@ -423,11 +432,11 @@ export namespace logging_v2 { /** * The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.The following protocol buffer types are supported; user-defined types are not supported:"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog" */ - protoPayload?: {[key: string]: any}; + protoPayload?: {[key: string]: any} | null; /** * Output only. The time the log entry was received by Logging. */ - receiveTimestamp?: string; + receiveTimestamp?: string | null; /** * Required. The monitored resource that produced this log entry.Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error. */ @@ -435,7 +444,7 @@ export namespace logging_v2 { /** * Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT. */ - severity?: string; + severity?: string | null; /** * Optional. Source code location information associated with the log entry, if any. */ @@ -443,23 +452,23 @@ export namespace logging_v2 { /** * Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as <code>"000000000000004a"</code>. */ - spanId?: string; + spanId?: string | null; /** * The log entry payload, represented as a Unicode string (UTF-8). */ - textPayload?: string; + textPayload?: string | null; /** * Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks. */ - timestamp?: string; + timestamp?: string | null; /** * Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824 */ - trace?: string; + trace?: string | null; /** * Optional. The sampling decision of the trace associated with the log entry.True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False. */ - traceSampled?: boolean; + traceSampled?: boolean | null; } /** * Additional information about a potentially long-running operation with which a log entry is associated. @@ -468,19 +477,19 @@ export namespace logging_v2 { /** * Optional. Set this to True if this is the first log entry in the operation. */ - first?: boolean; + first?: boolean | null; /** * Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. */ - id?: string; + id?: string | null; /** * Optional. Set this to True if this is the last log entry in the operation. */ - last?: boolean; + last?: boolean | null; /** * Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication". */ - producer?: string; + producer?: string | null; } /** * Additional information about the source code location that produced the log entry. @@ -489,44 +498,44 @@ export namespace logging_v2 { /** * Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. */ - file?: string; + file?: string | null; /** * Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). */ - function?: string; + function?: string | null; /** * Optional. Line within the source file. 1-based; 0 indicates no line number available. */ - line?: string; + line?: string | null; } /** - * Specifies a set of log entries that are not to be stored in Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded. + * Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don't apply to child resources, and that you can't exclude audit log entries. */ export interface Schema$LogExclusion { /** * Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions. */ - createTime?: string; + createTime?: string | null; /** * Optional. A description of this exclusion. */ - description?: string; + description?: string | null; /** * Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field. */ - disabled?: boolean; + disabled?: boolean | null; /** - * Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. For example, the following filter matches 99% of low-severity log entries from load balancers:"resource.type=http_load_balancer severity<ERROR sample(insertId, 0.99)" + * Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:"resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)" */ - filter?: string; + filter?: string | null; /** * Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. */ - name?: string; + name?: string | null; /** * Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions. */ - updateTime?: string; + updateTime?: string | null; } /** * Application log line emitted while processing a request. @@ -535,11 +544,11 @@ export namespace logging_v2 { /** * App-provided log message. */ - logMessage?: string; + logMessage?: string | null; /** * Severity of this log entry. */ - severity?: string; + severity?: string | null; /** * Where in the source code this log message was written. */ @@ -547,7 +556,7 @@ export namespace logging_v2 { /** * Approximate time when this log entry was made. */ - time?: string; + time?: string | null; } /** * Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options. @@ -560,19 +569,19 @@ export namespace logging_v2 { /** * Output only. The creation timestamp of the metric.This field may not be present for older metrics. */ - createTime?: string; + createTime?: string | null; /** * Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. */ - description?: string; + description?: string | null; /** * Required. An advanced logs filter which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters. */ - filter?: string; + filter?: string | null; /** * Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project. */ - labelExtractors?: {[key: string]: string}; + labelExtractors?: {[key: string]: string} | null; /** * Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description. */ @@ -580,56 +589,60 @@ export namespace logging_v2 { /** * Required. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests". */ - name?: string; + name?: string | null; /** * Output only. The last update timestamp of the metric.This field may not be present for older metrics. */ - updateTime?: string; + updateTime?: string | null; /** * Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*") */ - valueExtractor?: string; + valueExtractor?: string | null; /** * Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. */ - version?: string; + version?: string | null; } /** * Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder. */ export interface Schema$LogSink { + /** + * Optional. Options that affect sinks exporting data to BigQuery. + */ + bigqueryOptions?: Schema$BigQueryOptions; /** * Output only. The creation timestamp of the sink.This field may not be present for older sinks. */ - createTime?: string; + createTime?: string | null; /** * Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks. */ - destination?: string; + destination?: string | null; /** * Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR */ - filter?: string; + filter?: string | null; /** * Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance */ - includeChildren?: boolean; + includeChildren?: boolean | null; /** * Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. */ - name?: string; + name?: string | null; /** * Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed. */ - outputVersionFormat?: string; + outputVersionFormat?: string | null; /** * Output only. The last update timestamp of the sink.This field may not be present for older sinks. */ - updateTime?: string; + updateTime?: string | null; /** * Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity. */ - writerIdentity?: string; + writerIdentity?: string | null; } /** * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. @@ -638,11 +651,11 @@ export namespace logging_v2 { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. */ @@ -650,7 +663,7 @@ export namespace logging_v2 { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -658,23 +671,23 @@ export namespace logging_v2 { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -683,15 +696,15 @@ export namespace logging_v2 { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} @@ -700,11 +713,11 @@ export namespace logging_v2 { /** * Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone". */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. */ - type?: string; + type?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API. @@ -713,11 +726,11 @@ export namespace logging_v2 { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone". */ @@ -725,15 +738,15 @@ export namespace logging_v2 { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. @@ -742,11 +755,11 @@ export namespace logging_v2 { /** * Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } */ - systemLabels?: {[key: string]: any}; + systemLabels?: {[key: string]: any} | null; /** * Output only. A map of user-defined metadata labels. */ - userLabels?: {[key: string]: string}; + userLabels?: {[key: string]: string} | null; } /** * Complete log information about a single HTTP request to an App Engine application. @@ -755,51 +768,51 @@ export namespace logging_v2 { /** * App Engine release version. */ - appEngineRelease?: string; + appEngineRelease?: string | null; /** * Application that handled this request. */ - appId?: string; + appId?: string | null; /** * An indication of the relative cost of serving this request. */ - cost?: number; + cost?: number | null; /** * Time when the request finished. */ - endTime?: string; + endTime?: string | null; /** * Whether this request is finished or active. */ - finished?: boolean; + finished?: boolean | null; /** * Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them. */ - first?: boolean; + first?: boolean | null; /** * Internet host and port number of the resource being requested. */ - host?: string; + host?: string | null; /** * HTTP version of request. Example: "HTTP/1.1". */ - httpVersion?: string; + httpVersion?: string | null; /** * An identifier for the instance that handled the request. */ - instanceId?: string; + instanceId?: string | null; /** * If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1. */ - instanceIndex?: number; + instanceIndex?: number | null; /** * Origin IP address. */ - ip?: string; + ip?: string | null; /** * Latency of the request. */ - latency?: string; + latency?: string | null; /** * A list of log lines emitted by the application while serving this request. */ @@ -807,39 +820,39 @@ export namespace logging_v2 { /** * Number of CPU megacycles used to process request. */ - megaCycles?: string; + megaCycles?: string | null; /** * Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE". */ - method?: string; + method?: string | null; /** * Module of the application that handled this request. */ - moduleId?: string; + moduleId?: string | null; /** * The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21. */ - nickname?: string; + nickname?: string | null; /** * Time this request spent in the pending request queue. */ - pendingTime?: string; + pendingTime?: string | null; /** * Referrer URL of request. */ - referrer?: string; + referrer?: string | null; /** * Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier. */ - requestId?: string; + requestId?: string | null; /** * Contains the path and query portion of the URL that was requested. For example, if the URL was "http://example.com/app?name=val", the resource would be "/app?name=val". The fragment identifier, which is identified by the # character, is not included. */ - resource?: string; + resource?: string | null; /** * Size in bytes sent back to client by request. */ - responseSize?: string; + responseSize?: string | null; /** * Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories. */ @@ -847,43 +860,43 @@ export namespace logging_v2 { /** * Time when the request started. */ - startTime?: string; + startTime?: string | null; /** * HTTP response status code. Example: 200, 404. */ - status?: number; + status?: number | null; /** * Task name of the request, in the case of an offline request. */ - taskName?: string; + taskName?: string | null; /** * Queue name of the request, in the case of an offline request. */ - taskQueueName?: string; + taskQueueName?: string | null; /** * Stackdriver Trace identifier for this request. */ - traceId?: string; + traceId?: string | null; /** * If true, the value in the 'trace_id' field was sampled for storage in a trace backend. */ - traceSampled?: boolean; + traceSampled?: boolean | null; /** * File or class that handled the request. */ - urlMapEntry?: string; + urlMapEntry?: string | null; /** * User agent that made the request. */ - userAgent?: string; + userAgent?: string | null; /** * Version of the application that handled this request. */ - versionId?: string; + versionId?: string | null; /** * Whether this was a loading request for the instance. */ - wasLoadingRequest?: boolean; + wasLoadingRequest?: boolean | null; } /** * Specifies a location in a source code file. @@ -892,15 +905,15 @@ export namespace logging_v2 { /** * Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. */ - file?: string; + file?: string | null; /** * Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). */ - functionName?: string; + functionName?: string | null; /** * Line within the source file. */ - line?: string; + line?: string | null; } /** * A reference to a particular snapshot of the source tree used to build and deploy an application. @@ -909,11 +922,11 @@ export namespace logging_v2 { /** * Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" */ - repository?: string; + repository?: string | null; /** * The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" */ - revisionId?: string; + revisionId?: string | null; } /** * The parameters to WriteLogEntries. @@ -922,7 +935,7 @@ export namespace logging_v2 { /** * Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data. */ - dryRun?: boolean; + dryRun?: boolean | null; /** * Required. The log entries to send to Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling entries.list. However, those log entries can still be exported with LogSinks.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry. */ @@ -930,15 +943,15 @@ export namespace logging_v2 { /** * Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example: "projects/my-project-id/logs/syslog" "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity" The permission <code>logging.logEntries.create</code> is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in <code>logName</code> or in an individual log entry. */ - logName?: string; + logName?: string | null; /** * Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method. */ - partialSuccess?: boolean; + partialSuccess?: boolean | null; /** * Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See LogEntry. */ @@ -1269,7 +1282,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". - * @param {string=} params.updateMask Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * @param {string=} params.updateMask Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". * @param {().LogExclusion} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1408,7 +1421,7 @@ export namespace logging_v2 { */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -2634,7 +2647,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". - * @param {string=} params.updateMask Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * @param {string=} params.updateMask Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". * @param {().LogExclusion} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2769,7 +2782,7 @@ export namespace logging_v2 { */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -3099,7 +3112,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". - * @param {string=} params.updateMask Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * @param {string=} params.updateMask Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". * @param {().LogExclusion} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3238,7 +3251,7 @@ export namespace logging_v2 { */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -4599,7 +4612,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". - * @param {string=} params.updateMask Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * @param {string=} params.updateMask Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". * @param {().LogExclusion} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4738,7 +4751,7 @@ export namespace logging_v2 { */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -5807,7 +5820,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". - * @param {string=} params.updateMask Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * @param {string=} params.updateMask Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". * @param {().LogExclusion} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5946,7 +5959,7 @@ export namespace logging_v2 { */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; diff --git a/src/apis/manufacturers/v1.ts b/src/apis/manufacturers/v1.ts index 7245cdb26e7..658c8fe9482 100644 --- a/src/apis/manufacturers/v1.ts +++ b/src/apis/manufacturers/v1.ts @@ -128,11 +128,11 @@ export namespace manufacturers_v1 { /** * The target age group of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#agegroup. */ - ageGroup?: string; + ageGroup?: string | null; /** * The brand name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#brand. */ - brand?: string; + brand?: string | null; /** * The capacity of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity. */ @@ -140,7 +140,7 @@ export namespace manufacturers_v1 { /** * The color of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#color. */ - color?: string; + color?: string | null; /** * The count of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#count. */ @@ -148,15 +148,15 @@ export namespace manufacturers_v1 { /** * The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description. */ - description?: string; + description?: string | null; /** * The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure. */ - disclosureDate?: string; + disclosureDate?: string | null; /** * A list of excluded destinations. */ - excludedDestination?: string[]; + excludedDestination?: string[] | null; /** * The rich format description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc. */ @@ -164,19 +164,19 @@ export namespace manufacturers_v1 { /** * The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor. */ - flavor?: string; + flavor?: string | null; /** * The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format. */ - format?: string; + format?: string | null; /** * The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender. */ - gender?: string; + gender?: string | null; /** * The Global Trade Item Number (GTIN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gtin. */ - gtin?: string[]; + gtin?: string[] | null; /** * The image of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#image. */ @@ -184,23 +184,23 @@ export namespace manufacturers_v1 { /** * A list of included destinations. */ - includedDestination?: string[]; + includedDestination?: string[] | null; /** * The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. */ - itemGroupId?: string; + itemGroupId?: string | null; /** * The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. */ - material?: string; + material?: string | null; /** * The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. */ - mpn?: string; + mpn?: string | null; /** * The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern. */ - pattern?: string; + pattern?: string | null; /** * The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. */ @@ -208,39 +208,39 @@ export namespace manufacturers_v1 { /** * The name of the group of products related to the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productline. */ - productLine?: string; + productLine?: string | null; /** * The canonical name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productname. */ - productName?: string; + productName?: string | null; /** * The URL of the detail page of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productpage. */ - productPageUrl?: string; + productPageUrl?: string | null; /** * The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype. */ - productType?: string[]; + productType?: string[] | null; /** * The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release. */ - releaseDate?: string; + releaseDate?: string | null; /** * The scent of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#scent. */ - scent?: string; + scent?: string | null; /** * The size of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#size. */ - size?: string; + size?: string | null; /** * The size system of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizesystem. */ - sizeSystem?: string; + sizeSystem?: string | null; /** * The size type of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizetype. */ - sizeType?: string; + sizeType?: string | null; /** * The suggested retail price (MSRP) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#price. */ @@ -248,19 +248,19 @@ export namespace manufacturers_v1 { /** * The target client id. Should only be used in the accounts of the data partners. */ - targetClientId?: string; + targetClientId?: string | null; /** * The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme. */ - theme?: string; + theme?: string | null; /** * The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title. */ - title?: string; + title?: string | null; /** * The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video. */ - videoLink?: string[]; + videoLink?: string[] | null; } /** * The capacity of a product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity. @@ -269,11 +269,11 @@ export namespace manufacturers_v1 { /** * The unit of the capacity, i.e., MB, GB, or TB. */ - unit?: string; + unit?: string | null; /** * The numeric value of the capacity. */ - value?: string; + value?: string | null; } /** * The number of products in a single package. For more information, see https://support.google.com/manufacturers/answer/6124116#count. @@ -282,11 +282,11 @@ export namespace manufacturers_v1 { /** * The unit in which these products are counted. */ - unit?: string; + unit?: string | null; /** * The numeric value of the number of products in a package. */ - value?: string; + value?: string | null; } /** * The destination status. @@ -295,11 +295,11 @@ export namespace manufacturers_v1 { /** * The name of the destination. */ - destination?: string; + destination?: string | null; /** * The status of the destination. */ - status?: string; + status?: 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 `{}`. @@ -312,7 +312,7 @@ export namespace manufacturers_v1 { /** * A short description of the feature. */ - headline?: string; + headline?: string | null; /** * An optional image describing the feature. */ @@ -320,7 +320,7 @@ export namespace manufacturers_v1 { /** * A detailed description of the feature. */ - text?: string; + text?: string | null; } /** * An image. @@ -329,15 +329,15 @@ export namespace manufacturers_v1 { /** * The URL of the image. For crawled images, this is the provided URL. For uploaded images, this is a serving URL from Google if the image has been processed successfully. */ - imageUrl?: string; + imageUrl?: string | null; /** * The status of the image. @OutputOnly */ - status?: string; + status?: string | null; /** * The type of the image, i.e., crawled or uploaded. @OutputOnly */ - type?: string; + type?: string | null; } /** * Product issue. @@ -346,41 +346,41 @@ export namespace manufacturers_v1 { /** * If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. */ - attribute?: string; + attribute?: string | null; /** * Longer description of the issue focused on how to resolve it. */ - description?: string; + description?: string | null; /** * The destination this issue applies to. */ - destination?: string; + destination?: string | null; /** * What needs to happen to resolve the issue. */ - resolution?: string; + resolution?: string | null; /** * The severity of the issue. */ - severity?: string; + severity?: string | null; /** * The timestamp when this issue appeared. */ - timestamp?: string; + timestamp?: string | null; /** * Short title describing the nature of the issue. */ - title?: string; + title?: string | null; /** * The server-generated type of the issue, for example, “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc. */ - type?: string; + type?: string | null; } export interface Schema$ListProductsResponse { /** * The token for the retrieval of the next page of product statuses. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of the products. */ @@ -393,11 +393,11 @@ export namespace manufacturers_v1 { /** * The numeric value of the price. */ - amount?: string; + amount?: string | null; /** * The currency in which the price is denoted. */ - currency?: string; + currency?: string | null; } /** * Product data. @@ -410,7 +410,7 @@ export namespace manufacturers_v1 { /** * The content language of the product as a two-letter ISO 639-1 language code (for example, en). */ - contentLanguage?: string; + contentLanguage?: string | null; /** * The status of the destinations. */ @@ -422,19 +422,19 @@ export namespace manufacturers_v1 { /** * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ - name?: string; + name?: string | null; /** * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ - parent?: string; + parent?: string | null; /** * The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ - productId?: string; + productId?: string | null; /** * The target country of the product as a CLDR territory code (for example, US). */ - targetCountry?: string; + targetCountry?: string | null; } /** * A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. @@ -443,15 +443,15 @@ export namespace manufacturers_v1 { /** * The name of the attribute. */ - attributeName?: string; + attributeName?: string | null; /** * The value of the attribute. */ - attributeValue?: string; + attributeValue?: string | null; /** * A short section name that can be reused between multiple product details. */ - sectionName?: string; + sectionName?: string | null; } export class Resource$Accounts { diff --git a/src/apis/mirror/v1.ts b/src/apis/mirror/v1.ts index 7a164a9c65a..9465fd6c471 100644 --- a/src/apis/mirror/v1.ts +++ b/src/apis/mirror/v1.ts @@ -116,8 +116,8 @@ export namespace mirror_v1 { */ export interface Schema$Account { authTokens?: Schema$AuthToken[]; - features?: string[]; - password?: string; + features?: string[] | null; + password?: string | null; userData?: Schema$UserData[]; } /** @@ -127,19 +127,19 @@ export namespace mirror_v1 { /** * The MIME type of the attachment. */ - contentType?: string; + contentType?: string | null; /** * The URL for the content. */ - contentUrl?: string; + contentUrl?: string | null; /** * The ID of the attachment. */ - id?: string; + id?: string | null; /** * Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. */ - isProcessingContent?: boolean; + isProcessingContent?: boolean | null; } /** * A list of Attachments. This is the response from the server to GET requests on the attachments collection. @@ -152,11 +152,11 @@ export namespace mirror_v1 { /** * The type of resource. This is always mirror#attachmentsList. */ - kind?: string; + kind?: string | null; } export interface Schema$AuthToken { - authToken?: string; - type?: string; + authToken?: string | null; + type?: string | null; } /** * A single menu command that is part of a Contact. @@ -165,7 +165,7 @@ export namespace mirror_v1 { /** * The type of operation this command corresponds to. Allowed values are: - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. */ - type?: string; + type?: string | null; } /** * A person or group that can be used as a creator or a contact. @@ -178,47 +178,47 @@ export namespace mirror_v1 { /** * A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. */ - acceptTypes?: string[]; + acceptTypes?: string[] | null; /** * The name to display for this contact. */ - displayName?: string; + displayName?: string | null; /** * An ID for this contact. This is generated by the application and is treated as an opaque token. */ - id?: string; + id?: string | null; /** * Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. */ - imageUrls?: string[]; + imageUrls?: string[] | null; /** * The type of resource. This is always mirror#contact. */ - kind?: string; + kind?: string | null; /** * Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. */ - priority?: number; + priority?: number | null; /** * A list of sharing features that a contact can handle. Allowed values are: - ADD_CAPTION */ - sharingFeatures?: string[]; + sharingFeatures?: string[] | null; /** * The ID of the application that created this contact. This is populated by the API */ - source?: string; + source?: string | null; /** * Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. */ - speakableName?: string; + speakableName?: string | null; /** * The type for this contact. This is used for sorting in UIs. Allowed values are: - INDIVIDUAL - Represents a single person. This is the default. - GROUP - Represents more than a single person. */ - type?: string; + type?: string | null; } /** * A list of Contacts representing contacts. This is the response from the server to GET requests on the contacts collection. @@ -231,7 +231,7 @@ export namespace mirror_v1 { /** * The type of resource. This is always mirror#contacts. */ - kind?: string; + kind?: string | null; } /** * A geographic location that can be associated with a timeline item. @@ -240,35 +240,35 @@ export namespace mirror_v1 { /** * The accuracy of the location fix in meters. */ - accuracy?: number; + accuracy?: number | null; /** * The full address of the location. */ - address?: string; + address?: string | null; /** * The name to be displayed. This may be a business name or a user-defined place, such as "Home". */ - displayName?: string; + displayName?: string | null; /** * The ID of the location. */ - id?: string; + id?: string | null; /** * The type of resource. This is always mirror#location. */ - kind?: string; + kind?: string | null; /** * The latitude, in degrees. */ - latitude?: number; + latitude?: number | null; /** * The longitude, in degrees. */ - longitude?: number; + longitude?: number | null; /** * The time at which this location was captured, formatted according to RFC 3339. */ - timestamp?: string; + timestamp?: string | null; } /** * A list of Locations. This is the response from the server to GET requests on the locations collection. @@ -281,7 +281,7 @@ export namespace mirror_v1 { /** * The type of resource. This is always mirror#locationsList. */ - kind?: string; + kind?: string | null; } /** * A custom menu item that can be presented to the user by a timeline item. @@ -290,23 +290,23 @@ export namespace mirror_v1 { /** * Controls the behavior when the user picks the menu option. Allowed values are: - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. - Built-in actions: - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. - DELETE - Delete the timeline item. - SHARE - Share the timeline item with the available contacts. - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. - NAVIGATE - Navigate to the timeline item's location. - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. - OPEN_URI - Open the payload of the menu item in the browser. - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. - Otherwise, if the creator.email is set, the message is an email. */ - action?: string; + action?: string | null; /** * The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. */ - contextual_command?: string; + contextual_command?: string | null; /** * The ID for this menu item. This is generated by the application and is treated as an opaque token. */ - id?: string; + id?: string | null; /** * A generic payload whose meaning changes depending on this MenuItem's action. - When the action is OPEN_URI, the payload is the URL of the website to view. - When the action is PLAY_VIDEO, the payload is the streaming URL of the video - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input */ - payload?: string; + payload?: string | null; /** * If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. */ - removeWhenSelected?: boolean; + removeWhenSelected?: boolean | null; /** * For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. */ @@ -319,15 +319,15 @@ export namespace mirror_v1 { /** * The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. */ - displayName?: string; + displayName?: string | null; /** * URL of an icon to display with the menu item. */ - iconUrl?: string; + iconUrl?: string | null; /** * The state that this value applies to. Allowed values are: - DEFAULT - Default value shown when displayed in the menuItems list. - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. */ - state?: string; + state?: string | null; } /** * A notification delivered by the API. @@ -336,15 +336,15 @@ export namespace mirror_v1 { /** * The collection that generated the notification. */ - collection?: string; + collection?: string | null; /** * The ID of the item that generated the notification. */ - itemId?: string; + itemId?: string | null; /** * The type of operation that generated the notification. */ - operation?: string; + operation?: string | null; /** * A list of actions taken by the user that triggered the notification. */ @@ -352,11 +352,11 @@ export namespace mirror_v1 { /** * The user token provided by the service when it subscribed for notifications. */ - userToken?: string; + userToken?: string | null; /** * The secret verify token provided by the service when it subscribed for notifications. */ - verifyToken?: string; + verifyToken?: string | null; } /** * Controls how notifications for a timeline item are presented to the user. @@ -365,11 +365,11 @@ export namespace mirror_v1 { /** * The time at which the notification should be delivered. */ - deliveryTime?: string; + deliveryTime?: string | null; /** * Describes how important the notification is. Allowed values are: - DEFAULT - Notifications of default importance. A chime will be played to alert users. */ - level?: string; + level?: string | null; } /** * A setting for Glass. @@ -378,15 +378,15 @@ export namespace mirror_v1 { /** * The setting's ID. The following IDs are valid: - locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content. - timezone - The key to the user’s current time zone region as defined in the tz database. Example: America/Los_Angeles. */ - id?: string; + id?: string | null; /** * The type of resource. This is always mirror#setting. */ - kind?: string; + kind?: string | null; /** * The setting value, as a string. */ - value?: string; + value?: string | null; } /** * A subscription to events on a collection. @@ -395,19 +395,19 @@ export namespace mirror_v1 { /** * The URL where notifications should be delivered (must start with https://). */ - callbackUrl?: string; + callbackUrl?: string | null; /** * The collection to subscribe to. Allowed values are: - timeline - Changes in the timeline including insertion, deletion, and updates. - locations - Location updates. - settings - Settings updates. */ - collection?: string; + collection?: string | null; /** * The ID of the subscription. */ - id?: string; + id?: string | null; /** * The type of resource. This is always mirror#subscription. */ - kind?: string; + kind?: string | null; /** * Container object for notifications. This is not populated in the Subscription resource. */ @@ -415,19 +415,19 @@ export namespace mirror_v1 { /** * A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are: - UPDATE - The item has been updated. - INSERT - A new item has been inserted. - DELETE - The item has been deleted. - MENU_ACTION - A custom menu item has been triggered by the user. */ - operation?: string[]; + operation?: string[] | null; /** * The time at which this subscription was last modified, formatted according to RFC 3339. */ - updated?: string; + updated?: string | null; /** * An opaque token sent to the subscriber in notifications so that it can determine the ID of the user. */ - userToken?: string; + userToken?: string | null; /** * A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google. */ - verifyToken?: string; + verifyToken?: string | null; } /** * A list of Subscriptions. This is the response from the server to GET requests on the subscription collection. @@ -440,7 +440,7 @@ export namespace mirror_v1 { /** * The type of resource. This is always mirror#subscriptionsList. */ - kind?: string; + kind?: string | null; } /** * Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. @@ -453,15 +453,15 @@ export namespace mirror_v1 { /** * The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. */ - bundleId?: string; + bundleId?: string | null; /** * A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. */ - canonicalUrl?: string; + canonicalUrl?: string | null; /** * The time at which this item was created, formatted according to RFC 3339. */ - created?: string; + created?: string | null; /** * The user or group that created this item. */ @@ -469,39 +469,39 @@ export namespace mirror_v1 { /** * The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. */ - displayTime?: string; + displayTime?: string | null; /** * ETag for this item. */ - etag?: string; + etag?: string | null; /** * HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. Allowed HTML elements - You can use these elements in your timeline cards. - Headers: h1, h2, h3, h4, h5, h6 - Images: img - Lists: li, ol, ul - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time - Structural: blockquote, br, div, hr, p, span - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup - Tables: table, tbody, td, tfoot, th, thead, tr Blocked HTML elements: These elements and their contents are removed from HTML payloads. - Document headers: head, title - Embeds: audio, embed, object, source, video - Frames: frame, frameset - Scripting: applet, script Other elements: Any elements that aren't listed are removed, but their contents are preserved. */ - html?: string; + html?: string | null; /** * The ID of the timeline item. This is unique within a user's timeline. */ - id?: string; + id?: string | null; /** * If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. */ - inReplyTo?: string; + inReplyTo?: string | null; /** * Whether this item is a bundle cover. If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. On the main timeline, items that are shown are: - Items that have isBundleCover set to true - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: - Items that have the bundleId in question AND isBundleCover set to false */ - isBundleCover?: boolean; + isBundleCover?: boolean | null; /** * When true, indicates this item is deleted, and only the ID property is set. */ - isDeleted?: boolean; + isDeleted?: boolean | null; /** * When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. */ - isPinned?: boolean; + isPinned?: boolean | null; /** * The type of resource. This is always mirror#timelineItem. */ - kind?: string; + kind?: string | null; /** * The geographic location associated with this item. */ @@ -517,7 +517,7 @@ export namespace mirror_v1 { /** * For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. */ - pinScore?: number; + pinScore?: number | null; /** * A list of users or groups that this item has been shared with. */ @@ -525,31 +525,31 @@ export namespace mirror_v1 { /** * A URL that can be used to retrieve this item. */ - selfLink?: string; + selfLink?: string | null; /** * Opaque string you can use to map a timeline item to data in your own service. */ - sourceItemId?: string; + sourceItemId?: string | null; /** * The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. */ - speakableText?: string; + speakableText?: string | null; /** * A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. */ - speakableType?: string; + speakableType?: string | null; /** * Text content of this item. */ - text?: string; + text?: string | null; /** * The title of this item. */ - title?: string; + title?: string | null; /** * The time at which this item was last modified, formatted according to RFC 3339. */ - updated?: string; + updated?: string | null; } /** * A list of timeline items. This is the response from the server to GET requests on the timeline collection. @@ -562,11 +562,11 @@ export namespace mirror_v1 { /** * The type of resource. This is always mirror#timeline. */ - kind?: string; + kind?: string | null; /** * The next page token. Provide this as the pageToken parameter in the request to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Represents an action taken by the user that triggered a notification. @@ -575,15 +575,15 @@ export namespace mirror_v1 { /** * An optional payload for the action. For actions of type CUSTOM, this is the ID of the custom menu item that was selected. */ - payload?: string; + payload?: string | null; /** * The type of action. The value of this can be: - SHARE - the user shared an item. - REPLY - the user replied to an item. - REPLY_ALL - the user replied to all recipients of an item. - CUSTOM - the user selected a custom menu item on the timeline item. - DELETE - the user deleted the item. - PIN - the user pinned the item. - UNPIN - the user unpinned the item. - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored. */ - type?: string; + type?: string | null; } export interface Schema$UserData { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export class Resource$Accounts { diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index c2c0ca19937..98903b427fc 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -124,15 +124,15 @@ export namespace ml_v1 { /** * The HTTP Content-Type header value specifying the content type of the body. */ - contentType?: string; + contentType?: string | null; /** * The HTTP request/response body as raw binary. */ - data?: string; + data?: string | null; /** * Application specific response metadata. Must be set in the first response for streaming APIs. */ - extensions?: Array<{[key: string]: any}>; + extensions?: Array<{[key: string]: any}> | null; } /** * An observed value of a metric. @@ -141,11 +141,11 @@ export namespace ml_v1 { /** * The objective value at this training step. */ - objectiveValue?: number; + objectiveValue?: number | null; /** * The global training step for this metric. */ - trainingStep?: string; + trainingStep?: string | null; } /** * Represents a hardware accelerator request config. @@ -154,11 +154,11 @@ export namespace ml_v1 { /** * The number of accelerators to attach to each machine running the job. */ - count?: string; + count?: string | null; /** * The type of accelerator to use. */ - type?: string; + type?: string | null; } /** * Options for automatically scaling a model. @@ -167,7 +167,7 @@ export namespace ml_v1 { /** * Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If not specified, `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: <pre> update_body.json: { 'autoScaling': { 'minNodes': 5 } } </pre> HTTP request: <pre> PATCH https://ml.googleapis.com/v1/{name=projects/x/models/x/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json </pre> */ - minNodes?: number; + minNodes?: number | null; } /** * Represents output related to a built-in algorithm Job. @@ -176,19 +176,19 @@ export namespace ml_v1 { /** * Framework on which the built-in algorithm was trained. */ - framework?: string; + framework?: string | null; /** * The Cloud Storage path to the `model/` directory where the training job saves the trained model. Only set for successful jobs that don't use hyperparameter tuning. */ - modelPath?: string; + modelPath?: string | null; /** * Python version on which the built-in algorithm was trained. */ - pythonVersion?: string; + pythonVersion?: string | null; /** * AI Platform runtime version on which the built-in algorithm was trained. */ - runtimeVersion?: string; + runtimeVersion?: string | null; } /** * Request message for the CancelJob method. @@ -198,14 +198,14 @@ export namespace ml_v1 { /** * Available accelerators for the capability. */ - availableAccelerators?: string[]; - type?: string; + availableAccelerators?: string[] | null; + type?: string | null; } export interface Schema$GoogleCloudMlV1__Config { /** * The service account Cloud ML uses to run on TPU node. */ - tpuServiceAccount?: string; + tpuServiceAccount?: string | null; } /** * Returns service account information associated with a project. @@ -215,11 +215,11 @@ export namespace ml_v1 { /** * The service account Cloud ML uses to access resources in the project. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * The project number for `service_account`. */ - serviceAccountProject?: string; + serviceAccountProject?: string | null; } /** * Represents the result of a single hyperparameter tuning trial from a training job. The TrainingOutput object that is returned on successful completion of a training job with hyperparameter tuning includes a list of HyperparameterOutput objects, one for each successful trial. @@ -236,7 +236,7 @@ export namespace ml_v1 { /** * Output only. End time for the trial. */ - endTime?: string; + endTime?: string | null; /** * The final objective metric seen for this trial. */ @@ -244,23 +244,23 @@ export namespace ml_v1 { /** * The hyperparameters given to this trial. */ - hyperparameters?: {[key: string]: string}; + hyperparameters?: {[key: string]: string} | null; /** * True if the trial is stopped early. */ - isTrialStoppedEarly?: boolean; + isTrialStoppedEarly?: boolean | null; /** * Output only. Start time for the trial. */ - startTime?: string; + startTime?: string | null; /** * Output only. The detailed state of the trial. */ - state?: string; + state?: string | null; /** * The trial id for these results. */ - trialId?: string; + trialId?: string | null; } /** * Represents a set of hyperparameters to optimize. @@ -269,31 +269,31 @@ export namespace ml_v1 { /** * Optional. The search algorithm specified for the hyperparameter tuning job. Uses the default AI Platform hyperparameter tuning algorithm if unspecified. */ - algorithm?: string; + algorithm?: string | null; /** * Optional. Indicates if the hyperparameter tuning job enables auto trial early stopping. */ - enableTrialEarlyStopping?: boolean; + enableTrialEarlyStopping?: boolean | null; /** * Required. The type of goal to use for tuning. Available types are `MAXIMIZE` and `MINIMIZE`. Defaults to `MAXIMIZE`. */ - goal?: string; + goal?: string | null; /** * Optional. The TensorFlow summary tag name to use for optimizing trials. For current versions of TensorFlow, this tag name should exactly match what is shown in TensorBoard, including all scopes. For versions of TensorFlow prior to 0.12, this should be only the tag passed to tf.Summary. By default, "training/hptuning/metric" will be used. */ - hyperparameterMetricTag?: string; + hyperparameterMetricTag?: string | null; /** * Optional. The number of failed trials that need to be seen before failing the hyperparameter tuning job. You can specify this field to override the default failing criteria for AI Platform hyperparameter tuning jobs. Defaults to zero, which means the service decides when a hyperparameter job should fail. */ - maxFailedTrials?: number; + maxFailedTrials?: number | null; /** * Optional. The number of training trials to run concurrently. You can reduce the time it takes to perform hyperparameter tuning by adding trials in parallel. However, each trail only benefits from the information gained in completed trials. That means that a trial does not get access to the results of trials running at the same time, which could reduce the quality of the overall optimization. Each trial will use the same scale tier and machine types. Defaults to one. */ - maxParallelTrials?: number; + maxParallelTrials?: number | null; /** * Optional. How many training trials should be attempted to optimize the specified hyperparameters. Defaults to one. */ - maxTrials?: number; + maxTrials?: number | null; /** * Required. The set of parameters to tune. */ @@ -301,7 +301,7 @@ export namespace ml_v1 { /** * Optional. The prior hyperparameter tuning job id that users hope to continue with. The job id will be used to find the corresponding vizier study guid and resume the study. */ - resumePreviousJobId?: string; + resumePreviousJobId?: string | null; } /** * Represents a training or prediction job. @@ -310,27 +310,27 @@ export namespace ml_v1 { /** * Output only. When the job was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. When the job processing was completed. */ - endTime?: string; + endTime?: string | null; /** * Output only. The details of a failure or a cancellation. */ - errorMessage?: string; + errorMessage?: string | null; /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job. */ - etag?: string; + etag?: string | null; /** * Required. The user-specified id of the job. */ - jobId?: string; + jobId?: string | null; /** * Optional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on <a href="/ml-engine/docs/tensorflow/resource-labels">using labels</a>. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Input parameters to create a prediction job. */ @@ -342,11 +342,11 @@ export namespace ml_v1 { /** * Output only. When the job processing was started. */ - startTime?: string; + startTime?: string | null; /** * Output only. The detailed state of a job. */ - state?: string; + state?: string | null; /** * Input parameters to create a training job. */ @@ -367,7 +367,7 @@ export namespace ml_v1 { /** * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$GoogleCloudMlV1__ListLocationsResponse { /** @@ -377,7 +377,7 @@ export namespace ml_v1 { /** * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for the ListModels method. @@ -390,7 +390,7 @@ export namespace ml_v1 { /** * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for the ListVersions method. @@ -399,7 +399,7 @@ export namespace ml_v1 { /** * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of versions. */ @@ -410,7 +410,7 @@ export namespace ml_v1 { * Capabilities available in the location. */ capabilities?: Schema$GoogleCloudMlV1__Capability[]; - name?: string; + name?: string | null; } /** * Options for manually scaling a model. @@ -419,7 +419,7 @@ export namespace ml_v1 { /** * The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to `nodes` * number of hours since last billing cycle plus the cost for each prediction performed. */ - nodes?: number; + nodes?: number | null; } /** * Represents a machine learning solution. A model can have multiple versions, each of which is a deployed, trained model ready to receive prediction requests. The model itself is just a container. @@ -432,31 +432,31 @@ export namespace ml_v1 { /** * Optional. The description specified for the model when it was created. */ - description?: string; + description?: string | null; /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetModel`, and systems are expected to put that etag in the request to `UpdateModel` to ensure that their change will be applied to the model as intended. */ - etag?: string; + etag?: string | null; /** * Optional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on <a href="/ml-engine/docs/tensorflow/resource-labels">using labels</a>. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. The name specified for the model when it was created. The model name must be unique within the project it is created in. */ - name?: string; + name?: string | null; /** * Optional. If true, online prediction nodes send `stderr` and `stdout` streams to Stackdriver Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false. */ - onlinePredictionConsoleLogging?: boolean; + onlinePredictionConsoleLogging?: boolean | null; /** * Optional. If true, online prediction access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false. */ - onlinePredictionLogging?: boolean; + onlinePredictionLogging?: boolean | null; /** * Optional. The list of regions where the model is going to be deployed. Currently only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for AI Platform services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field. */ - regions?: string[]; + regions?: string[] | null; } /** * Represents the metadata of the long-running operation. @@ -465,35 +465,35 @@ export namespace ml_v1 { /** * The time the operation was submitted. */ - createTime?: string; + createTime?: string | null; /** * The time operation processing completed. */ - endTime?: string; + endTime?: string | null; /** * Indicates whether a request to cancel this operation has been made. */ - isCancellationRequested?: boolean; + isCancellationRequested?: boolean | null; /** * The user labels, inherited from the model or the model version being operated on. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Contains the name of the model associated with the operation. */ - modelName?: string; + modelName?: string | null; /** * The operation type. */ - operationType?: string; + operationType?: string | null; /** * Contains the project number associated with the operation. */ - projectNumber?: string; + projectNumber?: string | null; /** * The time operation processing started. */ - startTime?: string; + startTime?: string | null; /** * Contains the version associated with the operation. */ @@ -506,31 +506,31 @@ export namespace ml_v1 { /** * Required if type is `CATEGORICAL`. The list of possible categories. */ - categoricalValues?: string[]; + categoricalValues?: string[] | null; /** * Required if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values. */ - discreteValues?: number[]; + discreteValues?: number[] | null; /** * Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is `INTEGER`. */ - maxValue?: number; + maxValue?: number | null; /** * Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is INTEGER. */ - minValue?: number; + minValue?: number | null; /** * Required. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., "learning_rate". */ - parameterName?: string; + parameterName?: string | null; /** * Optional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., `UNIT_LINEAR_SCALE`). */ - scaleType?: string; + scaleType?: string | null; /** * Required. The type of the parameter. */ - type?: string; + type?: string | null; } /** * Represents input parameters for a prediction job. @@ -539,51 +539,51 @@ export namespace ml_v1 { /** * Optional. Number of records per batch, defaults to 64. The service will buffer batch_size number of records in memory before invoking one Tensorflow prediction call internally. So take the record size and memory available into consideration when setting this parameter. */ - batchSize?: string; + batchSize?: string | null; /** * Required. The format of the input data files. */ - dataFormat?: string; + dataFormat?: string | null; /** * Required. The Cloud Storage location of the input data files. May contain <a href="/storage/docs/gsutil/addlhelp/WildcardNames">wildcards</a>. */ - inputPaths?: string[]; + inputPaths?: string[] | null; /** * Optional. The maximum number of workers to be used for parallel processing. Defaults to 10 if not specified. */ - maxWorkerCount?: string; + maxWorkerCount?: string | null; /** * Use this field if you want to use the default version for the specified model. The string must use the following format: `"projects/YOUR_PROJECT/models/YOUR_MODEL"` */ - modelName?: string; + modelName?: string | null; /** * Optional. Format of the output data files, defaults to JSON. */ - outputDataFormat?: string; + outputDataFormat?: string | null; /** * Required. The output Google Cloud Storage location. */ - outputPath?: string; + outputPath?: string | null; /** * Required. The Google Compute Engine region to run the prediction job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for AI Platform services. */ - region?: string; + region?: string | null; /** * Optional. The AI Platform runtime version to use for this batch prediction. If not set, AI Platform will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri. */ - runtimeVersion?: string; + runtimeVersion?: string | null; /** * Optional. The name of the signature defined in the SavedModel to use for this job. Please refer to [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) for information about how to use signatures. Defaults to [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/tf/saved_model/signature_constants) , which is "serving_default". */ - signatureName?: string; + signatureName?: string | null; /** * Use this field if you want to specify a Google Cloud Storage path for the model to use. */ - uri?: string; + uri?: string | null; /** * Use this field if you want to specify a version of the model to use. The string is formatted the same way as `model_version`, with the addition of the version information: `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"` */ - versionName?: string; + versionName?: string | null; } /** * Represents results of a prediction job. @@ -592,19 +592,19 @@ export namespace ml_v1 { /** * The number of data instances which resulted in errors. */ - errorCount?: string; + errorCount?: string | null; /** * Node hours used by the batch prediction job. */ - nodeHours?: number; + nodeHours?: number | null; /** * The output Google Cloud Storage location provided at the job creation time. */ - outputPath?: string; + outputPath?: string | null; /** * The number of generated predictions. */ - predictionCount?: string; + predictionCount?: string | null; } /** * Request for predictions to be issued against a trained model. @@ -626,24 +626,24 @@ export namespace ml_v1 { /** * The Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ - imageUri?: string; + imageUri?: string | null; /** * The AI Platform runtime version that includes a TensorFlow version matching the one used in the custom container. This field is required if the replica is a TPU worker that uses a custom container. Otherwise, do not specify this field. This must be a [runtime version that currently supports training with TPUs](/ml-engine/docs/tensorflow/runtime-version-list#tpu-support). Note that the version of TensorFlow included in a runtime version may differ from the numbering of the runtime version itself, because it may have a different [patch version](https://www.tensorflow.org/guide/version_compat#semantic_versioning_20). In this field, you must specify the runtime version (TensorFlow minor version). For example, if your custom container runs TensorFlow `1.x.y`, specify `1.x`. */ - tpuTfVersion?: string; + tpuTfVersion?: string | null; } /** - * Configurations for logging request-response pairs. Currently only BigQuery logging is supported. The request and response will be converted to raw string and stored within the specified BigQuery table. The schema is: model: STRING version: STRING time: Timestamp raw_data: STRING raw_prediction: STRING ground_truth: STRING + * Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. */ export interface Schema$GoogleCloudMlV1__RequestLoggingConfig { /** - * Fully qualified BigQuery table name in the format of "[project_id].[dataset_name].[table_name]". + * Required. Fully qualified BigQuery table name in the following format: "<var>project_id</var>.<var>dataset_name</var>.<var>table_name</var>" The specifcied table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): <table> <tr><th>Field name</th><th style="display: table-cell">Type</th> <th style="display: table-cell">Mode</th></tr> <tr><td>model</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>model_version</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>time</td><td>TIMESTAMP</td><td>REQUIRED</td></tr> <tr><td>raw_data</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>raw_prediction</td><td>STRING</td><td>NULLABLE</td></tr> <tr><td>groundtruth</td><td>STRING</td><td>NULLABLE</td></tr> </table> */ - bigqueryTableName?: string; + bigqueryTableName?: string | null; /** - * Percentage of the request being logged. The sampling window is the lifetime of the Version. Defaults to 0. + * Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. */ - samplingPercentage?: number; + samplingPercentage?: number | null; } /** * Request message for the SetDefaultVersion request. @@ -656,7 +656,7 @@ export namespace ml_v1 { /** * Optional. Command line arguments to pass to the program. */ - args?: string[]; + args?: string[] | null; /** * Optional. The set of Hyperparameters to tune. */ @@ -664,7 +664,7 @@ export namespace ml_v1 { /** * Optional. A Google Cloud Storage path in which to store training outputs and other data needed for training. This path is passed to your TensorFlow program as the '--job-dir' command-line argument. The benefit of specifying this field is that Cloud ML validates the path for use in training. */ - jobDir?: string; + jobDir?: string | null; /** * Optional. The configuration for your master worker. You should only set `masterConfig.acceleratorConfig` if `masterType` is set to a Compute Engine machine type. Learn about [restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `masterConfig.imageUri` only if you build a custom image. Only one of `masterConfig.imageUri` and `runtimeVersion` should be set. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ @@ -672,11 +672,11 @@ export namespace ml_v1 { /** * Optional. Specifies the type of virtual machine to use for your training job's master worker. The following types are supported: <dl> <dt>standard</dt> <dd> A basic machine configuration suitable for training simple models with small to moderate datasets. </dd> <dt>large_model</dt> <dd> A machine with a lot of memory, specially suited for parameter servers when your model is large (having many hidden layers or layers with very large numbers of nodes). </dd> <dt>complex_model_s</dt> <dd> A machine suitable for the master and workers of the cluster when your model requires more computation than the standard machine can handle satisfactorily. </dd> <dt>complex_model_m</dt> <dd> A machine with roughly twice the number of cores and roughly double the memory of <i>complex_model_s</i>. </dd> <dt>complex_model_l</dt> <dd> A machine with roughly twice the number of cores and roughly double the memory of <i>complex_model_m</i>. </dd> <dt>standard_gpu</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla K80 GPU. See more about <a href="/ml-engine/docs/tensorflow/using-gpus">using GPUs to train your model</a>. </dd> <dt>complex_model_m_gpu</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla K80 GPUs. </dd> <dt>complex_model_l_gpu</dt> <dd> A machine equivalent to <i>complex_model_l</i> that also includes eight NVIDIA Tesla K80 GPUs. </dd> <dt>standard_p100</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla P100 GPU. </dd> <dt>complex_model_m_p100</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla P100 GPUs. </dd> <dt>standard_v100</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla V100 GPU. </dd> <dt>large_model_v100</dt> <dd> A machine equivalent to <i>large_model</i> that also includes a single NVIDIA Tesla V100 GPU. </dd> <dt>complex_model_m_v100</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla V100 GPUs. </dd> <dt>complex_model_l_v100</dt> <dd> A machine equivalent to <i>complex_model_l</i> that also includes eight NVIDIA Tesla V100 GPUs. </dd> <dt>cloud_tpu</dt> <dd> A TPU VM including one Cloud TPU. See more about <a href="/ml-engine/docs/tensorflow/using-tpus">using TPUs to train your model</a>. </dd> </dl> You may also use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` See more about [using Compute Engine machine types](/ml-engine/docs/tensorflow/machine-types#compute-engine-machine-types). You must set this value when `scaleTier` is set to `CUSTOM`. */ - masterType?: string; + masterType?: string | null; /** * Required. The Google Cloud Storage location of the packages with the training program and any additional dependencies. The maximum number of package URIs is 100. */ - packageUris?: string[]; + packageUris?: string[] | null; /** * Optional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerConfigType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ @@ -684,31 +684,31 @@ export namespace ml_v1 { /** * Optional. The number of parameter server replicas to use for the training job. Each replica in the cluster will be of the type specified in `parameter_server_type`. This value can only be used when `scale_tier` is set to `CUSTOM`.If you set this value, you must also set `parameter_server_type`. The default value is zero. */ - parameterServerCount?: string; + parameterServerCount?: string | null; /** * Optional. Specifies the type of virtual machine to use for your training job's parameter server. The supported values are the same as those described in the entry for `master_type`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be AI Platform machine types or both must be Compute Engine machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `parameter_server_count` is greater than zero. */ - parameterServerType?: string; + parameterServerType?: string | null; /** * Required. The Python module name to run after installing the packages. */ - pythonModule?: string; + 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>. */ - pythonVersion?: string; + pythonVersion?: string | null; /** * Required. The Google Compute Engine region to run the training job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for AI Platform services. */ - region?: string; + 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>. */ - runtimeVersion?: string; + runtimeVersion?: string | null; /** * Required. Specifies the machine types, the number of replicas for workers and parameter servers. */ - scaleTier?: string; + scaleTier?: string | null; /** * Optional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ @@ -716,11 +716,11 @@ export namespace ml_v1 { /** * Optional. The number of worker replicas to use for the training job. Each replica in the cluster will be of the type specified in `worker_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `worker_type`. The default value is zero. */ - workerCount?: string; + workerCount?: string | null; /** * Optional. Specifies the type of virtual machine to use for your training job's worker nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be AI Platform machine types or both must be Compute Engine machine types. If you use `cloud_tpu` for this value, see special instructions for [configuring a custom TPU machine](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). This value must be present when `scaleTier` is set to `CUSTOM` and `workerCount` is greater than zero. */ - workerType?: string; + workerType?: string | null; } /** * Represents results of a training job. Output only. @@ -733,23 +733,23 @@ export namespace ml_v1 { /** * The number of hyperparameter tuning trials that completed successfully. Only set for hyperparameter tuning jobs. */ - completedTrialCount?: string; + completedTrialCount?: string | null; /** * The amount of ML units consumed by the job. */ - consumedMLUnits?: number; + consumedMLUnits?: number | null; /** * The TensorFlow summary tag name used for optimizing hyperparameter tuning trials. See [`HyperparameterSpec.hyperparameterMetricTag`](#HyperparameterSpec.FIELDS.hyperparameter_metric_tag) for more information. Only set for hyperparameter tuning jobs. */ - hyperparameterMetricTag?: string; + hyperparameterMetricTag?: string | null; /** * Whether this job is a built-in Algorithm job. */ - isBuiltInAlgorithmJob?: boolean; + isBuiltInAlgorithmJob?: boolean | null; /** * Whether this job is a hyperparameter tuning job. */ - isHyperparameterTuningJob?: boolean; + isHyperparameterTuningJob?: boolean | null; /** * Results for individual Hyperparameter trials. Only set for hyperparameter tuning jobs. */ @@ -766,43 +766,43 @@ export namespace ml_v1 { /** * Output only. The time the version was created. */ - createTime?: string; + 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. */ - deploymentUri?: string; + deploymentUri?: string | null; /** * Optional. The description specified for the version when it was created. */ - description?: string; + description?: string | null; /** * Output only. The details of a failure or a cancellation. */ - errorMessage?: string; + errorMessage?: string | null; /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended. */ - etag?: string; + etag?: string | null; /** * Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ml-engine/docs/tensorflow/custom-prediction-routines). */ - framework?: string; + 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). */ - isDefault?: boolean; + isDefault?: boolean | null; /** * Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on <a href="/ml-engine/docs/tensorflow/resource-labels">using labels</a>. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The time the version was last used for prediction. */ - lastUseTime?: string; + lastUseTime?: string | null; /** * Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. <dl> <dt>mls1-c1-m2</dt> <dd> The <b>default</b> machine type, with 1 core and 2 GB RAM. The deprecated name for this machine type is "mls1-highmem-1". </dd> <dt>mls1-c4-m2</dt> <dd> In <b>Beta</b>. This machine type has 4 cores and 2 GB RAM. The deprecated name for this machine type is "mls1-highcpu-4". </dd> </dl> */ - machineType?: string; + machineType?: string | null; /** * Manually select the number of nodes to use for serving the model. You should generally use `auto_scaling` with an appropriate `min_nodes` instead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes. */ @@ -810,19 +810,19 @@ export namespace ml_v1 { /** * Required. The name specified for the version when it was created. The version name must be unique within the model it is created in. */ - name?: string; + name?: string | null; /** * Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. */ - packageUris?: string[]; + packageUris?: string[] | null; /** * Optional. The fully qualified name (<var>module_name</var>.<var>class_name</var>) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. The following code sample provides the Predictor interface: ```py class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() ``` Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). */ - predictionClass?: string; + 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. */ - pythonVersion?: string; + pythonVersion?: string | null; /** * Optional. Configures the request-response pair logging on predictions from this Version. */ @@ -830,15 +830,15 @@ export namespace ml_v1 { /** * 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). */ - runtimeVersion?: string; + runtimeVersion?: string | null; /** * Optional. Specifies the service account for resource access control. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Output only. The state of a version. */ - state?: string; + state?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -851,7 +851,7 @@ export namespace ml_v1 { /** * 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; + 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. @@ -860,11 +860,11 @@ export namespace ml_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -877,11 +877,11 @@ export namespace ml_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -898,11 +898,11 @@ export namespace ml_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -915,7 +915,7 @@ export namespace ml_v1 { /** * 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; + updateMask?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -924,7 +924,7 @@ export namespace ml_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -933,7 +933,7 @@ export namespace ml_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * The response message for Operations.ListOperations. @@ -942,7 +942,7 @@ export namespace ml_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -955,7 +955,7 @@ export namespace ml_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -963,15 +963,15 @@ export namespace ml_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -984,15 +984,15 @@ export namespace ml_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -1001,19 +1001,19 @@ export namespace ml_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } export class Resource$Projects { diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 192feec4601..3e3bc3e78f0 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -126,19 +126,19 @@ export namespace monitoring_v3 { /** * 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; + 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; + 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[]; + 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; + perSeriesAligner?: string | null; } /** * A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting. @@ -147,7 +147,7 @@ export namespace monitoring_v3 { /** * How to combine the results of multiple conditions to determine if an incident should be opened. */ - combiner?: string; + 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. */ @@ -159,7 +159,7 @@ export namespace monitoring_v3 { /** * A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters. */ - displayName?: string; + displayName?: string | null; /** * Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. */ @@ -167,7 +167,7 @@ export namespace monitoring_v3 { /** * Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. */ - enabled?: boolean; + enabled?: boolean | null; /** * A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. */ @@ -175,32 +175,32 @@ export namespace monitoring_v3 { /** * Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. */ - name?: string; + name?: string | null; /** * Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The syntax of the entries in this field is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] */ - notificationChannels?: string[]; + notificationChannels?: string[] | null; /** * User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. */ - userLabels?: {[key: string]: string}; + userLabels?: {[key: string]: string} | null; /** * Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents. */ validity?: Schema$Status; } /** - * A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring. + * The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication (https://tools.ietf.org/html/rfc7617) is supported in Uptime checks. */ export interface Schema$BasicAuthentication { /** - * The password to authenticate. + * The password to use when authenticating with the HTTP server. */ - password?: string; + password?: string | null; /** - * The username to authenticate. + * The username to use when authenticating with the HTTP server. */ - username?: string; + username?: string | null; } /** * BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. @@ -226,31 +226,31 @@ export namespace monitoring_v3 { /** * The end time of the interval. */ - endTime?: string; + endTime?: string | null; /** * The measurement metadata. Example: "process_id" -> 12345 */ - metadata?: {[key: string]: Schema$TypedValue}; + metadata?: {[key: string]: Schema$TypedValue} | null; /** * The name of the plugin. Example: "disk". */ - plugin?: string; + plugin?: string | null; /** * The instance name of the plugin Example: "hdcl". */ - pluginInstance?: string; + pluginInstance?: string | null; /** * The start time of the interval. */ - startTime?: string; + startTime?: string | null; /** * The measurement type. Example: "memory". */ - type?: string; + type?: string | null; /** * The measurement type instance. Example: "used". */ - typeInstance?: string; + typeInstance?: string | null; /** * The measured values during this time interval. Each value must have a different dataSourceName. */ @@ -267,7 +267,7 @@ export namespace monitoring_v3 { /** * The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads. */ - index?: number; + index?: number | null; /** * Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors. */ @@ -280,11 +280,11 @@ export namespace monitoring_v3 { /** * The data source for the collectd value. For example there are two data sources for network measurements: "rx" and "tx". */ - dataSourceName?: string; + dataSourceName?: string | null; /** * The type of measurement. */ - dataSourceType?: string; + dataSourceType?: string | null; /** * The measurement value. */ @@ -301,7 +301,7 @@ export namespace monitoring_v3 { /** * The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads. */ - index?: number; + index?: number | null; } /** * A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong. @@ -318,11 +318,11 @@ export namespace monitoring_v3 { /** * A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy. */ - displayName?: string; + displayName?: string | null; /** * Required if the condition exists. The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Stackdriver Monitoring creates the condition identifiers and includes them in the new policy.When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted. */ - name?: string; + name?: string | null; } /** * Used to perform string matching. It allows substring and regular expressions, together with their negations. @@ -331,11 +331,11 @@ export namespace monitoring_v3 { /** * String or regex content to match (max 1024 bytes) */ - content?: string; + content?: string | null; /** - * The matcher representing content match options which the check will run with. If the field is not specified (in previous versions), the option is set to be CONTAINS_STRING which performs content substring matching. + * The type of content matcher that will be applied to the server output, compared to the content string when the check is run. */ - matcher?: string; + matcher?: string | null; } /** * The CreateCollectdTimeSeries request. @@ -348,7 +348,7 @@ export namespace monitoring_v3 { /** * The version of collectd that collected the data. Example: "5.3.0-192.el6". */ - collectdVersion?: string; + collectdVersion?: string | null; /** * The monitored resource associated with the time series. */ @@ -379,7 +379,7 @@ export namespace monitoring_v3 { /** * Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero. */ - bucketCounts?: string[]; + bucketCounts?: string[] | null; /** * Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries. */ @@ -387,7 +387,7 @@ export namespace monitoring_v3 { /** * The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided. */ - count?: string; + count?: string | null; /** * Must be in increasing order of value field. */ @@ -395,7 +395,7 @@ export namespace monitoring_v3 { /** * The arithmetic mean of the values in the population. If count is zero then this field must be zero. */ - mean?: number; + mean?: number | null; /** * If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3. */ @@ -403,7 +403,7 @@ export namespace monitoring_v3 { /** * The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero. */ - sumOfSquaredDeviation?: number; + sumOfSquaredDeviation?: number | null; } /** * A content string and a MIME type that describes the content string's format. @@ -412,11 +412,11 @@ export namespace monitoring_v3 { /** * The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. */ - content?: string; + content?: string | null; /** * The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. */ - mimeType?: string; + mimeType?: string | null; } /** * 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. @@ -425,7 +425,7 @@ export namespace monitoring_v3 { /** * Map from label to its value, for all labels dropped in any aggregation. */ - label?: {[key: string]: string}; + 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 {}. @@ -438,15 +438,15 @@ export namespace monitoring_v3 { /** * Contextual information about the example value. Examples are:Trace: type.googleapis.com/google.monitoring.v3.SpanContextLiteral string: type.googleapis.com/google.protobuf.StringValueLabels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. */ - attachments?: Array<{[key: string]: any}>; + attachments?: Array<{[key: string]: any}> | null; /** * The observation (sampling) time of the above value. */ - timestamp?: string; + timestamp?: string | null; /** * Value of the exemplar point. This value determines to which bucket the exemplar belongs. */ - value?: number; + value?: number | null; } /** * Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. @@ -455,7 +455,7 @@ export namespace monitoring_v3 { /** * The values must be monotonically increasing. */ - bounds?: number[]; + bounds?: number[] | null; } /** * Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). @@ -464,15 +464,15 @@ export namespace monitoring_v3 { /** * Must be greater than 1. */ - growthFactor?: number; + growthFactor?: number | null; /** * Must be greater than 0. */ - numFiniteBuckets?: number; + numFiniteBuckets?: number | null; /** * Must be greater than 0. */ - scale?: number; + scale?: number | null; } /** * A single field of a message type. @@ -481,31 +481,31 @@ export namespace monitoring_v3 { /** * The field cardinality. */ - cardinality?: string; + cardinality?: string | null; /** * The string value of the default value of this field. Proto2 syntax only. */ - defaultValue?: string; + defaultValue?: string | null; /** * The field JSON name. */ - jsonName?: string; + jsonName?: string | null; /** * The field type. */ - kind?: string; + kind?: string | null; /** * The field name. */ - name?: string; + name?: string | null; /** * The field number. */ - number?: number; + number?: number | null; /** * The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ - oneofIndex?: number; + oneofIndex?: number | null; /** * The protocol buffer options. */ @@ -513,11 +513,11 @@ export namespace monitoring_v3 { /** * Whether to use alternative packed wire representation. */ - packed?: boolean; + packed?: boolean | null; /** * The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp". */ - typeUrl?: string; + typeUrl?: string | null; } /** * The GetNotificationChannelVerificationCode request. @@ -526,7 +526,7 @@ export namespace monitoring_v3 { /** * The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted). */ - expireTime?: string; + expireTime?: string | null; } /** * The GetNotificationChannelVerificationCode request. @@ -535,11 +535,11 @@ export namespace monitoring_v3 { /** * The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number). */ - code?: string; + code?: string | null; /** * The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration. */ - expireTime?: string; + expireTime?: string | null; } /** * The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors. @@ -548,26 +548,26 @@ export namespace monitoring_v3 { /** * A user-assigned name for this group, used only for display purposes. */ - displayName?: string; + displayName?: string | null; /** * The filter used to determine which monitored resources belong to this group. */ - filter?: string; + filter?: string | null; /** * If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. */ - isCluster?: boolean; + isCluster?: boolean | null; /** * Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. */ - name?: string; + name?: string | null; /** * The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "". */ - parentName?: string; + parentName?: string | null; } /** - * Information involved in an HTTP/HTTPS uptime check request. + * Information involved in an HTTP/HTTPS Uptime check request. */ export interface Schema$HttpCheck { /** @@ -575,58 +575,58 @@ export namespace monitoring_v3 { */ authInfo?: Schema$BasicAuthentication; /** - * The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. + * The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** - * Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******. + * Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******. */ - maskHeaders?: boolean; + maskHeaders?: boolean | null; /** - * The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/"). If the provided path does not begin with "/", it will be prepended automatically. + * Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically. */ - path?: string; + path?: string | null; /** - * The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). + * Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL. */ - port?: number; + port?: number | null; /** * If true, use HTTPS instead of HTTP to run the check. */ - useSsl?: boolean; + useSsl?: boolean | null; /** - * Boolean specifying whether to validate SSL certificates. Only applies to uptime_url checks. If use_ssl is false, setting this to true has no effect. + * Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitored_resource is set to uptime_url. If use_ssl is false, setting validate_ssl to true has no effect. */ - validateSsl?: boolean; + validateSsl?: boolean | null; } /** - * An internal checker allows uptime checks to run on private/internal GCP resources. + * An internal checker allows Uptime checks to run on private/internal GCP resources. */ export interface Schema$InternalChecker { /** * The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. */ - displayName?: string; + displayName?: string | null; /** - * The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified. + * The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified. */ - gcpZone?: string; + gcpZone?: string | null; /** - * A unique resource name for this InternalChecker. The format is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].PROJECT_ID is the stackdriver workspace project for the uptime check config associated with the internal checker. + * A unique resource name for this InternalChecker. The format is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].[PROJECT_ID] is the Stackdriver Workspace project for the Uptime check config associated with the internal checker. */ - name?: string; + name?: string | null; /** * The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default"). */ - network?: string; + network?: string | null; /** - * The GCP project_id where the internal checker lives. Not necessary the same as the workspace project. + * The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project. */ - peerProjectId?: string; + peerProjectId?: string | null; /** * The current operational state of the internal checker. */ - state?: string; + state?: string | null; } /** * A description of a label. @@ -635,15 +635,15 @@ export namespace monitoring_v3 { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). @@ -652,15 +652,15 @@ export namespace monitoring_v3 { /** * Must be greater than 0. */ - numFiniteBuckets?: number; + numFiniteBuckets?: number | null; /** * Lower bound of the first bucket. */ - offset?: number; + offset?: number | null; /** * Must be greater than 0. */ - width?: number; + width?: number | null; } /** * The protocol for the ListAlertPolicies response. @@ -673,7 +673,7 @@ export namespace monitoring_v3 { /** * If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The ListGroupMembers response. @@ -686,11 +686,11 @@ export namespace monitoring_v3 { /** * 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; + nextPageToken?: string | null; /** * The total number of elements matching this request. */ - totalSize?: number; + totalSize?: number | null; } /** * The ListGroups response. @@ -703,7 +703,7 @@ export namespace monitoring_v3 { /** * 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; + nextPageToken?: string | null; } /** * The ListMetricDescriptors response. @@ -716,7 +716,7 @@ export namespace monitoring_v3 { /** * 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; + nextPageToken?: string | null; } /** * The ListMonitoredResourceDescriptors response. @@ -725,7 +725,7 @@ export namespace monitoring_v3 { /** * 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; + nextPageToken?: string | null; /** * The monitored resource descriptors that are available to this project and that match filter, if present. */ @@ -742,7 +742,7 @@ export namespace monitoring_v3 { /** * If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The ListNotificationChannels response. @@ -751,7 +751,7 @@ export namespace monitoring_v3 { /** * If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The notification channels defined for the specified project. */ @@ -768,7 +768,7 @@ export namespace monitoring_v3 { /** * 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; + nextPageToken?: string | null; /** * One or more time series that match the filter included in the request. */ @@ -781,13 +781,13 @@ export namespace monitoring_v3 { /** * This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). */ - nextPageToken?: string; + nextPageToken?: string | null; /** - * The total number of uptime check configurations for the project, irrespective of any pagination. + * The total number of Uptime check configurations for the project, irrespective of any pagination. */ - totalSize?: number; + totalSize?: number | null; /** - * The returned uptime check configurations. + * The returned Uptime check configurations. */ uptimeCheckConfigs?: Schema$UptimeCheckConfig[]; } @@ -798,7 +798,7 @@ export namespace monitoring_v3 { /** * This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The returned list of IP addresses (including region and location) that the checkers run from. */ @@ -811,11 +811,11 @@ export namespace monitoring_v3 { /** * The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount. */ - type?: string; + type?: string | null; } /** * A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified duration. @@ -828,11 +828,11 @@ export namespace monitoring_v3 { /** * The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. The Duration.nanos field is ignored. */ - duration?: string; + duration?: string | null; /** * A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ - filter?: string; + filter?: string | null; /** * The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. */ @@ -845,11 +845,11 @@ export namespace monitoring_v3 { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. */ @@ -857,7 +857,7 @@ export namespace monitoring_v3 { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -865,23 +865,23 @@ export namespace monitoring_v3 { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -890,15 +890,15 @@ export namespace monitoring_v3 { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * A condition type that compares a collection of time series against a threshold. @@ -911,7 +911,7 @@ export namespace monitoring_v3 { /** * The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side.Only COMPARISON_LT and COMPARISON_GT are supported currently. */ - comparison?: string; + comparison?: string | null; /** * Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. */ @@ -919,19 +919,19 @@ export namespace monitoring_v3 { /** * A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ - denominatorFilter?: string; + denominatorFilter?: string | null; /** * The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly. */ - duration?: string; + duration?: string | null; /** * A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ - filter?: string; + filter?: string | null; /** * A value against which to compare the time series. */ - thresholdValue?: number; + thresholdValue?: number | null; /** * The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. */ @@ -944,11 +944,11 @@ export namespace monitoring_v3 { /** * Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone". */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types. */ - type?: string; + type?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API. @@ -957,11 +957,11 @@ export namespace monitoring_v3 { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone". */ @@ -969,15 +969,15 @@ export namespace monitoring_v3 { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. @@ -986,11 +986,11 @@ export namespace monitoring_v3 { /** * Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } */ - systemLabels?: {[key: string]: any}; + systemLabels?: {[key: string]: any} | null; /** * Output only. A map of user-defined metadata labels. */ - userLabels?: {[key: string]: string}; + userLabels?: {[key: string]: string} | null; } /** * Describes a change made to a configuration. @@ -999,11 +999,11 @@ export namespace monitoring_v3 { /** * The email address of the user making the change. */ - mutatedBy?: string; + mutatedBy?: string | null; /** * When the change occurred. */ - mutateTime?: string; + mutateTime?: string | null; } /** * A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval. @@ -1012,35 +1012,35 @@ export namespace monitoring_v3 { /** * An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters. */ - description?: string; + description?: string | null; /** * An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters. */ - displayName?: string; + displayName?: string | null; /** * Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future. */ - enabled?: boolean; + enabled?: boolean | null; /** * Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ - name?: string; + name?: string | null; /** * The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. */ - type?: string; + type?: string | null; /** * User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. */ - userLabels?: {[key: string]: string}; + userLabels?: {[key: string]: string} | null; /** * Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel. */ - verificationStatus?: string; + verificationStatus?: string | null; } /** * A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type. @@ -1049,11 +1049,11 @@ export namespace monitoring_v3 { /** * A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation. */ - description?: string; + description?: string | null; /** * A human-readable name for the notification channel type. This form of the name is suitable for a user interface. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated. */ @@ -1061,15 +1061,15 @@ 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; + name?: string | null; /** * The tiers that support this notification channel; the project service tier must be one of the supported_tiers. */ - supportedTiers?: string[]; + supportedTiers?: string[] | null; /** * The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique. */ - type?: string; + type?: string | null; } /** * A protocol buffer option, which can be attached to a message, field, enumeration, etc. @@ -1078,11 +1078,11 @@ export namespace monitoring_v3 { /** * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http". */ - name?: string; + name?: string | null; /** * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ - value?: {[key: string]: any}; + value?: {[key: string]: any} | null; } /** * A single data point in a time series. @@ -1104,24 +1104,24 @@ export namespace monitoring_v3 { /** * The maximum of the population values. */ - max?: number; + max?: number | null; /** * The minimum of the population values. */ - min?: number; + min?: number | null; } /** * The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. */ export interface Schema$ResourceGroup { /** - * The group of resources being monitored. Should be only the group_id, not projects/<project_id>/groups/<group_id>. + * The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID]/groups/[GROUP_ID]. */ - groupId?: string; + groupId?: string | null; /** * The resource type of the group members. */ - resourceType?: string; + resourceType?: string | null; } /** * The SendNotificationChannelVerificationCode request. @@ -1134,7 +1134,7 @@ export namespace monitoring_v3 { /** * The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". */ - fileName?: string; + fileName?: string | null; } /** * The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.It contains the name of a span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID @@ -1143,7 +1143,7 @@ export namespace monitoring_v3 { /** * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] TRACE_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.SPAN_ID is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ - spanName?: string; + 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). @@ -1152,24 +1152,24 @@ export namespace monitoring_v3 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** - * Information required for a TCP uptime check request. + * Information required for a TCP Uptime check request. */ export interface Schema$TcpCheck { /** - * The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. Required. + * The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required. */ - port?: number; + port?: number | null; } /** * A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time. For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. For DELTA and CUMULATIVE metrics, the start time must be earlier than the end time. In all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time. @@ -1178,11 +1178,11 @@ export namespace monitoring_v3 { /** * Required. The end of the time interval. */ - endTime?: string; + endTime?: string | null; /** * Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */ - startTime?: string; + startTime?: string | null; } /** * A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. @@ -1199,7 +1199,7 @@ export namespace monitoring_v3 { /** * The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. */ - metricKind?: string; + metricKind?: string | null; /** * The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. */ @@ -1211,7 +1211,7 @@ export namespace monitoring_v3 { /** * The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. */ - valueType?: string; + valueType?: string | null; } /** * Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a {count: 1} trigger is used. @@ -1220,11 +1220,11 @@ export namespace monitoring_v3 { /** * The absolute number of time series that must fail the predicate for the condition to be triggered. */ - count?: number; + count?: number | null; /** * The percentage of time series that must fail the predicate for the condition to be triggered. */ - percent?: number; + percent?: number | null; } /** * A protocol buffer message type. @@ -1237,11 +1237,11 @@ export namespace monitoring_v3 { /** * The fully qualified message name. */ - name?: string; + name?: string | null; /** * The list of types appearing in oneof definitions in this type. */ - oneofs?: string[]; + oneofs?: string[] | null; /** * The protocol buffer options. */ @@ -1253,7 +1253,7 @@ export namespace monitoring_v3 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * A single strongly-typed value. @@ -1262,7 +1262,7 @@ export namespace monitoring_v3 { /** * A Boolean value: true or false. */ - boolValue?: boolean; + boolValue?: boolean | null; /** * A distribution value. */ @@ -1270,56 +1270,56 @@ export namespace monitoring_v3 { /** * A 64-bit double-precision floating-point number. Its magnitude is approximately &plusmn;10<sup>&plusmn;300</sup> and it has 16 significant digits of precision. */ - doubleValue?: number; + doubleValue?: number | null; /** * A 64-bit integer. Its range is approximately &plusmn;9.2x10<sup>18</sup>. */ - int64Value?: string; + int64Value?: string | null; /** * A variable-length string value. */ - stringValue?: string; + stringValue?: string | null; } /** * This message configures which resources and services to monitor for availability. */ export interface Schema$UptimeCheckConfig { /** - * The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. + * The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check. */ contentMatchers?: Schema$ContentMatcher[]; /** - * A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. + * A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. */ - displayName?: string; + displayName?: string | null; /** * Contains information needed to make an HTTP or HTTPS check. */ httpCheck?: Schema$HttpCheck; /** - * The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this CheckConfig. + * The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig. */ internalCheckers?: Schema$InternalChecker[]; /** - * The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer + * The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for Uptime checks: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer */ monitoredResource?: Schema$MonitoredResource; /** - * A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * A unique resource name for this Uptime check configuration. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. */ - name?: string; + name?: string | null; /** - * How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s. + * How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s. */ - period?: string; + period?: string | null; /** * The group resource associated with the configuration. */ resourceGroup?: Schema$ResourceGroup; /** - * The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. + * The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions. */ - selectedRegions?: string[]; + selectedRegions?: string[] | null; /** * Contains information needed to make a TCP check. */ @@ -1327,24 +1327,24 @@ export namespace monitoring_v3 { /** * The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. */ - timeout?: string; + timeout?: string | null; } /** * Contains the region, location, and list of IP addresses where checkers in the location run from. */ export interface Schema$UptimeCheckIp { /** - * The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format. + * The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format. */ - ipAddress?: string; + ipAddress?: string | null; /** * A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category. */ - location?: string; + location?: string | null; /** * A broad region category in which the IP address is located. */ - region?: string; + region?: string | null; } /** * The VerifyNotificationChannel request. @@ -1353,7 +1353,7 @@ export namespace monitoring_v3 { /** * The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code). */ - code?: string; + code?: string | null; } export class Resource$Projects { @@ -5029,12 +5029,12 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.create - * @desc Creates a new uptime check configuration. + * @desc Creates a new Uptime check configuration. * @alias monitoring.projects.uptimeCheckConfigs.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project in which to create the uptime check. The format is projects/[PROJECT_ID]. + * @param {string} params.parent The project in which to create the Uptime check. The format is projects/[PROJECT_ID]. * @param {().UptimeCheckConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5104,12 +5104,12 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.delete - * @desc Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion. + * @desc Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion. * @alias monitoring.projects.uptimeCheckConfigs.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * @param {string} params.name The Uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5173,12 +5173,12 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.get - * @desc Gets a single uptime check configuration. + * @desc Gets a single Uptime check configuration. * @alias monitoring.projects.uptimeCheckConfigs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * @param {string} params.name The Uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5244,14 +5244,14 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.list - * @desc Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations. + * @desc Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). * @alias monitoring.projects.uptimeCheckConfigs.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - * @param {string} params.parent The project whose uptime check configurations are listed. The format is projects/[PROJECT_ID]. + * @param {string} params.parent The project whose Uptime check configurations are listed. The format is projects/[PROJECT_ID]. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5329,13 +5329,13 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.patch - * @desc Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via "updateMask". Returns the updated configuration. + * @desc Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration. * @alias monitoring.projects.uptimeCheckConfigs.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. - * @param {string=} params.updateMask Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. + * @param {string} params.name A unique resource name for this Uptime check configuration. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * @param {string=} params.updateMask Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. * @param {().UptimeCheckConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5409,7 +5409,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the uptime check. The format is projects/[PROJECT_ID]. + * The project in which to create the Uptime check. The format is projects/[PROJECT_ID]. */ parent?: string; @@ -5426,7 +5426,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * The Uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. */ name?: string; } @@ -5438,7 +5438,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * The Uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. */ name?: string; } @@ -5458,7 +5458,7 @@ export namespace monitoring_v3 { */ pageToken?: string; /** - * The project whose uptime check configurations are listed. The format is projects/[PROJECT_ID]. + * The project whose Uptime check configurations are listed. The format is projects/[PROJECT_ID]. */ parent?: string; } @@ -5470,11 +5470,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * A unique resource name for this Uptime check configuration. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. */ name?: string; /** - * Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. + * Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. */ updateMask?: string; @@ -5492,7 +5492,7 @@ export namespace monitoring_v3 { /** * monitoring.uptimeCheckIps.list - * @desc Returns the list of IPs that checkers run from + * @desc Returns the list of IP addresses that checkers run from * @alias monitoring.uptimeCheckIps.list * @memberOf! () * diff --git a/src/apis/oauth2/v1.ts b/src/apis/oauth2/v1.ts index 0c61964dea5..6da28b5354b 100644 --- a/src/apis/oauth2/v1.ts +++ b/src/apis/oauth2/v1.ts @@ -179,97 +179,97 @@ export namespace oauth2_v1 { /** * The access type granted with this token. It can be offline or online. */ - access_type?: string; + access_type?: string | null; /** * Who is the intended audience for this token. In general the same as issued_to. */ - audience?: string; + audience?: string | null; /** * The email address of the user. Present only if the email scope is present in the request. */ - email?: string; + email?: string | null; /** * Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request. */ - email_verified?: boolean; + email_verified?: boolean | null; /** * The expiry time of the token, as number of seconds left until expiry. */ - expires_in?: number; + expires_in?: number | null; /** * The issue time of the token, as number of seconds. */ - issued_at?: number; + issued_at?: number | null; /** * To whom was the token issued to. In general the same as audience. */ - issued_to?: string; + issued_to?: string | null; /** * Who issued the token. */ - issuer?: string; + issuer?: string | null; /** * Nonce of the id token. */ - nonce?: string; + nonce?: string | null; /** * The space separated list of scopes granted to this token. */ - scope?: string; + scope?: string | null; /** * The obfuscated user id. */ - user_id?: string; + user_id?: string | null; /** * Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request. */ - verified_email?: boolean; + verified_email?: boolean | null; } export interface Schema$Userinfoplus { /** * The user's email address. */ - email?: string; + email?: string | null; /** * The user's last name. */ - family_name?: string; + family_name?: string | null; /** * The user's gender. */ - gender?: string; + gender?: string | null; /** * The user's first name. */ - given_name?: string; + given_name?: string | null; /** * The hosted domain e.g. example.com if the user is Google apps user. */ - hd?: string; + hd?: string | null; /** * The obfuscated ID of the user. */ - id?: string; + id?: string | null; /** * URL of the profile page. */ - link?: string; + link?: string | null; /** * The user's preferred locale. */ - locale?: string; + locale?: string | null; /** * The user's full name. */ - name?: string; + name?: string | null; /** * URL of the user's picture image. */ - picture?: string; + picture?: string | null; /** * Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address. */ - verified_email?: boolean; + verified_email?: boolean | null; } export interface Params$$Tokeninfo extends StandardParameters { diff --git a/src/apis/oauth2/v2.ts b/src/apis/oauth2/v2.ts index 21e005aa671..04d83dc75b7 100644 --- a/src/apis/oauth2/v2.ts +++ b/src/apis/oauth2/v2.ts @@ -249,91 +249,91 @@ export namespace oauth2_v2 { kty?: string; n?: string; use?: string; - }>; + }> | null; } export interface Schema$Tokeninfo { /** * The access type granted with this token. It can be offline or online. */ - access_type?: string; + access_type?: string | null; /** * Who is the intended audience for this token. In general the same as issued_to. */ - audience?: string; + audience?: string | null; /** * The email address of the user. Present only if the email scope is present in the request. */ - email?: string; + email?: string | null; /** * The expiry time of the token, as number of seconds left until expiry. */ - expires_in?: number; + expires_in?: number | null; /** * To whom was the token issued to. In general the same as audience. */ - issued_to?: string; + issued_to?: string | null; /** * The space separated list of scopes granted to this token. */ - scope?: string; + scope?: string | null; /** * The token handle associated with this token. */ - token_handle?: string; + token_handle?: string | null; /** * The obfuscated user id. */ - user_id?: string; + user_id?: string | null; /** * Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request. */ - verified_email?: boolean; + verified_email?: boolean | null; } export interface Schema$Userinfoplus { /** * The user's email address. */ - email?: string; + email?: string | null; /** * The user's last name. */ - family_name?: string; + family_name?: string | null; /** * The user's gender. */ - gender?: string; + gender?: string | null; /** * The user's first name. */ - given_name?: string; + given_name?: string | null; /** * The hosted domain e.g. example.com if the user is Google apps user. */ - hd?: string; + hd?: string | null; /** * The obfuscated ID of the user. */ - id?: string; + id?: string | null; /** * URL of the profile page. */ - link?: string; + link?: string | null; /** * The user's preferred locale. */ - locale?: string; + locale?: string | null; /** * The user's full name. */ - name?: string; + name?: string | null; /** * URL of the user's picture image. */ - picture?: string; + picture?: string | null; /** * Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address. */ - verified_email?: boolean; + verified_email?: boolean | null; } export interface Params$$Getcertforopenidconnect extends StandardParameters { diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index e74f171bec1..8dc39e86650 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -137,7 +137,7 @@ export namespace oslogin_v1 { /** * A unique user ID. */ - name?: string; + name?: string | null; /** * The list of POSIX accounts associated with the user. */ @@ -145,7 +145,7 @@ export namespace oslogin_v1 { /** * A map from SSH public key fingerprint to the associated key object. */ - sshPublicKeys?: {[key: string]: Schema$SshPublicKey}; + sshPublicKeys?: {[key: string]: Schema$SshPublicKey} | null; } /** * The POSIX account information associated with a Google account. @@ -154,43 +154,43 @@ export namespace oslogin_v1 { /** * Output only. A POSIX account identifier. */ - accountId?: string; + accountId?: string | null; /** * The GECOS (user information) entry for this account. */ - gecos?: string; + gecos?: string | null; /** * The default group ID. */ - gid?: string; + gid?: string | null; /** * The path to the home directory for this account. */ - homeDirectory?: string; + homeDirectory?: string | null; /** * The operating system type where this account applies. */ - operatingSystemType?: string; + operatingSystemType?: string | null; /** * Only one POSIX account can be marked as primary. */ - primary?: boolean; + primary?: boolean | null; /** * The path to the logic shell for this account. */ - shell?: string; + shell?: string | null; /** * System identifier for which account the username or uid applies to. By default, the empty value is used. */ - systemId?: string; + systemId?: string | null; /** * The user ID. */ - uid?: string; + uid?: string | null; /** * The username of the POSIX account. */ - username?: string; + username?: string | null; } /** * The SSH public key information associated with a Google account. @@ -199,15 +199,15 @@ export namespace oslogin_v1 { /** * An expiration time in microseconds since epoch. */ - expirationTimeUsec?: string; + expirationTimeUsec?: string | null; /** * Output only. The SHA-256 fingerprint of the SSH public key. */ - fingerprint?: string; + fingerprint?: string | null; /** * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ - key?: string; + key?: string | null; } export class Resource$Users { diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index 4d06655b521..a1145e3669c 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -137,7 +137,7 @@ export namespace oslogin_v1alpha { /** * A unique user ID. */ - name?: string; + name?: string | null; /** * The list of POSIX accounts associated with the user. */ @@ -145,7 +145,7 @@ export namespace oslogin_v1alpha { /** * A map from SSH public key fingerprint to the associated key object. */ - sshPublicKeys?: {[key: string]: Schema$SshPublicKey}; + sshPublicKeys?: {[key: string]: Schema$SshPublicKey} | null; } /** * The POSIX account information associated with a Google account. @@ -154,43 +154,43 @@ export namespace oslogin_v1alpha { /** * Output only. A POSIX account identifier. */ - accountId?: string; + accountId?: string | null; /** * The GECOS (user information) entry for this account. */ - gecos?: string; + gecos?: string | null; /** * The default group ID. */ - gid?: string; + gid?: string | null; /** * The path to the home directory for this account. */ - homeDirectory?: string; + homeDirectory?: string | null; /** * The operating system type where this account applies. */ - operatingSystemType?: string; + operatingSystemType?: string | null; /** * Only one POSIX account can be marked as primary. */ - primary?: boolean; + primary?: boolean | null; /** * The path to the logic shell for this account. */ - shell?: string; + shell?: string | null; /** * System identifier for which account the username or uid applies to. By default, the empty value is used. */ - systemId?: string; + systemId?: string | null; /** * The user ID. */ - uid?: string; + uid?: string | null; /** * The username of the POSIX account. */ - username?: string; + username?: string | null; } /** * The SSH public key information associated with a Google account. @@ -199,15 +199,15 @@ export namespace oslogin_v1alpha { /** * An expiration time in microseconds since epoch. */ - expirationTimeUsec?: string; + expirationTimeUsec?: string | null; /** * Output only. The SHA-256 fingerprint of the SSH public key. */ - fingerprint?: string; + fingerprint?: string | null; /** * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ - key?: string; + key?: string | null; } export class Resource$Users { diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 28cd84ef2c7..d587755091f 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -137,7 +137,7 @@ export namespace oslogin_v1beta { /** * A unique user ID. */ - name?: string; + name?: string | null; /** * The list of POSIX accounts associated with the user. */ @@ -145,7 +145,7 @@ export namespace oslogin_v1beta { /** * A map from SSH public key fingerprint to the associated key object. */ - sshPublicKeys?: {[key: string]: Schema$SshPublicKey}; + sshPublicKeys?: {[key: string]: Schema$SshPublicKey} | null; } /** * The POSIX account information associated with a Google account. @@ -154,43 +154,43 @@ export namespace oslogin_v1beta { /** * Output only. A POSIX account identifier. */ - accountId?: string; + accountId?: string | null; /** * The GECOS (user information) entry for this account. */ - gecos?: string; + gecos?: string | null; /** * The default group ID. */ - gid?: string; + gid?: string | null; /** * The path to the home directory for this account. */ - homeDirectory?: string; + homeDirectory?: string | null; /** * The operating system type where this account applies. */ - operatingSystemType?: string; + operatingSystemType?: string | null; /** * Only one POSIX account can be marked as primary. */ - primary?: boolean; + primary?: boolean | null; /** * The path to the logic shell for this account. */ - shell?: string; + shell?: string | null; /** * System identifier for which account the username or uid applies to. By default, the empty value is used. */ - systemId?: string; + systemId?: string | null; /** * The user ID. */ - uid?: string; + uid?: string | null; /** * The username of the POSIX account. */ - username?: string; + username?: string | null; } /** * The SSH public key information associated with a Google account. @@ -199,15 +199,15 @@ export namespace oslogin_v1beta { /** * An expiration time in microseconds since epoch. */ - expirationTimeUsec?: string; + expirationTimeUsec?: string | null; /** * Output only. The SHA-256 fingerprint of the SSH public key. */ - fingerprint?: string; + fingerprint?: string | null; /** * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ - key?: string; + key?: string | null; } export class Resource$Users { diff --git a/src/apis/pagespeedonline/v1.ts b/src/apis/pagespeedonline/v1.ts index 090cf2fb4b3..3b2a082bb65 100644 --- a/src/apis/pagespeedonline/v1.ts +++ b/src/apis/pagespeedonline/v1.ts @@ -105,7 +105,7 @@ export namespace pagespeedonline_v1 { /** * The captcha verify result */ - captchaResult?: string; + captchaResult?: string | null; /** * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. */ @@ -133,19 +133,19 @@ export namespace pagespeedonline_v1 { }>; }; }; - }; + } | null; /** * Canonicalized and final URL for the document, after following page redirects (if any). */ - id?: string; + id?: string | null; /** * List of rules that were specified in the request, but which the server did not know how to instantiate. */ - invalidRules?: string[]; + invalidRules?: string[] | null; /** * Kind of result. */ - kind?: string; + kind?: string | null; /** * Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. */ @@ -163,15 +163,15 @@ export namespace pagespeedonline_v1 { otherResponseBytes?: string; textResponseBytes?: string; totalRequestBytes?: string; - }; + } | null; /** * Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. */ - responseCode?: number; + responseCode?: number | null; /** * The PageSpeed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement. */ - score?: number; + score?: number | null; /** * Base64-encoded screenshot of the page that was analyzed. */ @@ -180,15 +180,15 @@ export namespace pagespeedonline_v1 { height?: number; mime_type?: string; width?: number; - }; + } | null; /** * Title of the page, as displayed in the browser's title bar. */ - title?: string; + title?: string | null; /** * The version of PageSpeed used to generate these results. */ - version?: {major?: number; minor?: number}; + version?: {major?: number; minor?: number} | null; } export class Resource$Pagespeedapi { diff --git a/src/apis/pagespeedonline/v2.ts b/src/apis/pagespeedonline/v2.ts index 27d44589517..a46d18e991c 100644 --- a/src/apis/pagespeedonline/v2.ts +++ b/src/apis/pagespeedonline/v2.ts @@ -121,43 +121,48 @@ export namespace pagespeedonline_v2 { }>; type?: string; value?: string; - }>; + }> | null; /** * A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'. */ - format?: string; + format?: string | null; } export interface Schema$PagespeedApiImageV2 { /** * Image data base64 encoded. */ - data?: string; + data?: string | null; /** * Height of screenshot in pixels. */ - height?: number; + height?: number | null; /** * Unique string key, if any, identifying this image. */ - key?: string; + key?: string | null; /** * Mime type of image data (e.g. "image/jpeg"). */ - mime_type?: string; + mime_type?: string | null; /** * The region of the page that is captured by this image, with dimensions measured in CSS pixels. */ - page_rect?: {height?: number; left?: number; top?: number; width?: number}; + page_rect?: { + height?: number; + left?: number; + top?: number; + width?: number; + } | null; /** * Width of screenshot in pixels. */ - width?: number; + width?: number | null; } export interface Schema$Result { /** * The captcha verify result */ - captchaResult?: string; + captchaResult?: string | null; /** * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. */ @@ -178,19 +183,19 @@ export namespace pagespeedonline_v2 { }>; }; }; - }; + } | null; /** * Canonicalized and final URL for the document, after following page redirects (if any). */ - id?: string; + id?: string | null; /** * List of rules that were specified in the request, but which the server did not know how to instantiate. */ - invalidRules?: string[]; + invalidRules?: string[] | null; /** * Kind of result. */ - kind?: string; + kind?: string | null; /** * Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. */ @@ -208,15 +213,15 @@ export namespace pagespeedonline_v2 { otherResponseBytes?: string; textResponseBytes?: string; totalRequestBytes?: string; - }; + } | null; /** * Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. */ - responseCode?: number; + responseCode?: number | null; /** * A map with one entry for each rule group in these results. */ - ruleGroups?: {[key: string]: {score?: number}}; + ruleGroups?: {[key: string]: {score?: number}} | null; /** * Base64-encoded screenshot of the page that was analyzed. */ @@ -224,11 +229,11 @@ export namespace pagespeedonline_v2 { /** * Title of the page, as displayed in the browser's title bar. */ - title?: string; + title?: string | null; /** * The version of PageSpeed used to generate these results. */ - version?: {major?: number; minor?: number}; + version?: {major?: number; minor?: number} | null; } export class Resource$Pagespeedapi { diff --git a/src/apis/pagespeedonline/v4.ts b/src/apis/pagespeedonline/v4.ts index c0df45dc8ac..571b6908201 100644 --- a/src/apis/pagespeedonline/v4.ts +++ b/src/apis/pagespeedonline/v4.ts @@ -121,40 +121,45 @@ export namespace pagespeedonline_v4 { }>; type?: string; value?: string; - }>; + }> | null; /** * A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'. */ - format?: string; + format?: string | null; } export interface Schema$PagespeedApiImageV4 { /** * Image data base64 encoded. */ - data?: string; + data?: string | null; /** * Height of screenshot in pixels. */ - height?: number; + height?: number | null; /** * Unique string key, if any, identifying this image. */ - key?: string; + key?: string | null; /** * Mime type of image data (e.g. "image/jpeg"). */ - mime_type?: string; - page_rect?: {height?: number; left?: number; top?: number; width?: number}; + mime_type?: string | null; + page_rect?: { + height?: number; + left?: number; + top?: number; + width?: number; + } | null; /** * Width of screenshot in pixels. */ - width?: number; + width?: number | null; } export interface Schema$PagespeedApiPagespeedResponseV4 { /** * The captcha verify result */ - captchaResult?: string; + captchaResult?: string | null; /** * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. */ @@ -176,19 +181,19 @@ export namespace pagespeedonline_v4 { }>; }; }; - }; + } | null; /** * Canonicalized and final URL for the document, after following page redirects (if any). */ - id?: string; + id?: string | null; /** * List of rules that were specified in the request, but which the server did not know how to instantiate. */ - invalidRules?: string[]; + invalidRules?: string[] | null; /** * Kind of result. */ - kind?: string; + kind?: string | null; /** * Metrics of end users' page loading experience. */ @@ -207,7 +212,7 @@ export namespace pagespeedonline_v4 { }; }; overall_category?: string; - }; + } | null; /** * Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. */ @@ -233,15 +238,15 @@ export namespace pagespeedonline_v4 { textResponseBytes?: string; totalRequestBytes?: string; transientFetchFailureUrls?: string[]; - }; + } | null; /** * Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. */ - responseCode?: number; + responseCode?: number | null; /** * A map with one entry for each rule group in these results. */ - ruleGroups?: {[key: string]: {pass?: boolean; score?: number}}; + ruleGroups?: {[key: string]: {pass?: boolean; score?: number}} | null; /** * Base64-encoded screenshot of the page that was analyzed. */ @@ -253,11 +258,11 @@ export namespace pagespeedonline_v4 { /** * Title of the page, as displayed in the browser's title bar. */ - title?: string; + title?: string | null; /** * The version of PageSpeed used to generate these results. */ - version?: {major?: number; minor?: number}; + version?: {major?: number; minor?: number} | null; } export class Resource$Pagespeedapi { diff --git a/src/apis/pagespeedonline/v5.ts b/src/apis/pagespeedonline/v5.ts index 266c7b527ea..bb0ca955327 100644 --- a/src/apis/pagespeedonline/v5.ts +++ b/src/apis/pagespeedonline/v5.ts @@ -107,66 +107,66 @@ export namespace pagespeedonline_v5 { /** * The description of the audit. */ - description?: string; + description?: string | null; /** * Freeform details section of the audit. */ - details?: {[key: string]: any}; + details?: {[key: string]: any} | null; /** * The value that should be displayed on the UI for this audit. */ - displayValue?: string; + displayValue?: string | null; /** * An error message from a thrown error inside the audit. */ - errorMessage?: string; + errorMessage?: string | null; /** * An explanation of the errors in the audit. */ - explanation?: string; + explanation?: string | null; /** * The audit's id. */ - id?: string; - score?: any; + id?: string | null; + score?: any | null; /** * The enumerated score display mode. */ - scoreDisplayMode?: string; + scoreDisplayMode?: string | null; /** * The human readable title. */ - title?: string; - warnings?: any; + title?: string | null; + warnings?: any | null; } export interface Schema$LighthouseCategoryV5 { /** * An array of references to all the audit members of this category. */ - auditRefs?: Array<{group?: string; id?: string; weight?: number}>; + auditRefs?: Array<{group?: string; id?: string; weight?: number}> | null; /** * A more detailed description of the category and its importance. */ - description?: string; + description?: string | null; /** * The string identifier of the category. */ - id?: string; + id?: string | null; /** * A description for the manual audits in the category. */ - manualDescription?: string; - score?: any; + manualDescription?: string | null; + score?: any | null; /** * The human-friendly name of the category. */ - title?: string; + title?: string | null; } export interface Schema$LighthouseResultV5 { /** * Map of audits in the LHR. */ - audits?: {[key: string]: Schema$LighthouseAuditResultV5}; + audits?: {[key: string]: Schema$LighthouseAuditResultV5} | null; /** * Map of categories in the LHR. */ @@ -176,11 +176,13 @@ export namespace pagespeedonline_v5 { performance?: Schema$LighthouseCategoryV5; pwa?: Schema$LighthouseCategoryV5; seo?: Schema$LighthouseCategoryV5; - }; + } | null; /** * Map of category groups in the LHR. */ - categoryGroups?: {[key: string]: {description?: string; title?: string}}; + categoryGroups?: { + [key: string]: {description?: string; title?: string}; + } | null; /** * The configuration settings for this LHR. */ @@ -188,7 +190,7 @@ export namespace pagespeedonline_v5 { emulatedFormFactor?: string; locale?: string; onlyCategories?: any; - }; + } | null; /** * Environment settings that were used when making this LHR. */ @@ -196,15 +198,15 @@ export namespace pagespeedonline_v5 { benchmarkIndex?: number; hostUserAgent?: string; networkUserAgent?: string; - }; + } | null; /** * The time that this run was fetched. */ - fetchTime?: string; + fetchTime?: string | null; /** * The final resolved url that was audited. */ - finalUrl?: string; + finalUrl?: string | null; /** * The internationalization strings that are required to render the LHR. */ @@ -227,19 +229,19 @@ export namespace pagespeedonline_v5 { varianceDisclaimer?: string; warningHeader?: string; }; - }; + } | null; /** * The lighthouse version that was used to generate this LHR. */ - lighthouseVersion?: string; + lighthouseVersion?: string | null; /** * The original requested url. */ - requestedUrl?: string; + requestedUrl?: string | null; /** * A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded. */ - runtimeError?: {code?: string; message?: string}; + runtimeError?: {code?: string; message?: string} | null; /** * List of all run warnings in the LHR. Will always output to at least `[]`. */ @@ -252,22 +254,22 @@ export namespace pagespeedonline_v5 { iconDataURL?: string; id?: string; title?: string; - }>; + }> | null; /** * Timing information for this LHR. */ - timing?: {total?: number}; + timing?: {total?: number} | null; /** * The user agent that was used to run this LHR. */ - userAgent?: string; + userAgent?: string | null; } export interface Schema$PagespeedApiLoadingExperienceV5 { /** * The url, pattern or origin which the metrics are on. */ - id?: string; - initial_url?: string; + id?: string | null; + initial_url?: string | null; metrics?: { [key: string]: { category?: string; @@ -278,26 +280,26 @@ export namespace pagespeedonline_v5 { }>; percentile?: number; }; - }; - overall_category?: string; + } | null; + overall_category?: string | null; } export interface Schema$PagespeedApiPagespeedResponseV5 { /** * The UTC timestamp of this analysis. */ - analysisUTCTimestamp?: string; + analysisUTCTimestamp?: string | null; /** * The captcha verify result */ - captchaResult?: string; + captchaResult?: string | null; /** * Canonicalized and final URL for the document, after following page redirects (if any). */ - id?: string; + id?: string | null; /** * Kind of result. */ - kind?: string; + kind?: string | null; /** * Lighthouse response for the audit url as an object. */ @@ -313,7 +315,7 @@ export namespace pagespeedonline_v5 { /** * The version of PageSpeed used to generate these results. */ - version?: {major?: number; minor?: number}; + version?: {major?: number; minor?: number} | null; } export class Resource$Pagespeedapi { diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index 6516c513d41..f8448141d15 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -126,27 +126,27 @@ export namespace people_v1 { /** * The city of the address. */ - city?: string; + city?: string | null; /** * The country of the address. */ - country?: string; + country?: string | null; /** * The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address. */ - countryCode?: string; + countryCode?: string | null; /** * The extended address of the address; for example, the apartment number. */ - extendedAddress?: string; + extendedAddress?: string | null; /** * The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values. */ - formattedValue?: string; + formattedValue?: string | null; /** * Metadata about the address. */ @@ -154,23 +154,23 @@ export namespace people_v1 { /** * The P.O. box of the address. */ - poBox?: string; + poBox?: string | null; /** * The postal code of the address. */ - postalCode?: string; + postalCode?: string | null; /** * The region of the address; for example, the state or province. */ - region?: string; + region?: string | null; /** * The street address. */ - streetAddress?: string; + streetAddress?: string | null; /** * The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other` */ - type?: string; + type?: string | null; } /** * A person's age range. @@ -179,7 +179,7 @@ export namespace people_v1 { /** * The age range. */ - ageRange?: string; + ageRange?: string | null; /** * Metadata about the age range. */ @@ -201,7 +201,7 @@ export namespace people_v1 { /** * The content type of the biography. */ - contentType?: string; + contentType?: string | null; /** * Metadata about the biography. */ @@ -209,7 +209,7 @@ export namespace people_v1 { /** * The short biography. */ - value?: string; + value?: string | null; } /** * A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to. @@ -226,7 +226,7 @@ export namespace people_v1 { /** * A free-form string representing the user's birthday. */ - text?: string; + text?: string | null; } /** * A person's bragging rights. @@ -239,7 +239,7 @@ export namespace people_v1 { /** * The bragging rights; for example, `climbed mount everest`. */ - value?: string; + value?: string | null; } /** * A contact group. @@ -248,23 +248,23 @@ export namespace people_v1 { /** * The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation. */ - etag?: string; + etag?: string | null; /** * The read-only name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name. */ - formattedName?: string; + formattedName?: string | null; /** * The read-only contact group type. */ - groupType?: string; + groupType?: string | null; /** * The total number of contacts in the group irrespective of max members in specified in the request. */ - memberCount?: number; + memberCount?: number | null; /** * The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify). */ - memberResourceNames?: string[]; + memberResourceNames?: string[] | null; /** * Metadata about the contact group. */ @@ -272,11 +272,11 @@ export namespace people_v1 { /** * The contact group name set by the group owner or a system provided name for system groups. */ - name?: string; + name?: string | null; /** * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>. */ - resourceName?: string; + resourceName?: string | null; } /** * A Google contact group membership. @@ -285,11 +285,11 @@ export namespace people_v1 { /** * The read-only contact group ID for the contact group membership. */ - contactGroupId?: string; + contactGroupId?: string | null; /** * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership. */ - contactGroupResourceName?: string; + contactGroupResourceName?: string | null; } /** * The read-only metadata about a contact group. @@ -298,11 +298,11 @@ export namespace people_v1 { /** * True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token. */ - deleted?: boolean; + deleted?: boolean | null; /** * The time the group was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The response for a specific contact group. @@ -315,7 +315,7 @@ export namespace people_v1 { /** * The original requested resource name. */ - requestedResourceName?: string; + requestedResourceName?: string | null; /** * The status of the response. */ @@ -328,7 +328,7 @@ export namespace people_v1 { /** * True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo. */ - default?: boolean; + default?: boolean | null; /** * Metadata about the cover photo. */ @@ -336,7 +336,7 @@ export namespace people_v1 { /** * The URL of the cover photo. */ - url?: string; + url?: string | null; } /** * A request to create a new contact group. @@ -348,21 +348,21 @@ export namespace people_v1 { contactGroup?: Schema$ContactGroup; } /** - * Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ - day?: number; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * The response for deleteing a contact's photo. @@ -380,7 +380,7 @@ export namespace people_v1 { /** * True if the person is in the viewer's G Suite domain. */ - inViewerDomain?: boolean; + inViewerDomain?: boolean | null; } /** * A person's email address. @@ -389,11 +389,11 @@ export namespace people_v1 { /** * The display name of the email. */ - displayName?: string; + displayName?: string | null; /** * The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * Metadata about the email address. */ @@ -401,11 +401,11 @@ export namespace people_v1 { /** * The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other` */ - type?: string; + type?: string | null; /** * The email address. */ - value?: string; + value?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -422,7 +422,7 @@ export namespace people_v1 { /** * The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * Metadata about the event. */ @@ -430,7 +430,7 @@ export namespace people_v1 { /** * The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other` */ - type?: string; + type?: string | null; } /** * Metadata about a field. @@ -439,7 +439,7 @@ export namespace people_v1 { /** * True if the field is the primary field; false if the field is a secondary field. */ - primary?: boolean; + primary?: boolean | null; /** * The source of the field. */ @@ -447,7 +447,7 @@ export namespace people_v1 { /** * True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person. */ - verified?: boolean; + verified?: boolean | null; } /** * A person's gender. @@ -456,7 +456,7 @@ export namespace people_v1 { /** * The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedValue?: string; + formattedValue?: string | null; /** * Metadata about the gender. */ @@ -464,7 +464,7 @@ export namespace people_v1 { /** * The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `other` * `unknown` */ - value?: string; + value?: string | null; } export interface Schema$GetPeopleResponse { /** @@ -479,11 +479,11 @@ export namespace people_v1 { /** * The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedProtocol?: string; + formattedProtocol?: string | null; /** * The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * Metadata about the IM client. */ @@ -491,15 +491,15 @@ export namespace people_v1 { /** * The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting` */ - protocol?: string; + protocol?: string | null; /** * The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other` */ - type?: string; + type?: string | null; /** * The user name used in the IM client. */ - username?: string; + username?: string | null; } /** * One of the person's interests. @@ -512,7 +512,7 @@ export namespace people_v1 { /** * The interest; for example, `stargazing`. */ - value?: string; + value?: string | null; } export interface Schema$ListConnectionsResponse { /** @@ -522,19 +522,19 @@ export namespace people_v1 { /** * The token that can be used to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The token that can be used to retrieve changes since the last request. */ - nextSyncToken?: string; + nextSyncToken?: string | null; /** * The total number of items in the list without pagination. */ - totalItems?: number; + totalItems?: number | null; /** * **DEPRECATED** (Please use totalItems) The total number of people in the list without pagination. */ - totalPeople?: number; + totalPeople?: number | null; } /** * The response to a list contact groups request. @@ -547,15 +547,15 @@ export namespace people_v1 { /** * The token that can be used to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The token that can be used to retrieve changes since the last request. */ - nextSyncToken?: string; + nextSyncToken?: string | null; /** * The total number of items in the list without pagination. */ - totalItems?: number; + totalItems?: number | null; } /** * A person's locale preference. @@ -568,7 +568,7 @@ export namespace people_v1 { /** * The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale. */ - value?: string; + value?: string | null; } /** * A person's membership in a group. Only contact group memberships can be modified. @@ -594,11 +594,11 @@ export namespace people_v1 { /** * The resource names of the contact people to add in the form of in the form `people/`<var>person_id</var>. */ - resourceNamesToAdd?: string[]; + resourceNamesToAdd?: string[] | null; /** * The resource names of the contact people to remove in the form of in the form of `people/`<var>person_id</var>. */ - resourceNamesToRemove?: string[]; + resourceNamesToRemove?: string[] | null; } /** * The response to a modify contact group members request. @@ -607,11 +607,11 @@ export namespace people_v1 { /** * The contact people resource names that cannot be removed from their last contact group. */ - canNotRemoveLastContactGroupResourceNames?: string[]; + canNotRemoveLastContactGroupResourceNames?: string[] | null; /** * The contact people resource names that were not found. */ - notFoundResourceNames?: string[]; + notFoundResourceNames?: string[] | null; } /** * A person's name. If the name is a mononym, the family name is empty. @@ -620,27 +620,27 @@ export namespace people_v1 { /** * The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. */ - displayName?: string; + displayName?: string | null; /** * The read-only display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. */ - displayNameLastFirst?: string; + displayNameLastFirst?: string | null; /** * The family name. */ - familyName?: string; + familyName?: string | null; /** * The given name. */ - givenName?: string; + givenName?: string | null; /** * The honorific prefixes, such as `Mrs.` or `Dr.` */ - honorificPrefix?: string; + honorificPrefix?: string | null; /** * The honorific suffixes, such as `Jr.` */ - honorificSuffix?: string; + honorificSuffix?: string | null; /** * Metadata about the name. */ @@ -648,31 +648,31 @@ export namespace people_v1 { /** * The middle name(s). */ - middleName?: string; + middleName?: string | null; /** * The family name spelled as it sounds. */ - phoneticFamilyName?: string; + phoneticFamilyName?: string | null; /** * The full name spelled as it sounds. */ - phoneticFullName?: string; + phoneticFullName?: string | null; /** * The given name spelled as it sounds. */ - phoneticGivenName?: string; + phoneticGivenName?: string | null; /** * The honorific prefixes spelled as they sound. */ - phoneticHonorificPrefix?: string; + phoneticHonorificPrefix?: string | null; /** * The honorific suffixes spelled as they sound. */ - phoneticHonorificSuffix?: string; + phoneticHonorificSuffix?: string | null; /** * The middle name(s) spelled as they sound. */ - phoneticMiddleName?: string; + phoneticMiddleName?: string | null; } /** * A person's nickname. @@ -685,11 +685,11 @@ export namespace people_v1 { /** * The type of the nickname. */ - type?: string; + type?: string | null; /** * The nickname. */ - value?: string; + value?: string | null; } /** * A person's occupation. @@ -702,7 +702,7 @@ export namespace people_v1 { /** * The occupation; for example, `carpenter`. */ - value?: string; + value?: string | null; } /** * A person's past or current organization. Overlapping date ranges are permitted. @@ -711,15 +711,15 @@ export namespace people_v1 { /** * True if the organization is the person's current organization; false if the organization is a past organization. */ - current?: boolean; + current?: boolean | null; /** * The person's department at the organization. */ - department?: string; + department?: string | null; /** * The domain name associated with the organization; for example, `google.com`. */ - domain?: string; + domain?: string | null; /** * The end date when the person left the organization. */ @@ -727,15 +727,15 @@ export namespace people_v1 { /** * The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * The person's job description at the organization. */ - jobDescription?: string; + jobDescription?: string | null; /** * The location of the organization office the person works at. */ - location?: string; + location?: string | null; /** * Metadata about the organization. */ @@ -743,11 +743,11 @@ export namespace people_v1 { /** * The name of the organization. */ - name?: string; + name?: string | null; /** * The phonetic name of the organization. */ - phoneticName?: string; + phoneticName?: string | null; /** * The start date when the person joined the organization. */ @@ -755,15 +755,15 @@ export namespace people_v1 { /** * The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym. */ - symbol?: string; + symbol?: string | null; /** * The person's job title at the organization. */ - title?: string; + title?: string | null; /** * The type of the organization. The type can be custom or one of these predefined values: * `work` * `school` */ - type?: string; + type?: string | null; } /** * Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. @@ -776,7 +776,7 @@ export namespace people_v1 { /** * **DEPRECATED** (Please use `person.ageRanges` instead)** The person's read-only age range. */ - ageRange?: string; + ageRange?: string | null; /** * The person's read-only age ranges. */ @@ -804,7 +804,7 @@ export namespace people_v1 { /** * The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation. */ - etag?: string; + etag?: string | null; /** * The person's events. */ @@ -876,7 +876,7 @@ export namespace people_v1 { /** * The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`<var>person_id</var>. */ - resourceName?: string; + resourceName?: string | null; /** * The person's SIP addresses. */ @@ -905,19 +905,19 @@ export namespace people_v1 { /** * True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. */ - deleted?: boolean; + deleted?: boolean | null; /** * Resource names of people linked to this resource. */ - linkedPeopleResourceNames?: string[]; + linkedPeopleResourceNames?: string[] | null; /** * **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object. */ - objectType?: string; + objectType?: string | null; /** * Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL. */ - previousResourceNames?: string[]; + previousResourceNames?: string[] | null; /** * The sources of data for the person. */ @@ -930,7 +930,7 @@ export namespace people_v1 { /** * **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). */ - httpStatusCode?: number; + httpStatusCode?: number | null; /** * The person. */ @@ -938,7 +938,7 @@ export namespace people_v1 { /** * The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL. */ - requestedResourceName?: string; + requestedResourceName?: string | null; /** * The status of the response. */ @@ -951,11 +951,11 @@ export namespace people_v1 { /** * The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number. */ - canonicalForm?: string; + canonicalForm?: string | null; /** * The read-only type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * Metadata about the phone number. */ @@ -963,11 +963,11 @@ export namespace people_v1 { /** * The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other` */ - type?: string; + type?: string | null; /** * The phone number. */ - value?: string; + value?: string | null; } /** * A person's read-only photo. A picture shown next to the person's name to help others recognize the person. @@ -976,7 +976,7 @@ export namespace people_v1 { /** * True if the photo is a default photo; false if the photo is a user-provided photo. */ - default?: boolean; + default?: boolean | null; /** * Metadata about the photo. */ @@ -984,7 +984,7 @@ export namespace people_v1 { /** * The URL of the photo. You can change the desired size by appending a query parameter `sz=`<var>size</var> at the end of the url. Example: `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50` */ - url?: string; + url?: string | null; } /** * The read-only metadata about a profile. @@ -993,11 +993,11 @@ export namespace people_v1 { /** * The profile object type. */ - objectType?: string; + objectType?: string | null; /** * The user types. */ - userTypes?: string[]; + userTypes?: string[] | null; } /** * A person's relation to another person. @@ -1006,7 +1006,7 @@ export namespace people_v1 { /** * The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. */ - formattedType?: string; + formattedType?: string | null; /** * Metadata about the relation. */ @@ -1014,11 +1014,11 @@ export namespace people_v1 { /** * The name of the other person this relation refers to. */ - person?: string; + person?: string | null; /** * The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` */ - type?: string; + type?: string | null; } /** * A person's read-only relationship interest . @@ -1027,7 +1027,7 @@ export namespace people_v1 { /** * The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. */ - formattedValue?: string; + formattedValue?: string | null; /** * Metadata about the relationship interest. */ @@ -1035,7 +1035,7 @@ export namespace people_v1 { /** * The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking` */ - value?: string; + value?: string | null; } /** * A person's read-only relationship status. @@ -1044,7 +1044,7 @@ export namespace people_v1 { /** * The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedValue?: string; + formattedValue?: string | null; /** * Metadata about the relationship status. */ @@ -1052,7 +1052,7 @@ export namespace people_v1 { /** * The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion` */ - value?: string; + value?: string | null; } /** * A person's past or current residence. @@ -1061,7 +1061,7 @@ export namespace people_v1 { /** * True if the residence is the person's current residence; false if the residence is a past residence. */ - current?: boolean; + current?: boolean | null; /** * Metadata about the residence. */ @@ -1069,7 +1069,7 @@ export namespace people_v1 { /** * The address of the residence. */ - value?: string; + value?: string | null; } /** * A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet. @@ -1078,7 +1078,7 @@ export namespace people_v1 { /** * The read-only type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * Metadata about the SIP address. */ @@ -1086,11 +1086,11 @@ export namespace people_v1 { /** * The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other` */ - type?: string; + type?: string | null; /** * The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format. */ - value?: string; + value?: string | null; } /** * A skill that the person has. @@ -1103,7 +1103,7 @@ export namespace people_v1 { /** * The skill; for example, `underwater basket weaving`. */ - value?: string; + value?: string | null; } /** * The source of a field. @@ -1112,11 +1112,11 @@ export namespace people_v1 { /** * **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. */ - etag?: string; + etag?: string | null; /** * The unique identifier within the source type generated by the server. */ - id?: string; + id?: string | null; /** * **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. */ @@ -1124,11 +1124,11 @@ export namespace people_v1 { /** * The source type. */ - type?: string; + type?: string | null; /** * **Only populated in `person.metadata.sources`.** Last update timestamp of this source. */ - updateTime?: string; + updateTime?: 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). @@ -1137,15 +1137,15 @@ export namespace people_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A read-only brief one-line description of the person. @@ -1158,7 +1158,7 @@ export namespace people_v1 { /** * The tagline. */ - value?: string; + value?: string | null; } /** * A request to update an existing user contact group. All updated fields will be replaced. @@ -1176,11 +1176,11 @@ export namespace people_v1 { /** * **Optional.** Not specifying any fields will skip the post mutate read. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined */ - personFields?: string; + personFields?: string | null; /** * Raw photo bytes */ - photoBytes?: string; + photoBytes?: string | null; } /** * The response for updating a contact's photo. @@ -1198,7 +1198,7 @@ export namespace people_v1 { /** * The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ - formattedType?: string; + formattedType?: string | null; /** * Metadata about the URL. */ @@ -1206,11 +1206,11 @@ export namespace people_v1 { /** * The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other` */ - type?: string; + type?: string | null; /** * The URL. */ - value?: string; + value?: string | null; } /** * Arbitrary user data that is populated by the end users. @@ -1219,7 +1219,7 @@ export namespace people_v1 { /** * The end user specified key of the user defined data. */ - key?: string; + key?: string | null; /** * Metadata about the user defined data. */ @@ -1227,7 +1227,7 @@ export namespace people_v1 { /** * The end user specified value of the user defined data. */ - value?: string; + value?: string | null; } export class Resource$Contactgroups { diff --git a/src/apis/playcustomapp/v1.ts b/src/apis/playcustomapp/v1.ts index 90a6f4ce4be..e23bb740fe5 100644 --- a/src/apis/playcustomapp/v1.ts +++ b/src/apis/playcustomapp/v1.ts @@ -108,11 +108,11 @@ export namespace playcustomapp_v1 { /** * Default listing language in BCP 47 format. */ - languageCode?: string; + languageCode?: string | null; /** * Title for the Android app. */ - title?: string; + title?: string | null; } export class Resource$Accounts { diff --git a/src/apis/plus/v1.ts b/src/apis/plus/v1.ts index 2e29d0ecedb..34affee5ea9 100644 --- a/src/apis/plus/v1.ts +++ b/src/apis/plus/v1.ts @@ -109,7 +109,7 @@ export namespace plus_v1 { /** * Description of the access granted, suitable for display. */ - description?: string; + description?: string | null; /** * The list of access entries. */ @@ -117,7 +117,7 @@ export namespace plus_v1 { /** * Identifies this resource as a collection of access controls. Value: "plus#acl". */ - kind?: string; + kind?: string | null; } export interface Schema$Activity { /** @@ -135,35 +135,35 @@ export namespace plus_v1 { name?: {familyName?: string; givenName?: string}; url?: string; verification?: {adHocVerified?: string}; - }; + } | null; /** * Street address where this activity occurred. */ - address?: string; + address?: string | null; /** * Additional content added by the person who shared this activity, applicable only when resharing an activity. */ - annotation?: string; + annotation?: string | null; /** * If this activity is a crosspost from another system, this property specifies the ID of the original activity. */ - crosspostSource?: string; + crosspostSource?: string | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. */ - geocode?: string; + geocode?: string | null; /** * The ID of this activity. */ - id?: string; + id?: string | null; /** * Identifies this resource as an activity. Value: "plus#activity". */ - kind?: string; + kind?: string | null; /** * The location where this activity occurred. */ @@ -213,53 +213,53 @@ export namespace plus_v1 { replies?: {selfLink?: string; totalItems?: number}; resharers?: {selfLink?: string; totalItems?: number}; url?: string; - }; + } | null; /** * ID of the place where this activity occurred. */ - placeId?: string; + placeId?: string | null; /** * Name of the place where this activity occurred. */ - placeName?: string; + placeName?: string | null; /** * The service provider that initially published this activity. */ - provider?: {title?: string}; + provider?: {title?: string} | null; /** * The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. */ - published?: string; + published?: string | null; /** * Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. */ - radius?: string; + radius?: string | null; /** * Title of this activity. */ - title?: string; + title?: string | null; /** * The time at which this activity was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; /** * The link to this activity. */ - url?: string; + url?: string | null; /** * This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: - "post" - Publish content to the stream. - "share" - Reshare an activity. */ - verb?: string; + verb?: string | null; } export interface Schema$ActivityFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID of this collection of activities. Deprecated. */ - id?: string; + id?: string | null; /** * The activities in this page of results. */ @@ -267,27 +267,27 @@ export namespace plus_v1 { /** * Identifies this resource as a collection of activities. Value: "plus#activityFeed". */ - kind?: string; + kind?: string | null; /** * Link to the next page of activities. */ - nextLink?: string; + nextLink?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Link to this activity resource. */ - selfLink?: string; + selfLink?: string | null; /** * The title of this collection of activities, which is a truncated portion of the content. */ - title?: string; + title?: string | null; /** * The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; } export interface Schema$Comment { /** @@ -300,57 +300,61 @@ export namespace plus_v1 { image?: {url?: string}; url?: string; verification?: {adHocVerified?: string}; - }; + } | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID of this comment. */ - id?: string; + id?: string | null; /** * The activity this comment replied to. */ - inReplyTo?: Array<{id?: string; url?: string}>; + inReplyTo?: Array<{id?: string; url?: string}> | null; /** * Identifies this resource as a comment. Value: "plus#comment". */ - kind?: string; + kind?: string | null; /** * The object of this comment. */ - object?: {content?: string; objectType?: string; originalContent?: string}; + object?: { + content?: string; + objectType?: string; + originalContent?: string; + } | null; /** * People who +1'd this comment. */ - plusoners?: {totalItems?: number}; + plusoners?: {totalItems?: number} | null; /** * The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. */ - published?: string; + published?: string | null; /** * Link to this comment resource. */ - selfLink?: string; + selfLink?: string | null; /** * The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; /** * This comment's verb, indicating what action was performed. Possible values are: - "post" - Publish content to the stream. */ - verb?: string; + verb?: string | null; } export interface Schema$CommentFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID of this collection of comments. */ - id?: string; + id?: string | null; /** * The comments in this page of results. */ @@ -358,29 +362,29 @@ export namespace plus_v1 { /** * Identifies this resource as a collection of comments. Value: "plus#commentFeed". */ - kind?: string; + kind?: string | null; /** * Link to the next page of activities. */ - nextLink?: string; + nextLink?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The title of this collection of comments. */ - title?: string; + title?: string | null; /** * The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; } export interface Schema$PeopleFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method. */ @@ -388,45 +392,45 @@ export namespace plus_v1 { /** * Identifies this resource as a collection of people. Value: "plus#peopleFeed". */ - kind?: string; + kind?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Link to this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The title of this collection of people. */ - title?: string; + title?: string | null; /** * The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$Person { /** * A short biography for this person. */ - aboutMe?: string; + aboutMe?: string | null; /** * The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. */ - ageRange?: {max?: number; min?: number}; + ageRange?: {max?: number; min?: number} | null; /** * The person's date of birth, represented as YYYY-MM-DD. */ - birthday?: string; + birthday?: string | null; /** * The "bragging rights" line of this person. */ - braggingRights?: string; + braggingRights?: string | null; /** * For followers who are visible, the number of people who have added this person or page to a circle. */ - circledByCount?: number; + circledByCount?: number | null; /** * The cover photo content. */ @@ -434,51 +438,51 @@ export namespace plus_v1 { coverInfo?: {leftImageOffset?: number; topImageOffset?: number}; coverPhoto?: {height?: number; url?: string; width?: number}; layout?: string; - }; + } | null; /** * (this field is not currently used) */ - currentLocation?: string; + currentLocation?: string | null; /** * The name of this person, which is suitable for display. */ - displayName?: string; + displayName?: string | null; /** * The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. */ - domain?: string; + domain?: string | null; /** * A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. */ - emails?: Array<{type?: string; value?: string}>; + emails?: Array<{type?: string; value?: string}> | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The person's gender. Possible values include, but are not limited to, the following values: - "male" - Male gender. - "female" - Female gender. - "other" - Other. */ - gender?: string; + gender?: string | null; /** * The ID of this person. */ - id?: string; + id?: string | null; /** * The representation of the person's profile photo. */ - image?: {isDefault?: boolean; url?: string}; + image?: {isDefault?: boolean; url?: string} | null; /** * Whether this user has signed up for Google+. */ - isPlusUser?: boolean; + isPlusUser?: boolean | null; /** * Identifies this resource as a person. Value: "plus#person". */ - kind?: string; + kind?: string | null; /** * The user's preferred language for rendering. */ - language?: string; + language?: string | null; /** * An object representation of the individual components of a person's name. */ @@ -489,19 +493,19 @@ export namespace plus_v1 { honorificPrefix?: string; honorificSuffix?: string; middleName?: string; - }; + } | null; /** * The nickname of this person. */ - nickname?: string; + nickname?: string | null; /** * Type of person within Google+. Possible values include, but are not limited to, the following values: - "person" - represents an actual person. - "page" - represents a page. */ - objectType?: string; + objectType?: string | null; /** * The occupation of this person. */ - occupation?: string; + occupation?: string | null; /** * A list of current or past organizations with which this person is associated. */ @@ -515,75 +519,75 @@ export namespace plus_v1 { startDate?: string; title?: string; type?: string; - }>; + }> | null; /** * A list of places where this person has lived. */ - placesLived?: Array<{primary?: boolean; value?: string}>; + placesLived?: Array<{primary?: boolean; value?: string}> | null; /** * If a Google+ Page, the number of people who have +1'd this page. */ - plusOneCount?: number; + plusOneCount?: number | null; /** * The person's relationship status. Possible values include, but are not limited to, the following values: - "single" - Person is single. - "in_a_relationship" - Person is in a relationship. - "engaged" - Person is engaged. - "married" - Person is married. - "its_complicated" - The relationship is complicated. - "open_relationship" - Person is in an open relationship. - "widowed" - Person is widowed. - "in_domestic_partnership" - Person is in a domestic partnership. - "in_civil_union" - Person is in a civil union. */ - relationshipStatus?: string; + relationshipStatus?: string | null; /** * The person's skills. */ - skills?: string; + skills?: string | null; /** * The brief description (tagline) of this person. */ - tagline?: string; + tagline?: string | null; /** * The URL of this person's profile. */ - url?: string; + url?: string | null; /** * A list of URLs for this person. */ - urls?: Array<{label?: string; type?: string; value?: string}>; + urls?: Array<{label?: string; type?: string; value?: string}> | null; /** * Whether the person or Google+ Page has been verified. */ - verified?: boolean; + verified?: boolean | null; } export interface Schema$Place { /** * The physical address of the place. */ - address?: {formatted?: string}; + address?: {formatted?: string} | null; /** * The display name of the place. */ - displayName?: string; + displayName?: string | null; /** * The id of the place. */ - id?: string; + id?: string | null; /** * Identifies this resource as a place. Value: "plus#place". */ - kind?: string; + kind?: string | null; /** * The position of the place. */ - position?: {latitude?: number; longitude?: number}; + position?: {latitude?: number; longitude?: number} | null; } export interface Schema$PlusAclentryResource { /** * A descriptive name for this entry. Suitable for display. */ - displayName?: string; + displayName?: string | null; /** * The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. */ - id?: string; + id?: string | null; /** * The type of entry describing to whom access is granted. Possible values are: - "person" - Access to an individual. - "circle" - Access to members of a circle. - "myCircles" - Access to members of all the person's circles. - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. - "domain" - Access to members of the person's Google Apps domain. - "public" - Access to anyone on the web. */ - type?: string; + type?: string | null; } export class Resource$Activities { diff --git a/src/apis/plusDomains/v1.ts b/src/apis/plusDomains/v1.ts index 94176126ab0..03443b0a06e 100644 --- a/src/apis/plusDomains/v1.ts +++ b/src/apis/plusDomains/v1.ts @@ -115,11 +115,11 @@ export namespace plusDomains_v1 { /** * Description of the access granted, suitable for display. */ - description?: string; + description?: string | null; /** * Whether access is restricted to the domain. */ - domainRestricted?: boolean; + domainRestricted?: boolean | null; /** * The list of access entries. */ @@ -127,7 +127,7 @@ export namespace plusDomains_v1 { /** * Identifies this resource as a collection of access controls. Value: "plus#acl". */ - kind?: string; + kind?: string | null; } export interface Schema$Activity { /** @@ -145,35 +145,35 @@ export namespace plusDomains_v1 { name?: {familyName?: string; givenName?: string}; url?: string; verification?: {adHocVerified?: string}; - }; + } | null; /** * Street address where this activity occurred. */ - address?: string; + address?: string | null; /** * Additional content added by the person who shared this activity, applicable only when resharing an activity. */ - annotation?: string; + annotation?: string | null; /** * If this activity is a crosspost from another system, this property specifies the ID of the original activity. */ - crosspostSource?: string; + crosspostSource?: string | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. */ - geocode?: string; + geocode?: string | null; /** * The ID of this activity. */ - id?: string; + id?: string | null; /** * Identifies this resource as an activity. Value: "plus#activity". */ - kind?: string; + kind?: string | null; /** * The location where this activity occurred. */ @@ -231,53 +231,53 @@ export namespace plusDomains_v1 { resharingDisabled?: boolean; }; url?: string; - }; + } | null; /** * ID of the place where this activity occurred. */ - placeId?: string; + placeId?: string | null; /** * Name of the place where this activity occurred. */ - placeName?: string; + placeName?: string | null; /** * The service provider that initially published this activity. */ - provider?: {title?: string}; + provider?: {title?: string} | null; /** * The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. */ - published?: string; + published?: string | null; /** * Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. */ - radius?: string; + radius?: string | null; /** * Title of this activity. */ - title?: string; + title?: string | null; /** * The time at which this activity was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; /** * The link to this activity. */ - url?: string; + url?: string | null; /** * This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: - "post" - Publish content to the stream. - "share" - Reshare an activity. */ - verb?: string; + verb?: string | null; } export interface Schema$ActivityFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID of this collection of activities. Deprecated. */ - id?: string; + id?: string | null; /** * The activities in this page of results. */ @@ -285,33 +285,33 @@ export namespace plusDomains_v1 { /** * Identifies this resource as a collection of activities. Value: "plus#activityFeed". */ - kind?: string; + kind?: string | null; /** * Link to the next page of activities. */ - nextLink?: string; + nextLink?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Link to this activity resource. */ - selfLink?: string; + selfLink?: string | null; /** * The title of this collection of activities, which is a truncated portion of the content. */ - title?: string; + title?: string | null; /** * The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; } export interface Schema$Audience { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The access control list entry. */ @@ -319,21 +319,21 @@ export namespace plusDomains_v1 { /** * Identifies this resource as an audience. Value: "plus#audience". */ - kind?: string; + kind?: string | null; /** * The number of people in this circle. This only applies if entity_type is CIRCLE. */ - memberCount?: number; + memberCount?: number | null; /** * The circle members' visibility as chosen by the owner of the circle. This only applies for items with "item.type" equals "circle". Possible values are: - "public" - Members are visible to the public. - "limited" - Members are visible to a limited audience. - "private" - Members are visible to the owner only. */ - visibility?: string; + visibility?: string | null; } export interface Schema$AudiencesFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The audiences in this result. */ @@ -341,51 +341,51 @@ export namespace plusDomains_v1 { /** * Identifies this resource as a collection of audiences. Value: "plus#audienceFeed". */ - kind?: string; + kind?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of ACL entries. The number of entries in this response may be smaller due to paging. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$Circle { /** * The description of this circle. */ - description?: string; + description?: string | null; /** * The circle name. */ - displayName?: string; + displayName?: string | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID of the circle. */ - id?: string; + id?: string | null; /** * Identifies this resource as a circle. Value: "plus#circle". */ - kind?: string; + kind?: string | null; /** * The people in this circle. */ - people?: {totalItems?: number}; + people?: {totalItems?: number} | null; /** * Link to this circle resource */ - selfLink?: string; + selfLink?: string | null; } export interface Schema$CircleFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The circles in this page of results. */ @@ -393,27 +393,27 @@ export namespace plusDomains_v1 { /** * Identifies this resource as a collection of circles. Value: "plus#circleFeed". */ - kind?: string; + kind?: string | null; /** * Link to the next page of circles. */ - nextLink?: string; + nextLink?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Link to this page of circles. */ - selfLink?: string; + selfLink?: string | null; /** * The title of this list of resources. */ - title?: string; + title?: string | null; /** * The total number of circles. The number of circles in this response may be smaller due to paging. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$Comment { /** @@ -426,57 +426,61 @@ export namespace plusDomains_v1 { image?: {url?: string}; url?: string; verification?: {adHocVerified?: string}; - }; + } | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID of this comment. */ - id?: string; + id?: string | null; /** * The activity this comment replied to. */ - inReplyTo?: Array<{id?: string; url?: string}>; + inReplyTo?: Array<{id?: string; url?: string}> | null; /** * Identifies this resource as a comment. Value: "plus#comment". */ - kind?: string; + kind?: string | null; /** * The object of this comment. */ - object?: {content?: string; objectType?: string; originalContent?: string}; + object?: { + content?: string; + objectType?: string; + originalContent?: string; + } | null; /** * People who +1'd this comment. */ - plusoners?: {totalItems?: number}; + plusoners?: {totalItems?: number} | null; /** * The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. */ - published?: string; + published?: string | null; /** * Link to this comment resource. */ - selfLink?: string; + selfLink?: string | null; /** * The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; /** * This comment's verb, indicating what action was performed. Possible values are: - "post" - Publish content to the stream. */ - verb?: string; + verb?: string | null; } export interface Schema$CommentFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The ID of this collection of comments. */ - id?: string; + id?: string | null; /** * The comments in this page of results. */ @@ -484,23 +488,23 @@ export namespace plusDomains_v1 { /** * Identifies this resource as a collection of comments. Value: "plus#commentFeed". */ - kind?: string; + kind?: string | null; /** * Link to the next page of activities. */ - nextLink?: string; + nextLink?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The title of this collection of comments. */ - title?: string; + title?: string | null; /** * The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; } export interface Schema$Media { /** @@ -511,47 +515,47 @@ export namespace plusDomains_v1 { id?: string; image?: {url?: string}; url?: string; - }; + } | null; /** * The display name for this media. */ - displayName?: string; + displayName?: string | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * Exif information of the media item. */ - exif?: {time?: string}; + exif?: {time?: string} | null; /** * The height in pixels of the original image. */ - height?: number; + height?: number | null; /** * ID of this media, which is generated by the API. */ - id?: string; + id?: string | null; /** * The type of resource. */ - kind?: string; + kind?: string | null; /** * The time at which this media was originally created in UTC. Formatted as an RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z */ - mediaCreatedTime?: string; + mediaCreatedTime?: string | null; /** * The URL of this photo or video's still image. */ - mediaUrl?: string; + mediaUrl?: string | null; /** * The time at which this media was uploaded. Formatted as an RFC 3339 timestamp. */ - published?: string; + published?: string | null; /** * The size in bytes of this video. */ - sizeBytes?: string; + sizeBytes?: string | null; /** * The list of video streams for this video. There might be several different streams available for a single video, either Flash or MPEG, of various sizes */ @@ -559,33 +563,33 @@ export namespace plusDomains_v1 { /** * A description, or caption, for this media. */ - summary?: string; + summary?: string | null; /** * The time at which this media was last updated. This includes changes to media metadata. Formatted as an RFC 3339 timestamp. */ - updated?: string; + updated?: string | null; /** * The URL for the page that hosts this media. */ - url?: string; + url?: string | null; /** * The duration in milliseconds of this video. */ - videoDuration?: string; + videoDuration?: string | null; /** * The encoding status of this video. Possible values are: - "UPLOADING" - Not all the video bytes have been received. - "PENDING" - Video not yet processed. - "FAILED" - Video processing failed. - "READY" - A single video stream is playable. - "FINAL" - All video streams are playable. */ - videoStatus?: string; + videoStatus?: string | null; /** * The width in pixels of the original image. */ - width?: number; + width?: number | null; } export interface Schema$PeopleFeed { /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method. */ @@ -593,41 +597,41 @@ export namespace plusDomains_v1 { /** * Identifies this resource as a collection of people. Value: "plus#peopleFeed". */ - kind?: string; + kind?: string | null; /** * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Link to this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The title of this collection of people. */ - title?: string; + title?: string | null; /** * The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. */ - totalItems?: number; + totalItems?: number | null; } export interface Schema$Person { /** * A short biography for this person. */ - aboutMe?: string; + aboutMe?: string | null; /** * The person's date of birth, represented as YYYY-MM-DD. */ - birthday?: string; + birthday?: string | null; /** * The "bragging rights" line of this person. */ - braggingRights?: string; + braggingRights?: string | null; /** * For followers who are visible, the number of people who have added this person or page to a circle. */ - circledByCount?: number; + circledByCount?: number | null; /** * The cover photo content. */ @@ -635,47 +639,47 @@ export namespace plusDomains_v1 { coverInfo?: {leftImageOffset?: number; topImageOffset?: number}; coverPhoto?: {height?: number; url?: string; width?: number}; layout?: string; - }; + } | null; /** * (this field is not currently used) */ - currentLocation?: string; + currentLocation?: string | null; /** * The name of this person, which is suitable for display. */ - displayName?: string; + displayName?: string | null; /** * The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. */ - domain?: string; + domain?: string | null; /** * A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. */ - emails?: Array<{type?: string; value?: string}>; + emails?: Array<{type?: string; value?: string}> | null; /** * ETag of this response for caching purposes. */ - etag?: string; + etag?: string | null; /** * The person's gender. Possible values include, but are not limited to, the following values: - "male" - Male gender. - "female" - Female gender. - "other" - Other. */ - gender?: string; + gender?: string | null; /** * The ID of this person. */ - id?: string; + id?: string | null; /** * The representation of the person's profile photo. */ - image?: {isDefault?: boolean; url?: string}; + image?: {isDefault?: boolean; url?: string} | null; /** * Whether this user has signed up for Google+. */ - isPlusUser?: boolean; + isPlusUser?: boolean | null; /** * Identifies this resource as a person. Value: "plus#person". */ - kind?: string; + kind?: string | null; /** * An object representation of the individual components of a person's name. */ @@ -686,19 +690,19 @@ export namespace plusDomains_v1 { honorificPrefix?: string; honorificSuffix?: string; middleName?: string; - }; + } | null; /** * The nickname of this person. */ - nickname?: string; + nickname?: string | null; /** * Type of person within Google+. Possible values include, but are not limited to, the following values: - "person" - represents an actual person. - "page" - represents a page. */ - objectType?: string; + objectType?: string | null; /** * The occupation of this person. */ - occupation?: string; + occupation?: string | null; /** * A list of current or past organizations with which this person is associated. */ @@ -712,93 +716,93 @@ export namespace plusDomains_v1 { startDate?: string; title?: string; type?: string; - }>; + }> | null; /** * A list of places where this person has lived. */ - placesLived?: Array<{primary?: boolean; value?: string}>; + placesLived?: Array<{primary?: boolean; value?: string}> | null; /** * If a Google+ Page, the number of people who have +1'd this page. */ - plusOneCount?: number; + plusOneCount?: number | null; /** * The person's relationship status. Possible values include, but are not limited to, the following values: - "single" - Person is single. - "in_a_relationship" - Person is in a relationship. - "engaged" - Person is engaged. - "married" - Person is married. - "its_complicated" - The relationship is complicated. - "open_relationship" - Person is in an open relationship. - "widowed" - Person is widowed. - "in_domestic_partnership" - Person is in a domestic partnership. - "in_civil_union" - Person is in a civil union. */ - relationshipStatus?: string; + relationshipStatus?: string | null; /** * The person's skills. */ - skills?: string; + skills?: string | null; /** * The brief description (tagline) of this person. */ - tagline?: string; + tagline?: string | null; /** * The URL of this person's profile. */ - url?: string; + url?: string | null; /** * A list of URLs for this person. */ - urls?: Array<{label?: string; type?: string; value?: string}>; + urls?: Array<{label?: string; type?: string; value?: string}> | null; /** * Whether the person or Google+ Page has been verified. */ - verified?: boolean; + verified?: boolean | null; } export interface Schema$Place { /** * The physical address of the place. */ - address?: {formatted?: string}; + address?: {formatted?: string} | null; /** * The display name of the place. */ - displayName?: string; + displayName?: string | null; /** * The id of the place. */ - id?: string; + id?: string | null; /** * Identifies this resource as a place. Value: "plus#place". */ - kind?: string; + kind?: string | null; /** * The position of the place. */ - position?: {latitude?: number; longitude?: number}; + position?: {latitude?: number; longitude?: number} | null; } export interface Schema$PlusDomainsAclentryResource { /** * A descriptive name for this entry. Suitable for display. */ - displayName?: string; + displayName?: string | null; /** * The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. */ - id?: string; + id?: string | null; /** * The type of entry describing to whom access is granted. Possible values are: - "person" - Access to an individual. - "circle" - Access to members of a circle. - "myCircles" - Access to members of all the person's circles. - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. - "domain" - Access to members of the person's Google Apps domain. - "public" - Access to anyone on the web. */ - type?: string; + type?: string | null; } export interface Schema$Videostream { /** * The height, in pixels, of the video resource. */ - height?: number; + height?: number | null; /** * MIME type of the video stream. */ - type?: string; + type?: string | null; /** * URL of the video stream. */ - url?: string; + url?: string | null; /** * The width, in pixels, of the video resource. */ - width?: number; + width?: number | null; } export class Resource$Activities { diff --git a/src/apis/poly/v1.ts b/src/apis/poly/v1.ts index 93afa20fdf1..b136d9d3026 100644 --- a/src/apis/poly/v1.ts +++ b/src/apis/poly/v1.ts @@ -126,19 +126,19 @@ export namespace poly_v1 { /** * The author's publicly visible name. Use this name when giving credit to the author. For more information, see [Licensing](/poly/discover/licensing). */ - authorName?: string; + authorName?: string | null; /** * For published assets, the time when the asset was published. For unpublished assets, the time when the asset was created. */ - createTime?: string; + createTime?: string | null; /** * The human-readable description, set by the asset's author. */ - description?: string; + description?: string | null; /** * The human-readable name, set by the asset's author. */ - displayName?: string; + displayName?: string | null; /** * A list of Formats where each format describes one representation of the asset. */ @@ -146,19 +146,19 @@ export namespace poly_v1 { /** * Whether this asset has been curated by the Poly team. */ - isCurated?: boolean; + isCurated?: boolean | null; /** * The license under which the author has made the asset available for use, if any. */ - license?: string; + license?: string | null; /** * Application-defined opaque metadata for this asset. This field is only returned when querying for the signed-in user's own assets, not for public assets. This string is limited to 1K chars. It is up to the creator of the asset to define the format for this string (for example, JSON). */ - metadata?: string; + metadata?: string | null; /** * The unique identifier for the asset in the form: `assets/{ASSET_ID}`. */ - name?: string; + name?: string | null; /** * Hints for displaying the asset. Note that these parameters are not immutable; the author of an asset may change them post-publication. */ @@ -174,11 +174,11 @@ export namespace poly_v1 { /** * The time when the asset was last modified. For published assets, whose contents are immutable, the update time changes only when metadata properties, such as visibility, are updated. */ - updateTime?: string; + updateTime?: string | null; /** * The visibility of the asset and who can access it. */ - visibility?: string; + visibility?: string | null; } /** * A message generated by the asset import process. @@ -187,11 +187,11 @@ export namespace poly_v1 { /** * The code associated with this message. */ - code?: string; + code?: string | null; /** * An optional file path. Only present for those error codes that specify it. */ - filePath?: string; + filePath?: string | null; /** * An optional image error. Only present for INVALID_IMAGE_FILE. */ @@ -208,15 +208,15 @@ export namespace poly_v1 { /** * The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). */ - contentType?: string; + contentType?: string | null; /** * The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename. */ - relativePath?: string; + relativePath?: string | null; /** * The URL where the file data can be retrieved. */ - url?: string; + url?: string | null; } /** * The same asset can be represented in different formats, for example, a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file with its corresponding .glb binary data. A format refers to a specific representation of an asset and contains all information needed to retrieve and describe this representation. @@ -229,7 +229,7 @@ export namespace poly_v1 { /** * A short string that identifies the format type of this representation. Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. */ - formatType?: string; + formatType?: string | null; /** * A list of dependencies of the root element. May include, but is not limited to, materials, textures, and shader programs. */ @@ -246,11 +246,11 @@ export namespace poly_v1 { /** * A non-negative integer that represents the level of detail (LOD) of this format relative to other formats of the same asset with the same format_type. This hint allows you to sort formats from the most-detailed (0) to least-detailed (integers greater than 0). */ - lodHint?: number; + lodHint?: number | null; /** * The estimated number of triangles. */ - triangleCount?: string; + triangleCount?: string | null; } /** * A message resulting from reading an image file. @@ -259,11 +259,11 @@ export namespace poly_v1 { /** * The type of image error encountered. Optional for older image errors. */ - code?: string; + code?: string | null; /** * The file path in the import of the image that was rejected. */ - filePath?: string; + filePath?: string | null; } /** * A response message from a request to list. @@ -276,11 +276,11 @@ export namespace poly_v1 { /** * The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of assets in the list, without pagination. */ - totalSize?: number; + totalSize?: number | null; } /** * A response message from a request to list. @@ -293,11 +293,11 @@ export namespace poly_v1 { /** * The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of assets in the list, without pagination. */ - totalSize?: number; + totalSize?: number | null; } /** * A response message from a request to list. @@ -306,11 +306,11 @@ export namespace poly_v1 { /** * The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The total number of assets in the list, without pagination. */ - totalSize?: number; + totalSize?: number | null; /** * A list of UserAssets matching the request. */ @@ -323,27 +323,27 @@ export namespace poly_v1 { /** * The type of problem found (required). */ - code?: string; + code?: string | null; /** * The ending character index at which the problem was found. */ - endIndex?: number; + endIndex?: number | null; /** * The file path in which the problem was found. */ - filePath?: string; + filePath?: string | null; /** * The text of the line. Note that this may be truncated if the line was very long. This may not include the error if it occurs after line truncation. */ - line?: string; + line?: string | null; /** * Line number at which the problem was found. */ - lineNumber?: number; + lineNumber?: number | null; /** * The starting character index at which the problem was found. */ - startIndex?: number; + startIndex?: number | null; } /** * Hints for displaying the asset, based on information available when the asset was uploaded. @@ -352,11 +352,11 @@ export namespace poly_v1 { /** * A background color which could be used for displaying the 3D asset in a 'thumbnail' or 'palette' style view. Authors have the option to set this background color when publishing or editing their asset. This is represented as a six-digit hexademical triplet specifying the RGB components of the background color, e.g. #FF0000 for Red. */ - backgroundColor?: string; + backgroundColor?: string | null; /** * The materials' diffuse/albedo color. This does not apply to vertex colors or texture maps. */ - colorSpace?: string; + colorSpace?: string | null; /** * A rotation that should be applied to the object root to make it upright. More precisely, this quaternion transforms from "object space" (the space in which the object is defined) to "presentation space", a coordinate system where +Y is up, +X is right, -Z is forward. For example, if the object is the Eiffel Tower, in its local coordinate system the object might be laid out such that the base of the tower is on the YZ plane and the tip of the tower is towards positive X. In this case this quaternion would specify a rotation (of 90 degrees about the Z axis) such that in the presentation space the base of the tower is aligned with the XZ plane, and the tip of the tower lies towards +Y. This rotation is unrelated to the object's pose in the web preview, which is just a camera position setting and is *not* reflected in this rotation. Please note: this is applicable only to the gLTF. */ @@ -369,19 +369,19 @@ export namespace poly_v1 { /** * The scalar component. */ - w?: number; + w?: number | null; /** * The x component. */ - x?: number; + x?: number | null; /** * The y component. */ - y?: number; + y?: number | null; /** * The z component. */ - z?: number; + z?: number | null; } /** * Info about the sources of this asset (i.e. assets that were remixed to create this asset). @@ -390,7 +390,7 @@ export namespace poly_v1 { /** * Resource ids for the sources of this remix, of the form: `assets/{ASSET_ID}` */ - sourceAsset?: string[]; + sourceAsset?: string[] | null; } /** * A response message from a request to startImport. This is returned in the response field of the Operation. @@ -399,11 +399,11 @@ export namespace poly_v1 { /** * The id of newly created asset. If this is empty when the operation is complete it means the import failed. Please refer to the assetImportMessages field to understand what went wrong. */ - assetId?: string; + assetId?: string | null; /** * The id of the asset import. */ - assetImportId?: string; + assetImportId?: string | null; /** * The message from the asset import. This will contain any warnings (or - in the case of failure - errors) that occurred during import. */ @@ -411,7 +411,7 @@ export namespace poly_v1 { /** * The publish URL for the asset. */ - publishUrl?: string; + publishUrl?: string | null; } /** * Data about the user's asset. diff --git a/src/apis/proximitybeacon/v1beta1.ts b/src/apis/proximitybeacon/v1beta1.ts index 93cf195cd8b..f022ca74c3c 100644 --- a/src/apis/proximitybeacon/v1beta1.ts +++ b/src/apis/proximitybeacon/v1beta1.ts @@ -130,11 +130,11 @@ export namespace proximitybeacon_v1beta1 { /** * The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required. */ - id?: string; + id?: string | null; /** * Specifies the identifier type. Required. */ - type?: string; + type?: string | null; } /** * A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons. @@ -143,15 +143,15 @@ export namespace proximitybeacon_v1beta1 { /** * An opaque data container for client-provided data. */ - data?: string; + data?: string | null; /** * The distance away from the beacon at which this attachment should be delivered to a mobile app. Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon. Different attachments on the same beacon can have different max distances. Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology. Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection. */ - maxDistanceMeters?: number; + maxDistanceMeters?: number | null; /** * Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is <var>namespace/type</var>, for example <code>scrupulous-wombat-12345/welcome-message</code> */ - namespacedType?: string; + namespacedType?: string | null; } /** * Details of a beacon device. @@ -164,11 +164,11 @@ export namespace proximitybeacon_v1beta1 { /** * Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations. */ - beaconName?: string; + beaconName?: string | null; /** * Free text used to identify and describe the beacon. Maximum length 140 characters. Optional. */ - description?: string; + description?: string | null; /** * Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error. */ @@ -176,7 +176,7 @@ export namespace proximitybeacon_v1beta1 { /** * Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional. */ - expectedStability?: string; + expectedStability?: string | null; /** * The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional. */ @@ -188,19 +188,19 @@ export namespace proximitybeacon_v1beta1 { /** * The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional. */ - placeId?: string; + placeId?: string | null; /** * Properties of the beacon device, for example battery type or firmware version. Optional. */ - properties?: {[key: string]: string}; + properties?: {[key: string]: string} | null; /** * Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself. */ - provisioningKey?: string; + provisioningKey?: string | null; /** * Current status of the beacon. Required. */ - status?: string; + status?: string | null; } /** * Project-specific data associated with a beacon. @@ -209,23 +209,23 @@ export namespace proximitybeacon_v1beta1 { /** * Resource name of this attachment. Attachment names have the format: <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>. Leave this empty on creation. */ - attachmentName?: string; + attachmentName?: string | null; /** * The UTC time when this attachment was created, in milliseconds since the UNIX epoch. */ - creationTimeMs?: string; + creationTimeMs?: string | null; /** * An opaque data container for client-provided data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. Required. */ - data?: string; + data?: string | null; /** * The distance away from the beacon at which this attachment should be delivered to a mobile app. Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon. Different attachments on the same beacon can have different max distances. Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology. Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection. Negative values are invalid and return an error. */ - maxDistanceMeters?: number; + maxDistanceMeters?: number | null; /** * Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is <var>namespace/type</var>. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required. */ - namespacedType?: string; + namespacedType?: string | null; } /** * A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons. @@ -242,7 +242,7 @@ export namespace proximitybeacon_v1beta1 { /** * The name under which the beacon is registered. */ - beaconName?: string; + beaconName?: 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 date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. @@ -251,15 +251,15 @@ export namespace proximitybeacon_v1beta1 { /** * 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; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * Response for a request to delete attachments. @@ -268,7 +268,7 @@ export namespace proximitybeacon_v1beta1 { /** * The number of attachments that were deleted. */ - numDeleted?: number; + numDeleted?: number | null; } /** * Diagnostics for a single beacon. @@ -277,11 +277,11 @@ export namespace proximitybeacon_v1beta1 { /** * An unordered list of Alerts that the beacon has. */ - alerts?: string[]; + alerts?: string[] | null; /** * Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's "stable" Eddystone-UID. */ - beaconName?: string; + beaconName?: string | null; /** * The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date. */ @@ -298,27 +298,27 @@ export namespace proximitybeacon_v1beta1 { /** * The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be. */ - beaconEcdhPublicKey?: string; + beaconEcdhPublicKey?: string | null; /** * The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated. */ - beaconIdentityKey?: string; + beaconIdentityKey?: string | null; /** * The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero. */ - initialClockValue?: string; + initialClockValue?: string | null; /** * An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful. */ - initialEid?: string; + initialEid?: string | null; /** * Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds. */ - rotationPeriodExponent?: number; + rotationPeriodExponent?: number | null; /** * The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be. */ - serviceEcdhPublicKey?: string; + serviceEcdhPublicKey?: string | null; } /** * Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. @@ -327,15 +327,15 @@ export namespace proximitybeacon_v1beta1 { /** * Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent */ - maxRotationPeriodExponent?: number; + maxRotationPeriodExponent?: number | null; /** * Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent */ - minRotationPeriodExponent?: number; + minRotationPeriodExponent?: number | null; /** * The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange. */ - serviceEcdhPublicKey?: string; + serviceEcdhPublicKey?: string | null; } /** * Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild". @@ -344,7 +344,7 @@ export namespace proximitybeacon_v1beta1 { /** * Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format <var>namespace/type</var>. Accepts `*` to specify all types in all namespaces owned by the client. Optional. */ - namespacedTypes?: string[]; + namespacedTypes?: string[] | null; /** * The beacons that the client has encountered. At least one must be given. */ @@ -366,7 +366,7 @@ export namespace proximitybeacon_v1beta1 { /** * The name of this level. */ - name?: string; + name?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -375,11 +375,11 @@ export namespace proximitybeacon_v1beta1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Response to `ListBeaconAttachments` that contains the requested attachments. @@ -401,11 +401,11 @@ export namespace proximitybeacon_v1beta1 { /** * An opaque pagination token that the client may provide in their next request to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Estimate of the total number of beacons matched by the query. Higher values may be less accurate. */ - totalCount?: string; + totalCount?: string | null; } /** * Response that contains the requested diagnostics. @@ -418,7 +418,7 @@ export namespace proximitybeacon_v1beta1 { /** * Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response to ListNamespacesRequest that contains all the project's namespaces. @@ -436,11 +436,11 @@ export namespace proximitybeacon_v1beta1 { /** * Resource name of this namespace. Namespaces names have the format: <code>namespaces/<var>namespace</var></code>. */ - namespaceName?: string; + namespaceName?: string | null; /** * Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`. */ - servingVisibility?: string; + servingVisibility?: string | null; } /** * Represents one beacon observed once. @@ -453,11 +453,11 @@ export namespace proximitybeacon_v1beta1 { /** * The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally. */ - telemetry?: string; + telemetry?: string | null; /** * Time when the beacon was observed. */ - timestampMs?: string; + timestampMs?: string | null; } export class Resource$Beaconinfo { diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index e247fae983c..913beb31fae 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -124,7 +124,7 @@ export namespace pubsub_v1 { /** * The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. */ - ackIds?: string[]; + ackIds?: string[] | null; } /** * Associates `members` with a `role`. @@ -137,11 +137,11 @@ export namespace pubsub_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Request for the `CreateSnapshot` method. @@ -150,11 +150,11 @@ export namespace pubsub_v1 { /** * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`. */ - subscription?: string; + subscription?: 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 `{}`. @@ -167,7 +167,7 @@ export namespace pubsub_v1 { /** * Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of `ttl`. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for `ttl` depend on the type of the associated resource, as well. If `ttl` is not set, the associated resource never expires. */ - ttl?: string; + ttl?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -176,19 +176,19 @@ export namespace pubsub_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Response for the `ListSnapshots` method. @@ -197,7 +197,7 @@ export namespace pubsub_v1 { /** * If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The resulting snapshots. */ @@ -210,7 +210,7 @@ export namespace pubsub_v1 { /** * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The subscriptions that match the request. */ @@ -223,11 +223,11 @@ export namespace pubsub_v1 { /** * If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new `ListTopicSnapshotsRequest` to get more snapshots. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The names of the snapshots that match the request. */ - snapshots?: string[]; + snapshots?: string[] | null; } /** * Response for the `ListTopics` method. @@ -236,7 +236,7 @@ export namespace pubsub_v1 { /** * If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The resulting topics. */ @@ -249,17 +249,17 @@ export namespace pubsub_v1 { /** * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The names of the subscriptions that match the request. */ - subscriptions?: string[]; + subscriptions?: string[] | null; } export interface Schema$MessageStoragePolicy { /** * A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration. */ - allowedPersistenceRegions?: string[]; + allowedPersistenceRegions?: string[] | null; } /** * Request for the ModifyAckDeadline method. @@ -268,11 +268,11 @@ export namespace pubsub_v1 { /** * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes). */ - ackDeadlineSeconds?: number; + ackDeadlineSeconds?: number | null; /** * List of acknowledgment IDs. */ - ackIds?: string[]; + ackIds?: string[] | null; } /** * Request for the ModifyPushConfig method. @@ -290,11 +290,11 @@ export namespace pubsub_v1 { /** * Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used. */ - audience?: string; + audience?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -307,11 +307,11 @@ export namespace pubsub_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request for the Publish method. @@ -329,7 +329,7 @@ export namespace pubsub_v1 { /** * The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic. */ - messageIds?: string[]; + messageIds?: string[] | null; } /** * A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> for more information about message limits. @@ -338,19 +338,19 @@ export namespace pubsub_v1 { /** * Optional attributes for this message. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * The message data field. If this field is empty, the message must contain at least one attribute. */ - data?: string; + data?: string | null; /** * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ - messageId?: string; + messageId?: string | null; /** * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ - publishTime?: string; + publishTime?: string | null; } /** * Request for the `Pull` method. @@ -359,11 +359,11 @@ export namespace pubsub_v1 { /** * The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified. */ - maxMessages?: number; + maxMessages?: number | null; /** * If this field set to true, the system will respond immediately even if it there are no messages available to return in the `Pull` response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. */ - returnImmediately?: boolean; + returnImmediately?: boolean | null; } /** * Response for the `Pull` method. @@ -381,7 +381,7 @@ export namespace pubsub_v1 { /** * Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre> */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. */ @@ -389,7 +389,7 @@ export namespace pubsub_v1 { /** * A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". */ - pushEndpoint?: string; + pushEndpoint?: string | null; } /** * A message and its corresponding acknowledgment ID. @@ -398,7 +398,7 @@ export namespace pubsub_v1 { /** * This ID can be used to acknowledge the received message. */ - ackId?: string; + ackId?: string | null; /** * The message. */ @@ -411,11 +411,11 @@ export namespace pubsub_v1 { /** * The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is `projects/{project}/snapshots/{snap}`. */ - snapshot?: string; + snapshot?: string | null; /** * The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of `message_retention_duration` and `retain_acked_messages`). For example, if `time` corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored. */ - time?: string; + time?: string | null; } /** * Response for the `Seek` method (this response is empty). @@ -437,19 +437,19 @@ export namespace pubsub_v1 { /** * The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation. */ - expireTime?: string; + expireTime?: string | null; /** * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The name of the snapshot. */ - name?: string; + name?: string | null; /** * The name of the topic from which this snapshot is retaining messages. */ - topic?: string; + topic?: string | null; } /** * A subscription resource. @@ -458,7 +458,7 @@ export namespace pubsub_v1 { /** * The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be <i>outstanding</i>. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. */ - ackDeadlineSeconds?: number; + ackDeadlineSeconds?: number | null; /** * A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. */ @@ -466,15 +466,15 @@ export namespace pubsub_v1 { /** * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. */ - messageRetentionDuration?: string; + messageRetentionDuration?: string | null; /** * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ - name?: string; + name?: string | null; /** * If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. */ @@ -482,11 +482,11 @@ export namespace pubsub_v1 { /** * Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to <a href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> Seek to a timestamp</a>. */ - retainAckedMessages?: boolean; + retainAckedMessages?: boolean | null; /** * The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. */ - topic?: string; + topic?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -495,7 +495,7 @@ export namespace pubsub_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -504,7 +504,7 @@ export namespace pubsub_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A topic resource. @@ -513,11 +513,11 @@ export namespace pubsub_v1 { /** * The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/x/locations/x/keyRings/x/cryptoKeys/x. */ - kmsKeyName?: string; + kmsKeyName?: string | null; /** * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect. */ @@ -525,7 +525,7 @@ export namespace pubsub_v1 { /** * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ - name?: string; + name?: string | null; } /** * Request for the UpdateSnapshot method. @@ -538,7 +538,7 @@ export namespace pubsub_v1 { /** * Indicates which fields in the provided snapshot to update. Must be specified and non-empty. */ - updateMask?: string; + updateMask?: string | null; } /** * Request for the UpdateSubscription method. @@ -551,7 +551,7 @@ export namespace pubsub_v1 { /** * Indicates which fields in the provided subscription to update. Must be specified and non-empty. */ - updateMask?: string; + updateMask?: string | null; } /** * Request for the UpdateTopic method. @@ -564,7 +564,7 @@ export namespace pubsub_v1 { /** * Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The `message_storage_policy` must not be set in the `topic` provided above. */ - updateMask?: string; + updateMask?: string | null; } export class Resource$Projects { diff --git a/src/apis/pubsub/v1beta1a.ts b/src/apis/pubsub/v1beta1a.ts index 290532c8376..762763c6caa 100644 --- a/src/apis/pubsub/v1beta1a.ts +++ b/src/apis/pubsub/v1beta1a.ts @@ -126,11 +126,11 @@ export namespace pubsub_v1beta1a { /** * The acknowledgment ID for the message being acknowledged. This was returned by the Pub/Sub system in the Pull response. */ - ackId?: string[]; + ackId?: string[] | null; /** * The subscription whose message is being acknowledged. */ - subscription?: string; + subscription?: string | null; } /** * An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL @@ -143,15 +143,15 @@ export namespace pubsub_v1beta1a { /** * The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe */ - key?: string; + key?: string | null; /** * An integer value. */ - numValue?: string; + numValue?: string | null; /** * A string value. */ - strValue?: string; + strValue?: string | null; } /** * Response for the ListSubscriptions method. @@ -160,7 +160,7 @@ export namespace pubsub_v1beta1a { /** * If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next <code>ListSubscriptionsRequest</code> to continue. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The subscriptions that match the request. */ @@ -173,7 +173,7 @@ export namespace pubsub_v1beta1a { /** * If not empty, indicates that there are more topics that match the request, and this value should be passed to the next <code>ListTopicsRequest</code> to continue. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The resulting topics. */ @@ -186,19 +186,19 @@ export namespace pubsub_v1beta1a { /** * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request. */ - ackDeadlineSeconds?: number; + ackDeadlineSeconds?: number | null; /** * The acknowledgment ID. Either this or ack_ids must be populated, not both. */ - ackId?: string; + ackId?: string | null; /** * List of acknowledgment IDs. Either this field or ack_id should be populated, not both. */ - ackIds?: string[]; + ackIds?: string[] | null; /** * Next Index: 5 The name of the subscription from which messages are being pulled. */ - subscription?: string; + subscription?: string | null; } /** * Request for the ModifyPushConfig method. @@ -211,7 +211,7 @@ export namespace pubsub_v1beta1a { /** * The name of the subscription. */ - subscription?: string; + subscription?: string | null; } /** * Request for the PublishBatch method. @@ -224,7 +224,7 @@ export namespace pubsub_v1beta1a { /** * The messages in the request will be published on this topic. */ - topic?: string; + topic?: string | null; } /** * Response for the PublishBatch method. @@ -233,7 +233,7 @@ export namespace pubsub_v1beta1a { /** * The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic. */ - messageIds?: string[]; + messageIds?: string[] | null; } /** * Request for the Publish method. @@ -246,7 +246,7 @@ export namespace pubsub_v1beta1a { /** * The message in the request will be published on this topic. */ - topic?: string; + topic?: string | null; } /** * An event indicating a received message or truncation event. @@ -255,7 +255,7 @@ export namespace pubsub_v1beta1a { /** * Indicates that this subscription has been deleted. (Note that pull subscribers will always receive NOT_FOUND in response in their pull request on the subscription, rather than seeing this boolean.) */ - deleted?: boolean; + deleted?: boolean | null; /** * A received message. */ @@ -263,11 +263,11 @@ export namespace pubsub_v1beta1a { /** * The subscription that received the event. */ - subscription?: string; + subscription?: string | null; /** * Indicates that this subscription has been truncated. */ - truncated?: boolean; + truncated?: boolean | null; } /** * A message data and its labels. @@ -276,7 +276,7 @@ export namespace pubsub_v1beta1a { /** * The message payload. */ - data?: string; + data?: string | null; /** * Optional list of labels for this message. Keys in this collection must be unique. */ @@ -284,11 +284,11 @@ export namespace pubsub_v1beta1a { /** * ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call. */ - messageId?: string; + messageId?: string | null; /** * The time at which the message was published. The time is milliseconds since the UNIX epoch. */ - publishTime?: string; + publishTime?: string | null; } /** * Request for the PullBatch method. @@ -297,15 +297,15 @@ export namespace pubsub_v1beta1a { /** * The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return fewer than the number of events specified. */ - maxEvents?: number; + maxEvents?: number | null; /** * If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. */ - returnImmediately?: boolean; + returnImmediately?: boolean | null; /** * The subscription from which messages should be pulled. */ - subscription?: string; + subscription?: string | null; } /** * Response for the PullBatch method. @@ -323,11 +323,11 @@ export namespace pubsub_v1beta1a { /** * If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning FAILED_PRECONDITION. The client may cancel the request if it does not wish to wait any longer for the response. */ - returnImmediately?: boolean; + returnImmediately?: boolean | null; /** * The subscription from which a message should be pulled. */ - subscription?: string; + subscription?: string | null; } /** * Either a <code>PubsubMessage</code> or a truncation event. One of these two must be populated. @@ -336,7 +336,7 @@ export namespace pubsub_v1beta1a { /** * This ID must be used to acknowledge the received event or message. */ - ackId?: string; + ackId?: string | null; /** * A pubsub message or truncation event. */ @@ -349,7 +349,7 @@ export namespace pubsub_v1beta1a { /** * A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". */ - pushEndpoint?: string; + pushEndpoint?: string | null; } /** * A subscription resource. @@ -358,11 +358,11 @@ export namespace pubsub_v1beta1a { /** * For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with <code>ModifyAckDeadline</code>. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis). */ - ackDeadlineSeconds?: number; + ackDeadlineSeconds?: number | null; /** * Name of the subscription. */ - name?: string; + name?: string | null; /** * If push delivery is used with this subscription, this field is used to configure it. */ @@ -370,7 +370,7 @@ export namespace pubsub_v1beta1a { /** * The name of the topic from which this subscription is receiving messages. */ - topic?: string; + topic?: string | null; } /** * A topic resource. @@ -379,7 +379,7 @@ export namespace pubsub_v1beta1a { /** * Name of the topic. */ - name?: string; + name?: string | null; } export class Resource$Subscriptions { diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 9e7c1a7ca12..428b20fb0da 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -124,7 +124,7 @@ export namespace pubsub_v1beta2 { /** * The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. */ - ackIds?: string[]; + ackIds?: string[] | null; } /** * Associates `members` with a `role`. @@ -137,11 +137,11 @@ export namespace pubsub_v1beta2 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -154,19 +154,19 @@ export namespace pubsub_v1beta2 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Response for the `ListSubscriptions` method. @@ -175,7 +175,7 @@ export namespace pubsub_v1beta2 { /** * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The subscriptions that match the request. */ @@ -188,7 +188,7 @@ export namespace pubsub_v1beta2 { /** * If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The resulting topics. */ @@ -201,11 +201,11 @@ export namespace pubsub_v1beta2 { /** * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The names of the subscriptions that match the request. */ - subscriptions?: string[]; + subscriptions?: string[] | null; } /** * Request for the ModifyAckDeadline method. @@ -214,15 +214,15 @@ export namespace pubsub_v1beta2 { /** * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request. */ - ackDeadlineSeconds?: number; + ackDeadlineSeconds?: number | null; /** * The acknowledgment ID. Either this or ack_ids must be populated, but not both. */ - ackId?: string; + ackId?: string | null; /** * List of acknowledgment IDs. */ - ackIds?: string[]; + ackIds?: string[] | null; } /** * Request for the ModifyPushConfig method. @@ -240,11 +240,11 @@ export namespace pubsub_v1beta2 { /** * Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used. */ - audience?: string; + audience?: string | null; /** * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -257,11 +257,11 @@ export namespace pubsub_v1beta2 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request for the Publish method. @@ -279,7 +279,7 @@ export namespace pubsub_v1beta2 { /** * The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic. */ - messageIds?: string[]; + messageIds?: string[] | null; } /** * A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. @@ -288,19 +288,19 @@ export namespace pubsub_v1beta2 { /** * Optional attributes for this message. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648). */ - data?: string; + data?: string | null; /** * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ - messageId?: string; + messageId?: string | null; /** * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ - publishTime?: string; + publishTime?: string | null; } /** * Request for the `Pull` method. @@ -309,11 +309,11 @@ export namespace pubsub_v1beta2 { /** * The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified. */ - maxMessages?: number; + maxMessages?: number | null; /** * If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. */ - returnImmediately?: boolean; + returnImmediately?: boolean | null; } /** * Response for the `Pull` method. @@ -331,7 +331,7 @@ export namespace pubsub_v1beta2 { /** * Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. */ - attributes?: {[key: string]: string}; + attributes?: {[key: string]: string} | null; /** * If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. */ @@ -339,7 +339,7 @@ export namespace pubsub_v1beta2 { /** * A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". */ - pushEndpoint?: string; + pushEndpoint?: string | null; } /** * A message and its corresponding acknowledgment ID. @@ -348,7 +348,7 @@ export namespace pubsub_v1beta2 { /** * This ID can be used to acknowledge the received message. */ - ackId?: string; + ackId?: string | null; /** * The message. */ @@ -370,11 +370,11 @@ export namespace pubsub_v1beta2 { /** * This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used. */ - ackDeadlineSeconds?: number; + ackDeadlineSeconds?: number | null; /** * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ - name?: string; + name?: string | null; /** * If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. */ @@ -382,7 +382,7 @@ export namespace pubsub_v1beta2 { /** * The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted. */ - topic?: string; + topic?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -391,7 +391,7 @@ export namespace pubsub_v1beta2 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -400,7 +400,7 @@ export namespace pubsub_v1beta2 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A topic resource. @@ -409,7 +409,7 @@ export namespace pubsub_v1beta2 { /** * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ - name?: string; + name?: string | null; } export class Resource$Projects { diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index f31674f44cd..5667437336c 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -137,7 +137,7 @@ export namespace redis_v1 { /** * Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. */ - dataProtectionMode?: string; + dataProtectionMode?: string | null; } /** * The Cloud Storage location for the output content @@ -146,7 +146,7 @@ export namespace redis_v1 { /** * Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten. */ - uri?: string; + uri?: string | null; } /** * The Cloud Storage location for the input content @@ -155,7 +155,7 @@ export namespace redis_v1 { /** * Required. Source data URI. (e.g. 'gs://my_bucket/my_object'). */ - uri?: string; + uri?: string | null; } /** * This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the `google.cloud.location.Location.metadata` field. @@ -164,7 +164,9 @@ export namespace redis_v1 { /** * Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. */ - availableZones?: {[key: string]: Schema$GoogleCloudRedisV1ZoneMetadata}; + availableZones?: { + [key: string]: Schema$GoogleCloudRedisV1ZoneMetadata; + } | null; } /** * Represents the v1 metadata of the long-running operation. @@ -173,31 +175,31 @@ export namespace redis_v1 { /** * API version. */ - apiVersion?: string; + apiVersion?: string | null; /** * Specifies if cancellation was requested for the operation. */ - cancelRequested?: boolean; + cancelRequested?: boolean | null; /** * Creation timestamp. */ - createTime?: string; + createTime?: string | null; /** * End timestamp. */ - endTime?: string; + endTime?: string | null; /** * Operation status details. */ - statusDetail?: string; + statusDetail?: string | null; /** * Operation target. */ - target?: string; + target?: string | null; /** * Operation verb. */ - verb?: string; + verb?: string | null; } /** * Defines specific information for a particular zone. Currently empty and reserved for future use only. @@ -228,75 +230,75 @@ export namespace redis_v1 { /** * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id]. */ - alternativeLocationId?: string; + alternativeLocationId?: string | null; /** * Optional. The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. */ - authorizedNetwork?: string; + authorizedNetwork?: string | null; /** * Output only. The time the instance was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event. */ - currentLocationId?: string; + currentLocationId?: string | null; /** * An arbitrary and optional user-provided name for the instance. */ - displayName?: string; + displayName?: string | null; /** * Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. */ - host?: string; + host?: string | null; /** * Resource labels to represent user provided metadata */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id]. */ - locationId?: string; + locationId?: string | null; /** * Required. Redis memory size in GiB. */ - memorySizeGb?: number; + memorySizeGb?: number | null; /** * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ - name?: string; + name?: string | null; /** * Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation. */ - persistenceIamIdentity?: string; + persistenceIamIdentity?: string | null; /** * Output only. The port number of the exposed Redis endpoint. */ - port?: number; + port?: number | null; /** * Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis 3.2 and above: * maxmemory-policy * notify-keyspace-events Redis 4.0 and above: * activedefrag * lfu-log-factor * lfu-decay-time */ - redisConfigs?: {[key: string]: string}; + 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 */ - redisVersion?: string; + redisVersion?: string | null; /** * Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. */ - reservedIpRange?: string; + reservedIpRange?: string | null; /** * Output only. The current state of this instance. */ - state?: string; + state?: string | null; /** * Output only. Additional information about the current status of this instance, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * Required. The service tier of the instance. */ - tier?: string; + tier?: string | null; } /** * Response for ListInstances. @@ -309,11 +311,11 @@ export namespace redis_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -326,7 +328,7 @@ export namespace redis_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -335,7 +337,7 @@ export namespace redis_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -348,23 +350,23 @@ export namespace redis_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Resource ID for the region. For example: "us-east1". */ - locationId?: string; + locationId?: string | null; /** * Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * Full resource name for the region. For example: "projects/example-project/locations/us-east1". */ - name?: string; + name?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -373,7 +375,7 @@ export namespace redis_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -381,15 +383,15 @@ export namespace redis_v1 { /** * { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * The output content @@ -407,15 +409,15 @@ export namespace redis_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 80aaa5ee2cb..7ec9e62cf28 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -137,7 +137,7 @@ export namespace redis_v1beta1 { /** * Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. */ - dataProtectionMode?: string; + dataProtectionMode?: string | null; } /** * The Cloud Storage location for the output content @@ -146,7 +146,7 @@ export namespace redis_v1beta1 { /** * Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten. */ - uri?: string; + uri?: string | null; } /** * The Cloud Storage location for the input content @@ -155,7 +155,7 @@ export namespace redis_v1beta1 { /** * Required. Source data URI. (e.g. 'gs://my_bucket/my_object'). */ - uri?: string; + uri?: string | null; } /** * Represents the metadata of the long-running operation. @@ -164,31 +164,31 @@ export namespace redis_v1beta1 { /** * [Output only] API version used to start the operation. */ - apiVersion?: string; + apiVersion?: string | null; /** * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ - cancelRequested?: boolean; + cancelRequested?: boolean | null; /** * [Output only] The time the operation was created. */ - createTime?: string; + createTime?: string | null; /** * [Output only] The time the operation finished running. */ - endTime?: string; + endTime?: string | null; /** * [Output only] Human-readable status of the operation, if any. */ - statusDetail?: string; + statusDetail?: string | null; /** * [Output only] Server-defined resource path for the target of the operation. */ - target?: string; + target?: string | null; /** * [Output only] Name of the verb executed by the operation. */ - verb?: string; + verb?: string | null; } /** * This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the `google.cloud.location.Location.metadata` field. @@ -199,7 +199,7 @@ export namespace redis_v1beta1 { */ availableZones?: { [key: string]: Schema$GoogleCloudRedisV1beta1ZoneMetadata; - }; + } | null; } /** * Defines specific information for a particular zone. Currently empty and reserved for future use only. @@ -230,75 +230,75 @@ export namespace redis_v1beta1 { /** * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id]. */ - alternativeLocationId?: string; + alternativeLocationId?: string | null; /** * Optional. The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. */ - authorizedNetwork?: string; + authorizedNetwork?: string | null; /** * Output only. The time the instance was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event. */ - currentLocationId?: string; + currentLocationId?: string | null; /** * An arbitrary and optional user-provided name for the instance. */ - displayName?: string; + displayName?: string | null; /** * Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. */ - host?: string; + host?: string | null; /** * Resource labels to represent user provided metadata */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id]. */ - locationId?: string; + locationId?: string | null; /** * Required. Redis memory size in GiB. */ - memorySizeGb?: number; + memorySizeGb?: number | null; /** * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ - name?: string; + name?: string | null; /** * Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation. */ - persistenceIamIdentity?: string; + persistenceIamIdentity?: string | null; /** * Output only. The port number of the exposed Redis endpoint. */ - port?: number; + port?: number | null; /** * Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis 3.2 and above: * maxmemory-policy * notify-keyspace-events Redis 4.0 and above: * activedefrag * lfu-log-factor * lfu-decay-time */ - redisConfigs?: {[key: string]: string}; + 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 */ - redisVersion?: string; + redisVersion?: string | null; /** * Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. */ - reservedIpRange?: string; + reservedIpRange?: string | null; /** * Output only. The current state of this instance. */ - state?: string; + state?: string | null; /** * Output only. Additional information about the current status of this instance, if available. */ - statusMessage?: string; + statusMessage?: string | null; /** * Required. The service tier of the instance. */ - tier?: string; + tier?: string | null; } /** * Response for ListInstances. @@ -311,11 +311,11 @@ export namespace redis_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -328,7 +328,7 @@ export namespace redis_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -337,7 +337,7 @@ export namespace redis_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -350,23 +350,23 @@ export namespace redis_v1beta1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Resource ID for the region. For example: "us-east1". */ - locationId?: string; + locationId?: string | null; /** * Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * Full resource name for the region. For example: "projects/example-project/locations/us-east1". */ - name?: string; + name?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -375,7 +375,7 @@ export namespace redis_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -383,15 +383,15 @@ export namespace redis_v1beta1 { /** * { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * The output content @@ -409,15 +409,15 @@ export namespace redis_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index 9c5f0dd9d04..ab3d76f8f44 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -134,7 +134,7 @@ export namespace remotebuildexecution_v1 { /** * If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged. */ - doNotCache?: boolean; + doNotCache?: boolean | null; /** * The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage. */ @@ -142,7 +142,7 @@ export namespace remotebuildexecution_v1 { /** * A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted. */ - timeout?: string; + timeout?: string | null; } /** * An ActionResult represents the result of an Action being run. @@ -155,7 +155,7 @@ export namespace remotebuildexecution_v1 { /** * The exit code of the command. */ - exitCode?: number; + exitCode?: number | null; /** * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` If an output of the same name was found, but was not a directory, the server will return a FAILED_PRECONDITION. */ @@ -179,7 +179,7 @@ export namespace remotebuildexecution_v1 { /** * The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - stderrRaw?: string; + stderrRaw?: string | null; /** * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. */ @@ -187,7 +187,7 @@ export namespace remotebuildexecution_v1 { /** * The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - stdoutRaw?: string; + stdoutRaw?: string | null; } /** * A `Command` is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. @@ -196,7 +196,7 @@ export namespace remotebuildexecution_v1 { /** * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. */ - arguments?: string[]; + arguments?: string[] | null; /** * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ @@ -204,11 +204,11 @@ export namespace remotebuildexecution_v1 { /** * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ - outputDirectories?: string[]; + outputDirectories?: string[] | null; /** * A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. */ - outputFiles?: string[]; + outputFiles?: string[] | null; /** * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md. */ @@ -216,7 +216,7 @@ export namespace remotebuildexecution_v1 { /** * The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root. */ - workingDirectory?: string; + workingDirectory?: string | null; } /** * An `EnvironmentVariable` is one variable to set in the running program's environment. @@ -225,11 +225,11 @@ export namespace remotebuildexecution_v1 { /** * The variable name. */ - name?: string; + name?: string | null; /** * The variable value. */ - value?: string; + value?: string | null; } /** * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message: * Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. @@ -238,11 +238,11 @@ export namespace remotebuildexecution_v1 { /** * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ - hash?: string; + hash?: string | null; /** * The size of the blob, in bytes. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` @@ -272,7 +272,7 @@ export namespace remotebuildexecution_v1 { /** * The name of the directory. */ - name?: string; + name?: string | null; } /** * ExecutedActionMetadata contains details about a completed execution. @@ -281,43 +281,43 @@ export namespace remotebuildexecution_v1 { /** * When the worker completed executing the action command. */ - executionCompletedTimestamp?: string; + executionCompletedTimestamp?: string | null; /** * When the worker started executing the action command. */ - executionStartTimestamp?: string; + executionStartTimestamp?: string | null; /** * When the worker finished fetching action inputs. */ - inputFetchCompletedTimestamp?: string; + inputFetchCompletedTimestamp?: string | null; /** * When the worker started fetching action inputs. */ - inputFetchStartTimestamp?: string; + inputFetchStartTimestamp?: string | null; /** * When the worker finished uploading action outputs. */ - outputUploadCompletedTimestamp?: string; + outputUploadCompletedTimestamp?: string | null; /** * When the worker started uploading action outputs. */ - outputUploadStartTimestamp?: string; + outputUploadStartTimestamp?: string | null; /** * When was the action added to the queue. */ - queuedTimestamp?: string; + queuedTimestamp?: string | null; /** * The name of the worker which ran the execution. */ - worker?: string; + worker?: string | null; /** * When the worker completed the action, including all stages. */ - workerCompletedTimestamp?: string; + workerCompletedTimestamp?: string | null; /** * When the worker received the action. */ - workerStartTimestamp?: string; + workerStartTimestamp?: string | null; } /** * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. @@ -330,15 +330,15 @@ export namespace remotebuildexecution_v1 { /** * The current stage of execution. */ - stage?: string; + stage?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. */ - stderrStreamName?: string; + stderrStreamName?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard output. */ - stdoutStreamName?: string; + stdoutStreamName?: string | null; } /** * The response message for Execution.Execute, which will be contained in the response field of the Operation. @@ -347,11 +347,11 @@ export namespace remotebuildexecution_v1 { /** * True if the result was served from cache, false if it was executed. */ - cachedResult?: boolean; + cachedResult?: boolean | null; /** * Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly. */ - message?: string; + message?: string | null; /** * The result of the action. */ @@ -359,7 +359,9 @@ export namespace remotebuildexecution_v1 { /** * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ - serverLogs?: {[key: string]: Schema$BuildBazelRemoteExecutionV2LogFile}; + serverLogs?: { + [key: string]: Schema$BuildBazelRemoteExecutionV2LogFile; + } | null; /** * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ @@ -376,11 +378,11 @@ export namespace remotebuildexecution_v1 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * A `LogFile` is a log stored in the CAS. @@ -393,7 +395,7 @@ export namespace remotebuildexecution_v1 { /** * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ - humanReadable?: boolean; + humanReadable?: boolean | null; } /** * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. @@ -402,7 +404,7 @@ export namespace remotebuildexecution_v1 { /** * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ - path?: string; + path?: string | null; /** * The digest of the encoded Tree proto containing the directory's contents. */ @@ -415,7 +417,7 @@ export namespace remotebuildexecution_v1 { /** * The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - contents?: string; + contents?: string | null; /** * The digest of the file's content. */ @@ -423,11 +425,11 @@ export namespace remotebuildexecution_v1 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The full path of the file relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; } /** * An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. @@ -436,11 +438,11 @@ export namespace remotebuildexecution_v1 { /** * The full path of the symlink relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; /** * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ - target?: string; + target?: string | null; } /** * A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform. @@ -458,11 +460,11 @@ export namespace remotebuildexecution_v1 { /** * The property name. */ - name?: string; + name?: string | null; /** * The property value. */ - value?: string; + value?: string | null; } /** * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message. @@ -471,11 +473,11 @@ export namespace remotebuildexecution_v1 { /** * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ - actionId?: string; + actionId?: string | null; /** * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ - correlatedInvocationsId?: string; + correlatedInvocationsId?: string | null; /** * The details for the tool invoking the requests. */ @@ -483,7 +485,7 @@ export namespace remotebuildexecution_v1 { /** * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ - toolInvocationId?: string; + toolInvocationId?: string | null; } /** * A `SymlinkNode` represents a symbolic link. @@ -492,11 +494,11 @@ export namespace remotebuildexecution_v1 { /** * The name of the symlink. */ - name?: string; + name?: string | null; /** * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ - target?: string; + target?: string | null; } /** * Details for the tool used to call the API. @@ -505,11 +507,11 @@ export namespace remotebuildexecution_v1 { /** * Name of the tool, e.g. bazel. */ - toolName?: string; + toolName?: string | null; /** * Version of the tool used for the request, e.g. 5.0.3. */ - toolVersion?: string; + toolVersion?: string | null; } /** * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. @@ -531,7 +533,7 @@ export namespace remotebuildexecution_v1 { /** * Name of the media resource. */ - resourceName?: string; + resourceName?: string | null; } /** * CommandDuration contains the various duration metrics tracked when a bot performs a command. @@ -540,31 +542,31 @@ export namespace remotebuildexecution_v1 { /** * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ - dockerPrep?: string; + dockerPrep?: string | null; /** * The time spent downloading the input files and constructing the working directory. */ - download?: string; + download?: string | null; /** * The time spent executing the command (i.e., doing useful work). */ - execution?: string; + execution?: string | null; /** * The timestamp when preparation is done and bot starts downloading files. */ - isoPrepDone?: string; + isoPrepDone?: string | null; /** * The time spent completing the command, in total. */ - overall?: string; + overall?: string | null; /** * The time spent uploading the stdout logs. */ - stdout?: string; + stdout?: string | null; /** * The time spent uploading the output files. */ - upload?: string; + upload?: string | null; } /** * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. @@ -573,19 +575,19 @@ export namespace remotebuildexecution_v1 { /** * Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command. */ - dockerCacheHit?: boolean; + dockerCacheHit?: boolean | null; /** * The input cache miss ratio. */ - inputCacheMiss?: number; + inputCacheMiss?: number | null; /** * The number of errors reported. */ - numErrors?: string; + numErrors?: string | null; /** * The number of warnings reported. */ - numWarnings?: string; + numWarnings?: string | null; } /** * The internal status of the command result. @@ -594,11 +596,11 @@ export namespace remotebuildexecution_v1 { /** * The status code. */ - code?: string; + code?: string | null; /** * The error message. */ - message?: string; + message?: string | null; } /** * AcceleratorConfig defines the accelerator cards to attach to the VM. @@ -607,11 +609,11 @@ export namespace remotebuildexecution_v1 { /** * The number of the guest accelerator cards exposed to this VM. */ - acceleratorCount?: string; + acceleratorCount?: string | null; /** * The type of accelerator to attach to this VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. */ - acceleratorType?: string; + acceleratorType?: string | null; } /** * The request used for `CreateInstance`. @@ -624,11 +626,11 @@ export namespace remotebuildexecution_v1 { /** * ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ - instanceId?: string; + instanceId?: string | null; /** * Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. */ - parent?: string; + parent?: string | null; } /** * The request used for `CreateWorkerPool`. @@ -637,11 +639,11 @@ export namespace remotebuildexecution_v1 { /** * Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - parent?: string; + parent?: string | null; /** * ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ - poolId?: string; + poolId?: string | null; /** * Specifies the worker pool to create. The name in the worker pool, if specified, is ignored. */ @@ -654,7 +656,7 @@ export namespace remotebuildexecution_v1 { /** * Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for DeleteWorkerPool. @@ -663,7 +665,7 @@ export namespace remotebuildexecution_v1 { /** * Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for `GetInstance`. @@ -672,7 +674,7 @@ export namespace remotebuildexecution_v1 { /** * Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for GetWorkerPool. @@ -681,7 +683,7 @@ export namespace remotebuildexecution_v1 { /** * Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ - name?: string; + name?: string | null; } /** * Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. @@ -690,25 +692,25 @@ export namespace remotebuildexecution_v1 { /** * The location is a GCP region. Currently only `us-central1` is supported. */ - location?: string; + location?: string | null; /** * Output only. Whether stack driver logging is enabled for the instance. */ - loggingEnabled?: boolean; + loggingEnabled?: boolean | null; /** * Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. */ - name?: string; + name?: string | null; /** * Output only. State of the instance. */ - state?: string; + state?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest { /** * Resource name of the project. Format: `projects/[PROJECT_ID]`. */ - parent?: string; + parent?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse { /** @@ -720,11 +722,11 @@ export namespace remotebuildexecution_v1 { /** * Optional. 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. String values are case-insensitive. The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. You can also filter on nested fields. To filter on multiple expressions, you can separate expression using `AND` and `OR` operators, using parentheses to specify precedence. If neither operator is specified, `AND` is assumed. Examples: Include only pools with more than 100 reserved workers: `(worker_count > 100) (worker_config.reserved = true)` Include only pools with a certain label or machines of the n1-standard family: `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard` */ - filter?: string; + filter?: string | null; /** * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - parent?: string; + parent?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse { /** @@ -739,7 +741,7 @@ export namespace remotebuildexecution_v1 { /** * The update mask applies to worker_pool. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ - updateMask?: string; + updateMask?: string | null; /** * Specifies the worker pool to update. */ @@ -756,27 +758,27 @@ export namespace remotebuildexecution_v1 { /** * Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ */ - diskSizeGb?: string; + 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. */ - diskType?: string; + diskType?: string | null; /** * Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ - machineType?: string; + machineType?: string | null; /** * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ - reserved?: boolean; + reserved?: boolean | null; } /** * A worker pool resource in the Remote Build Execution API. @@ -785,11 +787,11 @@ export namespace remotebuildexecution_v1 { /** * WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field. */ - name?: string; + name?: string | null; /** * Output only. State of the worker pool. */ - state?: string; + state?: string | null; /** * Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool. */ @@ -797,7 +799,7 @@ export namespace remotebuildexecution_v1 { /** * The desired number of workers in the worker pool. Must be a value between 0 and 1000. */ - workerCount?: string; + workerCount?: string | null; } /** * An ActionResult represents the result of an Action being run. @@ -806,7 +808,7 @@ export namespace remotebuildexecution_v1 { /** * The exit code of the command. */ - exitCode?: number; + exitCode?: number | null; /** * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ @@ -822,7 +824,7 @@ export namespace remotebuildexecution_v1 { /** * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ - stderrRaw?: string; + stderrRaw?: string | null; /** * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ @@ -830,7 +832,7 @@ export namespace remotebuildexecution_v1 { /** * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ - stdoutRaw?: string; + stdoutRaw?: string | null; } /** * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. @@ -839,7 +841,7 @@ export namespace remotebuildexecution_v1 { /** * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. */ - arguments?: string[]; + arguments?: string[] | null; /** * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ @@ -852,11 +854,11 @@ export namespace remotebuildexecution_v1 { /** * The variable name. */ - name?: string; + name?: string | null; /** * The variable value. */ - value?: string; + value?: string | null; } /** * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. @@ -865,11 +867,11 @@ export namespace remotebuildexecution_v1 { /** * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ - hash?: string; + hash?: string | null; /** * The size of the blob, in bytes. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` @@ -895,7 +897,7 @@ export namespace remotebuildexecution_v1 { /** * The name of the directory. */ - name?: string; + name?: string | null; } /** * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. @@ -905,15 +907,15 @@ export namespace remotebuildexecution_v1 { * The digest of the Action being executed. */ actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - stage?: string; + stage?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. */ - stderrStreamName?: string; + stderrStreamName?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard output. */ - stdoutStreamName?: string; + stdoutStreamName?: string | null; } /** * The response message for Execution.Execute, which will be contained in the response field of the Operation. @@ -922,7 +924,7 @@ export namespace remotebuildexecution_v1 { /** * True if the result was served from cache, false if it was executed. */ - cachedResult?: boolean; + cachedResult?: boolean | null; /** * The result of the action. */ @@ -932,7 +934,7 @@ export namespace remotebuildexecution_v1 { */ serverLogs?: { [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; - }; + } | null; /** * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ @@ -949,11 +951,11 @@ export namespace remotebuildexecution_v1 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * A `LogFile` is a log stored in the CAS. @@ -966,7 +968,7 @@ export namespace remotebuildexecution_v1 { /** * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ - humanReadable?: boolean; + humanReadable?: boolean | null; } /** * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. @@ -979,7 +981,7 @@ export namespace remotebuildexecution_v1 { /** * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ - path?: string; + path?: string | null; /** * The digest of the encoded Tree proto containing the directory's contents. */ @@ -992,7 +994,7 @@ export namespace remotebuildexecution_v1 { /** * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. */ - content?: string; + content?: string | null; /** * The digest of the file's content. */ @@ -1000,11 +1002,11 @@ export namespace remotebuildexecution_v1 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; } /** * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. @@ -1013,11 +1015,11 @@ export namespace remotebuildexecution_v1 { /** * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ - actionId?: string; + actionId?: string | null; /** * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ - correlatedInvocationsId?: string; + correlatedInvocationsId?: string | null; /** * The details for the tool invoking the requests. */ @@ -1025,7 +1027,7 @@ export namespace remotebuildexecution_v1 { /** * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ - toolInvocationId?: string; + toolInvocationId?: string | null; } /** * Details for the tool used to call the API. @@ -1034,11 +1036,11 @@ export namespace remotebuildexecution_v1 { /** * Name of the tool, e.g. bazel. */ - toolName?: string; + toolName?: string | null; /** * Version of the tool used for the request, e.g. 5.0.3. */ - toolVersion?: string; + toolVersion?: string | null; } /** * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. @@ -1060,11 +1062,11 @@ export namespace remotebuildexecution_v1 { /** * The argument to the admin action; see `Command` for semantics. */ - arg?: string; + arg?: string | null; /** * The admin action; see `Command` for legal values. */ - command?: string; + command?: string | null; } /** * Describes a blob of binary content with its digest. @@ -1073,7 +1075,7 @@ export namespace remotebuildexecution_v1 { /** * The contents of the blob. */ - contents?: string; + contents?: string | null; /** * The digest of the blob. This should be verified by the receiver. */ @@ -1086,7 +1088,7 @@ export namespace remotebuildexecution_v1 { /** * exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK. */ - exitCode?: number; + exitCode?: number | null; /** * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ @@ -1099,11 +1101,11 @@ export namespace remotebuildexecution_v1 { /** * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ - duration?: string; + duration?: string | null; /** * The amount of time *not* spent executing the command (ie uploading/downloading files). */ - overhead?: string; + overhead?: string | null; } /** * All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field. @@ -1112,15 +1114,15 @@ export namespace remotebuildexecution_v1 { /** * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ - duration?: string; + duration?: string | null; /** * The exit code of the process. An exit code of "0" should only be trusted if `status` has a code of OK (otherwise it may simply be unset). */ - exitCode?: number; + exitCode?: number | null; /** * Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about. */ - metadata?: Array<{[key: string]: any}>; + metadata?: Array<{[key: string]: any}> | null; /** * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ @@ -1128,7 +1130,7 @@ export namespace remotebuildexecution_v1 { /** * The amount of time *not* spent executing the command (ie uploading/downloading files). */ - overhead?: string; + overhead?: string | null; /** * An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. */ @@ -1158,7 +1160,7 @@ export namespace remotebuildexecution_v1 { /** * The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be "C:\Windows\System32\ping.exe" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpretted by both the service and the bot. */ - arguments?: string[]; + arguments?: string[] | null; /** * All environment variables required by the task. */ @@ -1174,7 +1176,7 @@ export namespace remotebuildexecution_v1 { /** * Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., "./"). If it is non-empty, then it must exist under "./". Otherwise, "./" will be used. */ - workingDirectory?: string; + workingDirectory?: string | null; } /** * An environment variable required by this task. @@ -1183,11 +1185,11 @@ export namespace remotebuildexecution_v1 { /** * The envvar name. */ - name?: string; + name?: string | null; /** * The envvar value. */ - value?: string; + value?: string | null; } /** * Describes the expected outputs of the command. @@ -1196,19 +1198,19 @@ export namespace remotebuildexecution_v1 { /** * A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes. */ - directories?: string[]; + directories?: string[] | null; /** * A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes. */ - files?: string[]; + files?: string[] | null; /** * The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ - stderrDestination?: string; + stderrDestination?: string | null; /** * The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ - stdoutDestination?: string; + stdoutDestination?: string | null; } /** * Describes the timeouts associated with this task. @@ -1217,15 +1219,15 @@ export namespace remotebuildexecution_v1 { /** * This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this. */ - execution?: string; + execution?: string | null; /** * This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task. */ - idle?: string; + idle?: string | null; /** * If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). */ - shutdown?: string; + shutdown?: string | null; } /** * The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message. @@ -1234,11 +1236,11 @@ export namespace remotebuildexecution_v1 { /** * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). */ - hash?: string; + hash?: string | null; /** * The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * The contents of a directory. Similar to the equivalent message in the Remote Execution API. @@ -1264,7 +1266,7 @@ export namespace remotebuildexecution_v1 { /** * The path of the directory, as in FileMetadata.path. */ - path?: string; + path?: string | null; } /** * The metadata for a file. Similar to the equivalent message in the Remote Execution API. @@ -1273,7 +1275,7 @@ export namespace remotebuildexecution_v1 { /** * If the file is small enough, its contents may also or alternatively be listed here. */ - contents?: string; + contents?: string | null; /** * A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here. */ @@ -1281,11 +1283,11 @@ export namespace remotebuildexecution_v1 { /** * Properties of the file */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes. */ - path?: string; + path?: string | null; } /** * The request message for Operations.CancelOperation. @@ -1298,7 +1300,7 @@ export namespace remotebuildexecution_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -1311,7 +1313,7 @@ export namespace remotebuildexecution_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1319,15 +1321,15 @@ export namespace remotebuildexecution_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -1340,15 +1342,15 @@ export namespace remotebuildexecution_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A Change indicates the most recent state of an element. @@ -1357,23 +1359,23 @@ export namespace remotebuildexecution_v1 { /** * If true, this Change is followed by more Changes that are in the same group as this Change. */ - continued?: boolean; + continued?: boolean | null; /** * The actual change data. This field is present only when `state() == EXISTS` or `state() == ERROR`. Please see google.protobuf.Any about how to use the Any type. */ - data?: {[key: string]: any}; + data?: {[key: string]: any} | null; /** * Name of the element, interpreted relative to the entity's actual name. "" refers to the entity itself. The element name is a valid UTF-8 string. */ - element?: string; + element?: string | null; /** * If present, provides a compact representation of all the messages that have been received by the caller for the given entity, e.g., it could be a sequence number or a multi-part timestamp/version vector. This marker can be provided in the Request message, allowing the caller to resume the stream watching at a specific point without fetching the initial state. */ - resumeMarker?: string; + resumeMarker?: string | null; /** * The state of the `element`. */ - state?: string; + state?: string | null; } /** * A batch of Change messages. diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index fb038dfe91d..b6097a04634 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -128,7 +128,7 @@ export namespace remotebuildexecution_v1alpha { /** * If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged. */ - doNotCache?: boolean; + doNotCache?: boolean | null; /** * The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage. */ @@ -136,7 +136,7 @@ export namespace remotebuildexecution_v1alpha { /** * A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted. */ - timeout?: string; + timeout?: string | null; } /** * An ActionResult represents the result of an Action being run. @@ -149,7 +149,7 @@ export namespace remotebuildexecution_v1alpha { /** * The exit code of the command. */ - exitCode?: number; + exitCode?: number | null; /** * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` If an output of the same name was found, but was not a directory, the server will return a FAILED_PRECONDITION. */ @@ -173,7 +173,7 @@ export namespace remotebuildexecution_v1alpha { /** * The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - stderrRaw?: string; + stderrRaw?: string | null; /** * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. */ @@ -181,7 +181,7 @@ export namespace remotebuildexecution_v1alpha { /** * The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - stdoutRaw?: string; + stdoutRaw?: string | null; } /** * A `Command` is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. @@ -190,7 +190,7 @@ export namespace remotebuildexecution_v1alpha { /** * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. */ - arguments?: string[]; + arguments?: string[] | null; /** * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ @@ -198,11 +198,11 @@ export namespace remotebuildexecution_v1alpha { /** * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ - outputDirectories?: string[]; + outputDirectories?: string[] | null; /** * A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. */ - outputFiles?: string[]; + outputFiles?: string[] | null; /** * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md. */ @@ -210,7 +210,7 @@ export namespace remotebuildexecution_v1alpha { /** * The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root. */ - workingDirectory?: string; + workingDirectory?: string | null; } /** * An `EnvironmentVariable` is one variable to set in the running program's environment. @@ -219,11 +219,11 @@ export namespace remotebuildexecution_v1alpha { /** * The variable name. */ - name?: string; + name?: string | null; /** * The variable value. */ - value?: string; + value?: string | null; } /** * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message: * Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. @@ -232,11 +232,11 @@ export namespace remotebuildexecution_v1alpha { /** * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ - hash?: string; + hash?: string | null; /** * The size of the blob, in bytes. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` @@ -266,7 +266,7 @@ export namespace remotebuildexecution_v1alpha { /** * The name of the directory. */ - name?: string; + name?: string | null; } /** * ExecutedActionMetadata contains details about a completed execution. @@ -275,43 +275,43 @@ export namespace remotebuildexecution_v1alpha { /** * When the worker completed executing the action command. */ - executionCompletedTimestamp?: string; + executionCompletedTimestamp?: string | null; /** * When the worker started executing the action command. */ - executionStartTimestamp?: string; + executionStartTimestamp?: string | null; /** * When the worker finished fetching action inputs. */ - inputFetchCompletedTimestamp?: string; + inputFetchCompletedTimestamp?: string | null; /** * When the worker started fetching action inputs. */ - inputFetchStartTimestamp?: string; + inputFetchStartTimestamp?: string | null; /** * When the worker finished uploading action outputs. */ - outputUploadCompletedTimestamp?: string; + outputUploadCompletedTimestamp?: string | null; /** * When the worker started uploading action outputs. */ - outputUploadStartTimestamp?: string; + outputUploadStartTimestamp?: string | null; /** * When was the action added to the queue. */ - queuedTimestamp?: string; + queuedTimestamp?: string | null; /** * The name of the worker which ran the execution. */ - worker?: string; + worker?: string | null; /** * When the worker completed the action, including all stages. */ - workerCompletedTimestamp?: string; + workerCompletedTimestamp?: string | null; /** * When the worker received the action. */ - workerStartTimestamp?: string; + workerStartTimestamp?: string | null; } /** * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. @@ -324,15 +324,15 @@ export namespace remotebuildexecution_v1alpha { /** * The current stage of execution. */ - stage?: string; + stage?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. */ - stderrStreamName?: string; + stderrStreamName?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard output. */ - stdoutStreamName?: string; + stdoutStreamName?: string | null; } /** * The response message for Execution.Execute, which will be contained in the response field of the Operation. @@ -341,11 +341,11 @@ export namespace remotebuildexecution_v1alpha { /** * True if the result was served from cache, false if it was executed. */ - cachedResult?: boolean; + cachedResult?: boolean | null; /** * Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly. */ - message?: string; + message?: string | null; /** * The result of the action. */ @@ -353,7 +353,9 @@ export namespace remotebuildexecution_v1alpha { /** * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ - serverLogs?: {[key: string]: Schema$BuildBazelRemoteExecutionV2LogFile}; + serverLogs?: { + [key: string]: Schema$BuildBazelRemoteExecutionV2LogFile; + } | null; /** * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ @@ -370,11 +372,11 @@ export namespace remotebuildexecution_v1alpha { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * A `LogFile` is a log stored in the CAS. @@ -387,7 +389,7 @@ export namespace remotebuildexecution_v1alpha { /** * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ - humanReadable?: boolean; + humanReadable?: boolean | null; } /** * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. @@ -396,7 +398,7 @@ export namespace remotebuildexecution_v1alpha { /** * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ - path?: string; + path?: string | null; /** * The digest of the encoded Tree proto containing the directory's contents. */ @@ -409,7 +411,7 @@ export namespace remotebuildexecution_v1alpha { /** * The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - contents?: string; + contents?: string | null; /** * The digest of the file's content. */ @@ -417,11 +419,11 @@ export namespace remotebuildexecution_v1alpha { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The full path of the file relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; } /** * An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. @@ -430,11 +432,11 @@ export namespace remotebuildexecution_v1alpha { /** * The full path of the symlink relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; /** * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ - target?: string; + target?: string | null; } /** * A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform. @@ -452,11 +454,11 @@ export namespace remotebuildexecution_v1alpha { /** * The property name. */ - name?: string; + name?: string | null; /** * The property value. */ - value?: string; + value?: string | null; } /** * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message. @@ -465,11 +467,11 @@ export namespace remotebuildexecution_v1alpha { /** * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ - actionId?: string; + actionId?: string | null; /** * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ - correlatedInvocationsId?: string; + correlatedInvocationsId?: string | null; /** * The details for the tool invoking the requests. */ @@ -477,7 +479,7 @@ export namespace remotebuildexecution_v1alpha { /** * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ - toolInvocationId?: string; + toolInvocationId?: string | null; } /** * A `SymlinkNode` represents a symbolic link. @@ -486,11 +488,11 @@ export namespace remotebuildexecution_v1alpha { /** * The name of the symlink. */ - name?: string; + name?: string | null; /** * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ - target?: string; + target?: string | null; } /** * Details for the tool used to call the API. @@ -499,11 +501,11 @@ export namespace remotebuildexecution_v1alpha { /** * Name of the tool, e.g. bazel. */ - toolName?: string; + toolName?: string | null; /** * Version of the tool used for the request, e.g. 5.0.3. */ - toolVersion?: string; + toolVersion?: string | null; } /** * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. @@ -525,31 +527,31 @@ export namespace remotebuildexecution_v1alpha { /** * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ - dockerPrep?: string; + dockerPrep?: string | null; /** * The time spent downloading the input files and constructing the working directory. */ - download?: string; + download?: string | null; /** * The time spent executing the command (i.e., doing useful work). */ - execution?: string; + execution?: string | null; /** * The timestamp when preparation is done and bot starts downloading files. */ - isoPrepDone?: string; + isoPrepDone?: string | null; /** * The time spent completing the command, in total. */ - overall?: string; + overall?: string | null; /** * The time spent uploading the stdout logs. */ - stdout?: string; + stdout?: string | null; /** * The time spent uploading the output files. */ - upload?: string; + upload?: string | null; } /** * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. @@ -558,19 +560,19 @@ export namespace remotebuildexecution_v1alpha { /** * Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command. */ - dockerCacheHit?: boolean; + dockerCacheHit?: boolean | null; /** * The input cache miss ratio. */ - inputCacheMiss?: number; + inputCacheMiss?: number | null; /** * The number of errors reported. */ - numErrors?: string; + numErrors?: string | null; /** * The number of warnings reported. */ - numWarnings?: string; + numWarnings?: string | null; } /** * The internal status of the command result. @@ -579,11 +581,11 @@ export namespace remotebuildexecution_v1alpha { /** * The status code. */ - code?: string; + code?: string | null; /** * The error message. */ - message?: string; + message?: string | null; } /** * AcceleratorConfig defines the accelerator cards to attach to the VM. @@ -592,11 +594,11 @@ export namespace remotebuildexecution_v1alpha { /** * The number of the guest accelerator cards exposed to this VM. */ - acceleratorCount?: string; + acceleratorCount?: string | null; /** * The type of accelerator to attach to this VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. */ - acceleratorType?: string; + acceleratorType?: string | null; } /** * The request used for `CreateInstance`. @@ -609,11 +611,11 @@ export namespace remotebuildexecution_v1alpha { /** * ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ - instanceId?: string; + instanceId?: string | null; /** * Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. */ - parent?: string; + parent?: string | null; } /** * The request used for `CreateWorkerPool`. @@ -622,11 +624,11 @@ export namespace remotebuildexecution_v1alpha { /** * Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - parent?: string; + parent?: string | null; /** * ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ - poolId?: string; + poolId?: string | null; /** * Specifies the worker pool to create. The name in the worker pool, if specified, is ignored. */ @@ -639,7 +641,7 @@ export namespace remotebuildexecution_v1alpha { /** * Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for DeleteWorkerPool. @@ -648,7 +650,7 @@ export namespace remotebuildexecution_v1alpha { /** * Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for `GetInstance`. @@ -657,7 +659,7 @@ export namespace remotebuildexecution_v1alpha { /** * Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for GetWorkerPool. @@ -666,7 +668,7 @@ export namespace remotebuildexecution_v1alpha { /** * Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ - name?: string; + name?: string | null; } /** * Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. @@ -675,25 +677,25 @@ export namespace remotebuildexecution_v1alpha { /** * The location is a GCP region. Currently only `us-central1` is supported. */ - location?: string; + location?: string | null; /** * Output only. Whether stack driver logging is enabled for the instance. */ - loggingEnabled?: boolean; + loggingEnabled?: boolean | null; /** * Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. */ - name?: string; + name?: string | null; /** * Output only. State of the instance. */ - state?: string; + state?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest { /** * Resource name of the project. Format: `projects/[PROJECT_ID]`. */ - parent?: string; + parent?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse { /** @@ -705,11 +707,11 @@ export namespace remotebuildexecution_v1alpha { /** * Optional. 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. String values are case-insensitive. The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. You can also filter on nested fields. To filter on multiple expressions, you can separate expression using `AND` and `OR` operators, using parentheses to specify precedence. If neither operator is specified, `AND` is assumed. Examples: Include only pools with more than 100 reserved workers: `(worker_count > 100) (worker_config.reserved = true)` Include only pools with a certain label or machines of the n1-standard family: `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard` */ - filter?: string; + filter?: string | null; /** * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - parent?: string; + parent?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse { /** @@ -724,7 +726,7 @@ export namespace remotebuildexecution_v1alpha { /** * The update mask applies to worker_pool. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ - updateMask?: string; + updateMask?: string | null; /** * Specifies the worker pool to update. */ @@ -741,27 +743,27 @@ export namespace remotebuildexecution_v1alpha { /** * Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ */ - diskSizeGb?: string; + 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. */ - diskType?: string; + diskType?: string | null; /** * Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ - machineType?: string; + machineType?: string | null; /** * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ - reserved?: boolean; + reserved?: boolean | null; } /** * A worker pool resource in the Remote Build Execution API. @@ -770,11 +772,11 @@ export namespace remotebuildexecution_v1alpha { /** * WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field. */ - name?: string; + name?: string | null; /** * Output only. State of the worker pool. */ - state?: string; + state?: string | null; /** * Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool. */ @@ -782,7 +784,7 @@ export namespace remotebuildexecution_v1alpha { /** * The desired number of workers in the worker pool. Must be a value between 0 and 1000. */ - workerCount?: string; + workerCount?: string | null; } /** * An ActionResult represents the result of an Action being run. @@ -791,7 +793,7 @@ export namespace remotebuildexecution_v1alpha { /** * The exit code of the command. */ - exitCode?: number; + exitCode?: number | null; /** * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ @@ -807,7 +809,7 @@ export namespace remotebuildexecution_v1alpha { /** * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ - stderrRaw?: string; + stderrRaw?: string | null; /** * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ @@ -815,7 +817,7 @@ export namespace remotebuildexecution_v1alpha { /** * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ - stdoutRaw?: string; + stdoutRaw?: string | null; } /** * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. @@ -824,7 +826,7 @@ export namespace remotebuildexecution_v1alpha { /** * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. */ - arguments?: string[]; + arguments?: string[] | null; /** * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ @@ -837,11 +839,11 @@ export namespace remotebuildexecution_v1alpha { /** * The variable name. */ - name?: string; + name?: string | null; /** * The variable value. */ - value?: string; + value?: string | null; } /** * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. @@ -850,11 +852,11 @@ export namespace remotebuildexecution_v1alpha { /** * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ - hash?: string; + hash?: string | null; /** * The size of the blob, in bytes. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` @@ -880,7 +882,7 @@ export namespace remotebuildexecution_v1alpha { /** * The name of the directory. */ - name?: string; + name?: string | null; } /** * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. @@ -890,15 +892,15 @@ export namespace remotebuildexecution_v1alpha { * The digest of the Action being executed. */ actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - stage?: string; + stage?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. */ - stderrStreamName?: string; + stderrStreamName?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard output. */ - stdoutStreamName?: string; + stdoutStreamName?: string | null; } /** * The response message for Execution.Execute, which will be contained in the response field of the Operation. @@ -907,7 +909,7 @@ export namespace remotebuildexecution_v1alpha { /** * True if the result was served from cache, false if it was executed. */ - cachedResult?: boolean; + cachedResult?: boolean | null; /** * The result of the action. */ @@ -917,7 +919,7 @@ export namespace remotebuildexecution_v1alpha { */ serverLogs?: { [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; - }; + } | null; /** * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ @@ -934,11 +936,11 @@ export namespace remotebuildexecution_v1alpha { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * A `LogFile` is a log stored in the CAS. @@ -951,7 +953,7 @@ export namespace remotebuildexecution_v1alpha { /** * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ - humanReadable?: boolean; + humanReadable?: boolean | null; } /** * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. @@ -964,7 +966,7 @@ export namespace remotebuildexecution_v1alpha { /** * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ - path?: string; + path?: string | null; /** * The digest of the encoded Tree proto containing the directory's contents. */ @@ -977,7 +979,7 @@ export namespace remotebuildexecution_v1alpha { /** * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. */ - content?: string; + content?: string | null; /** * The digest of the file's content. */ @@ -985,11 +987,11 @@ export namespace remotebuildexecution_v1alpha { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; } /** * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. @@ -998,11 +1000,11 @@ export namespace remotebuildexecution_v1alpha { /** * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ - actionId?: string; + actionId?: string | null; /** * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ - correlatedInvocationsId?: string; + correlatedInvocationsId?: string | null; /** * The details for the tool invoking the requests. */ @@ -1010,7 +1012,7 @@ export namespace remotebuildexecution_v1alpha { /** * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ - toolInvocationId?: string; + toolInvocationId?: string | null; } /** * Details for the tool used to call the API. @@ -1019,11 +1021,11 @@ export namespace remotebuildexecution_v1alpha { /** * Name of the tool, e.g. bazel. */ - toolName?: string; + toolName?: string | null; /** * Version of the tool used for the request, e.g. 5.0.3. */ - toolVersion?: string; + toolVersion?: string | null; } /** * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. @@ -1045,11 +1047,11 @@ export namespace remotebuildexecution_v1alpha { /** * The argument to the admin action; see `Command` for semantics. */ - arg?: string; + arg?: string | null; /** * The admin action; see `Command` for legal values. */ - command?: string; + command?: string | null; } /** * Describes a blob of binary content with its digest. @@ -1058,7 +1060,7 @@ export namespace remotebuildexecution_v1alpha { /** * The contents of the blob. */ - contents?: string; + contents?: string | null; /** * The digest of the blob. This should be verified by the receiver. */ @@ -1071,7 +1073,7 @@ export namespace remotebuildexecution_v1alpha { /** * exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK. */ - exitCode?: number; + exitCode?: number | null; /** * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ @@ -1084,11 +1086,11 @@ export namespace remotebuildexecution_v1alpha { /** * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ - duration?: string; + duration?: string | null; /** * The amount of time *not* spent executing the command (ie uploading/downloading files). */ - overhead?: string; + overhead?: string | null; } /** * All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field. @@ -1097,15 +1099,15 @@ export namespace remotebuildexecution_v1alpha { /** * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ - duration?: string; + duration?: string | null; /** * The exit code of the process. An exit code of "0" should only be trusted if `status` has a code of OK (otherwise it may simply be unset). */ - exitCode?: number; + exitCode?: number | null; /** * Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about. */ - metadata?: Array<{[key: string]: any}>; + metadata?: Array<{[key: string]: any}> | null; /** * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ @@ -1113,7 +1115,7 @@ export namespace remotebuildexecution_v1alpha { /** * The amount of time *not* spent executing the command (ie uploading/downloading files). */ - overhead?: string; + overhead?: string | null; /** * An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. */ @@ -1143,7 +1145,7 @@ export namespace remotebuildexecution_v1alpha { /** * The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be "C:\Windows\System32\ping.exe" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpretted by both the service and the bot. */ - arguments?: string[]; + arguments?: string[] | null; /** * All environment variables required by the task. */ @@ -1159,7 +1161,7 @@ export namespace remotebuildexecution_v1alpha { /** * Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., "./"). If it is non-empty, then it must exist under "./". Otherwise, "./" will be used. */ - workingDirectory?: string; + workingDirectory?: string | null; } /** * An environment variable required by this task. @@ -1168,11 +1170,11 @@ export namespace remotebuildexecution_v1alpha { /** * The envvar name. */ - name?: string; + name?: string | null; /** * The envvar value. */ - value?: string; + value?: string | null; } /** * Describes the expected outputs of the command. @@ -1181,19 +1183,19 @@ export namespace remotebuildexecution_v1alpha { /** * A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes. */ - directories?: string[]; + directories?: string[] | null; /** * A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes. */ - files?: string[]; + files?: string[] | null; /** * The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ - stderrDestination?: string; + stderrDestination?: string | null; /** * The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ - stdoutDestination?: string; + stdoutDestination?: string | null; } /** * Describes the timeouts associated with this task. @@ -1202,15 +1204,15 @@ export namespace remotebuildexecution_v1alpha { /** * This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this. */ - execution?: string; + execution?: string | null; /** * This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task. */ - idle?: string; + idle?: string | null; /** * If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). */ - shutdown?: string; + shutdown?: string | null; } /** * The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message. @@ -1219,11 +1221,11 @@ export namespace remotebuildexecution_v1alpha { /** * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). */ - hash?: string; + hash?: string | null; /** * The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * The contents of a directory. Similar to the equivalent message in the Remote Execution API. @@ -1249,7 +1251,7 @@ export namespace remotebuildexecution_v1alpha { /** * The path of the directory, as in FileMetadata.path. */ - path?: string; + path?: string | null; } /** * The metadata for a file. Similar to the equivalent message in the Remote Execution API. @@ -1258,7 +1260,7 @@ export namespace remotebuildexecution_v1alpha { /** * If the file is small enough, its contents may also or alternatively be listed here. */ - contents?: string; + contents?: string | null; /** * A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here. */ @@ -1266,11 +1268,11 @@ export namespace remotebuildexecution_v1alpha { /** * Properties of the file */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes. */ - path?: string; + path?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1279,7 +1281,7 @@ export namespace remotebuildexecution_v1alpha { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1287,15 +1289,15 @@ export namespace remotebuildexecution_v1alpha { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -1304,15 +1306,15 @@ export namespace remotebuildexecution_v1alpha { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Projects { diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index a0f35211307..eb855718a12 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -136,7 +136,7 @@ export namespace remotebuildexecution_v2 { /** * If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged. */ - doNotCache?: boolean; + doNotCache?: boolean | null; /** * The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage. */ @@ -144,13 +144,13 @@ export namespace remotebuildexecution_v2 { /** * A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted. */ - timeout?: string; + timeout?: string | null; } /** * Describes the server/instance capabilities for updating the action cache. */ export interface Schema$BuildBazelRemoteExecutionV2ActionCacheUpdateCapabilities { - updateEnabled?: boolean; + updateEnabled?: boolean | null; } /** * An ActionResult represents the result of an Action being run. @@ -163,7 +163,7 @@ export namespace remotebuildexecution_v2 { /** * The exit code of the command. */ - exitCode?: number; + exitCode?: number | null; /** * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` If an output of the same name was found, but was not a directory, the server will return a FAILED_PRECONDITION. */ @@ -187,7 +187,7 @@ export namespace remotebuildexecution_v2 { /** * The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - stderrRaw?: string; + stderrRaw?: string | null; /** * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. */ @@ -195,7 +195,7 @@ export namespace remotebuildexecution_v2 { /** * The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - stdoutRaw?: string; + stdoutRaw?: string | null; } /** * A request message for ContentAddressableStorage.BatchReadBlobs. @@ -222,7 +222,7 @@ export namespace remotebuildexecution_v2 { /** * The raw binary data. */ - data?: string; + data?: string | null; /** * The digest to which this response corresponds. */ @@ -248,7 +248,7 @@ export namespace remotebuildexecution_v2 { /** * The raw binary data. */ - data?: string; + data?: string | null; /** * The digest of the blob. This MUST be the digest of `data`. */ @@ -291,15 +291,15 @@ export namespace remotebuildexecution_v2 { /** * All the digest functions supported by the remote cache. Remote cache may support multiple digest functions simultaneously. */ - digestFunction?: string[]; + digestFunction?: string[] | null; /** * Maximum total size of blobs to be uploaded/downloaded using batch methods. A value of 0 means no limit is set, although in practice there will always be a message size limitation of the protocol in use, e.g. GRPC. */ - maxBatchTotalSizeBytes?: string; + maxBatchTotalSizeBytes?: string | null; /** * Whether absolute symlink targets are supported. */ - symlinkAbsolutePathStrategy?: string; + symlinkAbsolutePathStrategy?: string | null; } /** * A `Command` is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. @@ -308,7 +308,7 @@ export namespace remotebuildexecution_v2 { /** * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. */ - arguments?: string[]; + arguments?: string[] | null; /** * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ @@ -316,11 +316,11 @@ export namespace remotebuildexecution_v2 { /** * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ - outputDirectories?: string[]; + outputDirectories?: string[] | null; /** * A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. */ - outputFiles?: string[]; + outputFiles?: string[] | null; /** * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md. */ @@ -328,7 +328,7 @@ export namespace remotebuildexecution_v2 { /** * The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root. */ - workingDirectory?: string; + workingDirectory?: string | null; } /** * An `EnvironmentVariable` is one variable to set in the running program's environment. @@ -337,11 +337,11 @@ export namespace remotebuildexecution_v2 { /** * The variable name. */ - name?: string; + name?: string | null; /** * The variable value. */ - value?: string; + value?: string | null; } /** * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message: * Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. @@ -350,11 +350,11 @@ export namespace remotebuildexecution_v2 { /** * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ - hash?: string; + hash?: string | null; /** * The size of the blob, in bytes. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` @@ -384,7 +384,7 @@ export namespace remotebuildexecution_v2 { /** * The name of the directory. */ - name?: string; + name?: string | null; } /** * ExecutedActionMetadata contains details about a completed execution. @@ -393,43 +393,43 @@ export namespace remotebuildexecution_v2 { /** * When the worker completed executing the action command. */ - executionCompletedTimestamp?: string; + executionCompletedTimestamp?: string | null; /** * When the worker started executing the action command. */ - executionStartTimestamp?: string; + executionStartTimestamp?: string | null; /** * When the worker finished fetching action inputs. */ - inputFetchCompletedTimestamp?: string; + inputFetchCompletedTimestamp?: string | null; /** * When the worker started fetching action inputs. */ - inputFetchStartTimestamp?: string; + inputFetchStartTimestamp?: string | null; /** * When the worker finished uploading action outputs. */ - outputUploadCompletedTimestamp?: string; + outputUploadCompletedTimestamp?: string | null; /** * When the worker started uploading action outputs. */ - outputUploadStartTimestamp?: string; + outputUploadStartTimestamp?: string | null; /** * When was the action added to the queue. */ - queuedTimestamp?: string; + queuedTimestamp?: string | null; /** * The name of the worker which ran the execution. */ - worker?: string; + worker?: string | null; /** * When the worker completed the action, including all stages. */ - workerCompletedTimestamp?: string; + workerCompletedTimestamp?: string | null; /** * When the worker received the action. */ - workerStartTimestamp?: string; + workerStartTimestamp?: string | null; } /** * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. @@ -442,15 +442,15 @@ export namespace remotebuildexecution_v2 { /** * The current stage of execution. */ - stage?: string; + stage?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. */ - stderrStreamName?: string; + stderrStreamName?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard output. */ - stdoutStreamName?: string; + stdoutStreamName?: string | null; } /** * A request message for Execution.Execute. @@ -471,7 +471,7 @@ export namespace remotebuildexecution_v2 { /** * If true, the action will be executed even if its result is already present in the ActionCache. The execution is still allowed to be merged with other in-flight executions of the same action, however - semantically, the service MUST only guarantee that the results of an execution with this field set were not visible before the corresponding execution request was sent. Note that actions from execution requests setting this field set are still eligible to be entered into the action cache upon completion, and services SHOULD overwrite any existing entries that may exist. This allows skip_cache_lookup requests to be used as a mechanism for replacing action cache entries that reference outputs no longer available or that are poisoned in any way. If false, the result may be served from the action cache. */ - skipCacheLookup?: boolean; + skipCacheLookup?: boolean | null; } /** * The response message for Execution.Execute, which will be contained in the response field of the Operation. @@ -480,11 +480,11 @@ export namespace remotebuildexecution_v2 { /** * True if the result was served from cache, false if it was executed. */ - cachedResult?: boolean; + cachedResult?: boolean | null; /** * Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly. */ - message?: string; + message?: string | null; /** * The result of the action. */ @@ -492,7 +492,9 @@ export namespace remotebuildexecution_v2 { /** * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ - serverLogs?: {[key: string]: Schema$BuildBazelRemoteExecutionV2LogFile}; + serverLogs?: { + [key: string]: Schema$BuildBazelRemoteExecutionV2LogFile; + } | null; /** * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ @@ -505,11 +507,11 @@ export namespace remotebuildexecution_v2 { /** * Remote execution may only support a single digest function. */ - digestFunction?: string; + digestFunction?: string | null; /** * Whether remote execution is enabled for the particular server/instance. */ - execEnabled?: boolean; + execEnabled?: boolean | null; /** * Supported execution priority range. */ @@ -522,7 +524,7 @@ export namespace remotebuildexecution_v2 { /** * The priority (relative importance) of this action. Generally, a lower value means that the action should be run sooner than actions having a greater priority value, but the interpretation of a given value is server- dependent. A priority of 0 means the *default* priority. Priorities may be positive or negative, and such actions should run later or sooner than actions having the default priority, respectively. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into scheduling policy. */ - priority?: number; + priority?: number | null; } /** * A `FileNode` represents a single file and associated metadata. @@ -535,11 +537,11 @@ export namespace remotebuildexecution_v2 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * A request message for ContentAddressableStorage.FindMissingBlobs. @@ -570,7 +572,7 @@ export namespace remotebuildexecution_v2 { /** * If present, signifies that there are more results which the client can retrieve by passing this as the page_token in a subsequent request. If empty, signifies that this is the last page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A `LogFile` is a log stored in the CAS. @@ -583,7 +585,7 @@ export namespace remotebuildexecution_v2 { /** * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ - humanReadable?: boolean; + humanReadable?: boolean | null; } /** * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. @@ -592,7 +594,7 @@ export namespace remotebuildexecution_v2 { /** * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ - path?: string; + path?: string | null; /** * The digest of the encoded Tree proto containing the directory's contents. */ @@ -605,7 +607,7 @@ export namespace remotebuildexecution_v2 { /** * The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ - contents?: string; + contents?: string | null; /** * The digest of the file's content. */ @@ -613,11 +615,11 @@ export namespace remotebuildexecution_v2 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The full path of the file relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; } /** * An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. @@ -626,11 +628,11 @@ export namespace remotebuildexecution_v2 { /** * The full path of the symlink relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; /** * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ - target?: string; + target?: string | null; } /** * A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform. @@ -648,11 +650,11 @@ export namespace remotebuildexecution_v2 { /** * The property name. */ - name?: string; + name?: string | null; /** * The property value. */ - value?: string; + value?: string | null; } /** * Allowed values for priority in ResultsCachePolicy Used for querying both cache and execution valid priority ranges. @@ -664,8 +666,8 @@ export namespace remotebuildexecution_v2 { * Supported range of priorities, including boundaries. */ export interface Schema$BuildBazelRemoteExecutionV2PriorityCapabilitiesPriorityRange { - maxPriority?: number; - minPriority?: number; + maxPriority?: number | null; + minPriority?: number | null; } /** * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message. @@ -674,11 +676,11 @@ export namespace remotebuildexecution_v2 { /** * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ - actionId?: string; + actionId?: string | null; /** * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ - correlatedInvocationsId?: string; + correlatedInvocationsId?: string | null; /** * The details for the tool invoking the requests. */ @@ -686,7 +688,7 @@ export namespace remotebuildexecution_v2 { /** * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ - toolInvocationId?: string; + toolInvocationId?: string | null; } /** * A `ResultsCachePolicy` is used for fine-grained control over how action outputs are stored in the CAS and Action Cache. @@ -695,7 +697,7 @@ export namespace remotebuildexecution_v2 { /** * The priority (relative importance) of this content in the overall cache. Generally, a lower value means a longer retention time or other advantage, but the interpretation of a given value is server-dependent. A priority of 0 means a *default* value, decided by the server. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into retention/eviction policy. */ - priority?: number; + priority?: number | null; } /** * A response message for Capabilities.GetCapabilities. @@ -729,11 +731,11 @@ export namespace remotebuildexecution_v2 { /** * The name of the symlink. */ - name?: string; + name?: string | null; /** * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ - target?: string; + target?: string | null; } /** * Details for the tool used to call the API. @@ -742,11 +744,11 @@ export namespace remotebuildexecution_v2 { /** * Name of the tool, e.g. bazel. */ - toolName?: string; + toolName?: string | null; /** * Version of the tool used for the request, e.g. 5.0.3. */ - toolVersion?: string; + toolVersion?: string | null; } /** * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. @@ -772,19 +774,19 @@ export namespace remotebuildexecution_v2 { /** * The major version, e.g 10 for 10.2.3. */ - major?: number; + major?: number | null; /** * The minor version, e.g. 2 for 10.2.3. */ - minor?: number; + minor?: number | null; /** * The patch version, e.g 3 for 10.2.3. */ - patch?: number; + patch?: number | null; /** * The pre-release version. Either this field or major/minor/patch fields must be filled. They are mutually exclusive. Pre-release versions are assumed to be earlier than any released versions. */ - prerelease?: string; + prerelease?: string | null; } /** * CommandDuration contains the various duration metrics tracked when a bot performs a command. @@ -793,31 +795,31 @@ export namespace remotebuildexecution_v2 { /** * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ - dockerPrep?: string; + dockerPrep?: string | null; /** * The time spent downloading the input files and constructing the working directory. */ - download?: string; + download?: string | null; /** * The time spent executing the command (i.e., doing useful work). */ - execution?: string; + execution?: string | null; /** * The timestamp when preparation is done and bot starts downloading files. */ - isoPrepDone?: string; + isoPrepDone?: string | null; /** * The time spent completing the command, in total. */ - overall?: string; + overall?: string | null; /** * The time spent uploading the stdout logs. */ - stdout?: string; + stdout?: string | null; /** * The time spent uploading the output files. */ - upload?: string; + upload?: string | null; } /** * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. @@ -826,19 +828,19 @@ export namespace remotebuildexecution_v2 { /** * Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command. */ - dockerCacheHit?: boolean; + dockerCacheHit?: boolean | null; /** * The input cache miss ratio. */ - inputCacheMiss?: number; + inputCacheMiss?: number | null; /** * The number of errors reported. */ - numErrors?: string; + numErrors?: string | null; /** * The number of warnings reported. */ - numWarnings?: string; + numWarnings?: string | null; } /** * The internal status of the command result. @@ -847,11 +849,11 @@ export namespace remotebuildexecution_v2 { /** * The status code. */ - code?: string; + code?: string | null; /** * The error message. */ - message?: string; + message?: string | null; } /** * AcceleratorConfig defines the accelerator cards to attach to the VM. @@ -860,11 +862,11 @@ export namespace remotebuildexecution_v2 { /** * The number of the guest accelerator cards exposed to this VM. */ - acceleratorCount?: string; + acceleratorCount?: string | null; /** * The type of accelerator to attach to this VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. */ - acceleratorType?: string; + acceleratorType?: string | null; } /** * The request used for `CreateInstance`. @@ -877,11 +879,11 @@ export namespace remotebuildexecution_v2 { /** * ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ - instanceId?: string; + instanceId?: string | null; /** * Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. */ - parent?: string; + parent?: string | null; } /** * The request used for `CreateWorkerPool`. @@ -890,11 +892,11 @@ export namespace remotebuildexecution_v2 { /** * Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - parent?: string; + parent?: string | null; /** * ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ - poolId?: string; + poolId?: string | null; /** * Specifies the worker pool to create. The name in the worker pool, if specified, is ignored. */ @@ -907,7 +909,7 @@ export namespace remotebuildexecution_v2 { /** * Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for DeleteWorkerPool. @@ -916,7 +918,7 @@ export namespace remotebuildexecution_v2 { /** * Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for `GetInstance`. @@ -925,7 +927,7 @@ export namespace remotebuildexecution_v2 { /** * Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - name?: string; + name?: string | null; } /** * The request used for GetWorkerPool. @@ -934,7 +936,7 @@ export namespace remotebuildexecution_v2 { /** * Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ - name?: string; + name?: string | null; } /** * Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. @@ -943,25 +945,25 @@ export namespace remotebuildexecution_v2 { /** * The location is a GCP region. Currently only `us-central1` is supported. */ - location?: string; + location?: string | null; /** * Output only. Whether stack driver logging is enabled for the instance. */ - loggingEnabled?: boolean; + loggingEnabled?: boolean | null; /** * Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. */ - name?: string; + name?: string | null; /** * Output only. State of the instance. */ - state?: string; + state?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest { /** * Resource name of the project. Format: `projects/[PROJECT_ID]`. */ - parent?: string; + parent?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse { /** @@ -973,11 +975,11 @@ export namespace remotebuildexecution_v2 { /** * Optional. 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. String values are case-insensitive. The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. You can also filter on nested fields. To filter on multiple expressions, you can separate expression using `AND` and `OR` operators, using parentheses to specify precedence. If neither operator is specified, `AND` is assumed. Examples: Include only pools with more than 100 reserved workers: `(worker_count > 100) (worker_config.reserved = true)` Include only pools with a certain label or machines of the n1-standard family: `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard` */ - filter?: string; + filter?: string | null; /** * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ - parent?: string; + parent?: string | null; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse { /** @@ -992,7 +994,7 @@ export namespace remotebuildexecution_v2 { /** * The update mask applies to worker_pool. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ - updateMask?: string; + updateMask?: string | null; /** * Specifies the worker pool to update. */ @@ -1009,27 +1011,27 @@ export namespace remotebuildexecution_v2 { /** * Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ */ - diskSizeGb?: string; + 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. */ - diskType?: string; + diskType?: string | null; /** * Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ - machineType?: string; + machineType?: string | null; /** * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ - minCpuPlatform?: string; + minCpuPlatform?: string | null; /** * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ - reserved?: boolean; + reserved?: boolean | null; } /** * A worker pool resource in the Remote Build Execution API. @@ -1038,11 +1040,11 @@ export namespace remotebuildexecution_v2 { /** * WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field. */ - name?: string; + name?: string | null; /** * Output only. State of the worker pool. */ - state?: string; + state?: string | null; /** * Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool. */ @@ -1050,7 +1052,7 @@ export namespace remotebuildexecution_v2 { /** * The desired number of workers in the worker pool. Must be a value between 0 and 1000. */ - workerCount?: string; + workerCount?: string | null; } /** * An ActionResult represents the result of an Action being run. @@ -1059,7 +1061,7 @@ export namespace remotebuildexecution_v2 { /** * The exit code of the command. */ - exitCode?: number; + exitCode?: number | null; /** * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ @@ -1075,7 +1077,7 @@ export namespace remotebuildexecution_v2 { /** * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ - stderrRaw?: string; + stderrRaw?: string | null; /** * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ @@ -1083,7 +1085,7 @@ export namespace remotebuildexecution_v2 { /** * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ - stdoutRaw?: string; + stdoutRaw?: string | null; } /** * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. @@ -1092,7 +1094,7 @@ export namespace remotebuildexecution_v2 { /** * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. */ - arguments?: string[]; + arguments?: string[] | null; /** * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ @@ -1105,11 +1107,11 @@ export namespace remotebuildexecution_v2 { /** * The variable name. */ - name?: string; + name?: string | null; /** * The variable value. */ - value?: string; + value?: string | null; } /** * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. @@ -1118,11 +1120,11 @@ export namespace remotebuildexecution_v2 { /** * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ - hash?: string; + hash?: string | null; /** * The size of the blob, in bytes. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` @@ -1148,7 +1150,7 @@ export namespace remotebuildexecution_v2 { /** * The name of the directory. */ - name?: string; + name?: string | null; } /** * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. @@ -1158,15 +1160,15 @@ export namespace remotebuildexecution_v2 { * The digest of the Action being executed. */ actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - stage?: string; + stage?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. */ - stderrStreamName?: string; + stderrStreamName?: string | null; /** * If set, the client can use this name with ByteStream.Read to stream the standard output. */ - stdoutStreamName?: string; + stdoutStreamName?: string | null; } /** * The response message for Execution.Execute, which will be contained in the response field of the Operation. @@ -1175,7 +1177,7 @@ export namespace remotebuildexecution_v2 { /** * True if the result was served from cache, false if it was executed. */ - cachedResult?: boolean; + cachedResult?: boolean | null; /** * The result of the action. */ @@ -1185,7 +1187,7 @@ export namespace remotebuildexecution_v2 { */ serverLogs?: { [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; - }; + } | null; /** * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ @@ -1202,11 +1204,11 @@ export namespace remotebuildexecution_v2 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The name of the file. */ - name?: string; + name?: string | null; } /** * A `LogFile` is a log stored in the CAS. @@ -1219,7 +1221,7 @@ export namespace remotebuildexecution_v2 { /** * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ - humanReadable?: boolean; + humanReadable?: boolean | null; } /** * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. @@ -1232,7 +1234,7 @@ export namespace remotebuildexecution_v2 { /** * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ - path?: string; + path?: string | null; /** * The digest of the encoded Tree proto containing the directory's contents. */ @@ -1245,7 +1247,7 @@ export namespace remotebuildexecution_v2 { /** * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. */ - content?: string; + content?: string | null; /** * The digest of the file's content. */ @@ -1253,11 +1255,11 @@ export namespace remotebuildexecution_v2 { /** * True if file is executable, false otherwise. */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ - path?: string; + path?: string | null; } /** * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. @@ -1266,11 +1268,11 @@ export namespace remotebuildexecution_v2 { /** * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ - actionId?: string; + actionId?: string | null; /** * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ - correlatedInvocationsId?: string; + correlatedInvocationsId?: string | null; /** * The details for the tool invoking the requests. */ @@ -1278,7 +1280,7 @@ export namespace remotebuildexecution_v2 { /** * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ - toolInvocationId?: string; + toolInvocationId?: string | null; } /** * Details for the tool used to call the API. @@ -1287,11 +1289,11 @@ export namespace remotebuildexecution_v2 { /** * Name of the tool, e.g. bazel. */ - toolName?: string; + toolName?: string | null; /** * Version of the tool used for the request, e.g. 5.0.3. */ - toolVersion?: string; + toolVersion?: string | null; } /** * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. @@ -1313,11 +1315,11 @@ export namespace remotebuildexecution_v2 { /** * The argument to the admin action; see `Command` for semantics. */ - arg?: string; + arg?: string | null; /** * The admin action; see `Command` for legal values. */ - command?: string; + command?: string | null; } /** * Describes a blob of binary content with its digest. @@ -1326,7 +1328,7 @@ export namespace remotebuildexecution_v2 { /** * The contents of the blob. */ - contents?: string; + contents?: string | null; /** * The digest of the blob. This should be verified by the receiver. */ @@ -1339,7 +1341,7 @@ export namespace remotebuildexecution_v2 { /** * exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK. */ - exitCode?: number; + exitCode?: number | null; /** * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ @@ -1352,11 +1354,11 @@ export namespace remotebuildexecution_v2 { /** * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ - duration?: string; + duration?: string | null; /** * The amount of time *not* spent executing the command (ie uploading/downloading files). */ - overhead?: string; + overhead?: string | null; } /** * All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field. @@ -1365,15 +1367,15 @@ export namespace remotebuildexecution_v2 { /** * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ - duration?: string; + duration?: string | null; /** * The exit code of the process. An exit code of "0" should only be trusted if `status` has a code of OK (otherwise it may simply be unset). */ - exitCode?: number; + exitCode?: number | null; /** * Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about. */ - metadata?: Array<{[key: string]: any}>; + metadata?: Array<{[key: string]: any}> | null; /** * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ @@ -1381,7 +1383,7 @@ export namespace remotebuildexecution_v2 { /** * The amount of time *not* spent executing the command (ie uploading/downloading files). */ - overhead?: string; + overhead?: string | null; /** * An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. */ @@ -1411,7 +1413,7 @@ export namespace remotebuildexecution_v2 { /** * The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be "C:\Windows\System32\ping.exe" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpretted by both the service and the bot. */ - arguments?: string[]; + arguments?: string[] | null; /** * All environment variables required by the task. */ @@ -1427,7 +1429,7 @@ export namespace remotebuildexecution_v2 { /** * Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., "./"). If it is non-empty, then it must exist under "./". Otherwise, "./" will be used. */ - workingDirectory?: string; + workingDirectory?: string | null; } /** * An environment variable required by this task. @@ -1436,11 +1438,11 @@ export namespace remotebuildexecution_v2 { /** * The envvar name. */ - name?: string; + name?: string | null; /** * The envvar value. */ - value?: string; + value?: string | null; } /** * Describes the expected outputs of the command. @@ -1449,19 +1451,19 @@ export namespace remotebuildexecution_v2 { /** * A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes. */ - directories?: string[]; + directories?: string[] | null; /** * A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes. */ - files?: string[]; + files?: string[] | null; /** * The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ - stderrDestination?: string; + stderrDestination?: string | null; /** * The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ - stdoutDestination?: string; + stdoutDestination?: string | null; } /** * Describes the timeouts associated with this task. @@ -1470,15 +1472,15 @@ export namespace remotebuildexecution_v2 { /** * This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this. */ - execution?: string; + execution?: string | null; /** * This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task. */ - idle?: string; + idle?: string | null; /** * If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). */ - shutdown?: string; + shutdown?: string | null; } /** * The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message. @@ -1487,11 +1489,11 @@ export namespace remotebuildexecution_v2 { /** * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). */ - hash?: string; + hash?: string | null; /** * The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason. */ - sizeBytes?: string; + sizeBytes?: string | null; } /** * The contents of a directory. Similar to the equivalent message in the Remote Execution API. @@ -1517,7 +1519,7 @@ export namespace remotebuildexecution_v2 { /** * The path of the directory, as in FileMetadata.path. */ - path?: string; + path?: string | null; } /** * The metadata for a file. Similar to the equivalent message in the Remote Execution API. @@ -1526,7 +1528,7 @@ export namespace remotebuildexecution_v2 { /** * If the file is small enough, its contents may also or alternatively be listed here. */ - contents?: string; + contents?: string | null; /** * A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here. */ @@ -1534,11 +1536,11 @@ export namespace remotebuildexecution_v2 { /** * Properties of the file */ - isExecutable?: boolean; + isExecutable?: boolean | null; /** * The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes. */ - path?: string; + path?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1547,7 +1549,7 @@ export namespace remotebuildexecution_v2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1555,15 +1557,15 @@ export namespace remotebuildexecution_v2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -1572,15 +1574,15 @@ export namespace remotebuildexecution_v2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Actionresults { diff --git a/src/apis/replicapool/v1beta1.ts b/src/apis/replicapool/v1beta1.ts index 4d51cef1330..8e4468eb720 100644 --- a/src/apis/replicapool/v1beta1.ts +++ b/src/apis/replicapool/v1beta1.ts @@ -110,15 +110,15 @@ export namespace replicapool_v1beta1 { /** * Name of this access configuration. */ - name?: string; + name?: string | null; /** * An external IP address associated with this instance. */ - natIp?: string; + natIp?: string | null; /** * Type of this access configuration file. Currently only ONE_TO_ONE_NAT is supported. */ - type?: string; + type?: string | null; } /** * An action that gets executed during initialization of the replicas. @@ -127,7 +127,7 @@ export namespace replicapool_v1beta1 { /** * A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure. */ - commands?: string[]; + commands?: string[] | null; /** * A list of environment variables to use for the commands in this action. */ @@ -135,7 +135,7 @@ export namespace replicapool_v1beta1 { /** * If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds). */ - timeoutMilliSeconds?: number; + timeoutMilliSeconds?: number | null; } /** * Specifies how to attach a disk to a Replica. @@ -144,11 +144,11 @@ export namespace replicapool_v1beta1 { /** * The device name of this disk. */ - deviceName?: string; + deviceName?: string | null; /** * A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server. */ - index?: number; + index?: number | null; } /** * An environment variable to set for an action. @@ -157,15 +157,15 @@ export namespace replicapool_v1beta1 { /** * Deprecated, do not use. */ - hidden?: boolean; + hidden?: boolean | null; /** * The name of the environment variable. */ - name?: string; + name?: string | null; /** * The value of the variable. */ - value?: string; + value?: string | null; } /** * A pre-existing persistent disk that will be attached to every Replica in the Pool in READ_ONLY mode. @@ -178,45 +178,45 @@ export namespace replicapool_v1beta1 { /** * The name of the Persistent Disk resource. The Persistent Disk resource must be in the same zone as the Pool. */ - source?: string; + source?: string | null; } export interface Schema$HealthCheck { /** * How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds. */ - checkIntervalSec?: number; + checkIntervalSec?: number | null; /** * The description for this health check. */ - description?: string; + description?: string | null; /** * The number of consecutive health check requests that need to succeed before the replica is considered healthy again. The default value is 2. */ - healthyThreshold?: number; + healthyThreshold?: number | null; /** * The value of the host header in the HTTP health check request. If left empty (default value), the localhost IP 127.0.0.1 will be used. */ - host?: string; + host?: string | null; /** * The name of this health check. */ - name?: string; + name?: string | null; /** * The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck. */ - path?: string; + path?: string | null; /** * The TCP port for the health check requests. */ - port?: number; + port?: number | null; /** * How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds. */ - timeoutSec?: number; + timeoutSec?: number | null; /** * The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2. */ - unhealthyThreshold?: number; + unhealthyThreshold?: number | null; } /** * A label to apply to this replica pool. @@ -225,11 +225,11 @@ export namespace replicapool_v1beta1 { /** * The key for this label. */ - key?: string; + key?: string | null; /** * The value of this label. */ - value?: string; + value?: string | null; } /** * A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. @@ -238,7 +238,7 @@ export namespace replicapool_v1beta1 { /** * The fingerprint of the metadata. Required for updating the metadata entries for this instance. */ - fingerPrint?: string; + fingerPrint?: string | null; /** * A list of metadata items. */ @@ -251,11 +251,11 @@ export namespace replicapool_v1beta1 { /** * A metadata key. */ - key?: string; + key?: string | null; /** * A metadata value. */ - value?: string; + value?: string | null; } /** * A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource. @@ -268,11 +268,11 @@ export namespace replicapool_v1beta1 { /** * Name the Network resource to which this interface applies. */ - network?: string; + network?: string | null; /** * An optional IPV4 internal network address to assign to the instance for this network interface. */ - networkIp?: string; + networkIp?: string | null; } /** * A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode. @@ -285,11 +285,11 @@ export namespace replicapool_v1beta1 { /** * If true, then this disk will be deleted when the instance is deleted. The default value is true. */ - autoDelete?: boolean; + autoDelete?: boolean | null; /** * If true, indicates that this is the root persistent disk. */ - boot?: boolean; + boot?: boolean | null; /** * Create the new disk using these parameters. The name of the disk will be <instance_name>-<four_random_charactersgt;. */ @@ -302,33 +302,33 @@ export namespace replicapool_v1beta1 { /** * The size of the created disk in gigabytes. */ - diskSizeGb?: string; + diskSizeGb?: string | null; /** * Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard' */ - diskType?: string; + diskType?: string | null; /** * The name or fully-qualified URL of a source image to use to create this disk. If you provide a name of the source image, Replica Pool will look for an image with that name in your project. If you are specifying an image provided by Compute Engine, you will need to provide the full URL with the correct project, such as: http://www.googleapis.com/compute/v1/projects/debian-cloud/ global/images/debian-wheezy-7-vYYYYMMDD */ - sourceImage?: string; + sourceImage?: string | null; } export interface Schema$Pool { /** * Whether replicas in this pool should be restarted if they experience a failure. The default value is true. */ - autoRestart?: boolean; + autoRestart?: boolean | null; /** * The base instance name to use for the replicas in this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances in this replica pool will be named in the format <base-instance-name>-<ID>. The <ID> postfix will be a four character alphanumeric identifier generated by the service. If this is not specified by the user, a random base instance name is generated by the service. */ - baseInstanceName?: string; + baseInstanceName?: string | null; /** * [Output Only] The current number of replicas in the pool. */ - currentNumReplicas?: number; + currentNumReplicas?: number | null; /** * An optional description of the replica pool. */ - description?: string; + description?: string | null; /** * Deprecated. Please use template[].healthChecks instead. */ @@ -336,7 +336,7 @@ export namespace replicapool_v1beta1 { /** * The initial number of replicas this pool should have. You must provide a value greater than or equal to 0. */ - initialNumReplicas?: number; + initialNumReplicas?: number | null; /** * A list of labels to attach to this replica pool and all created virtual machines in this replica pool. */ @@ -344,27 +344,27 @@ export namespace replicapool_v1beta1 { /** * The name of the replica pool. Must follow the regex [a-z]([-a-z0-9]*[a-z0-9])? and be 1-28 characters long. */ - name?: string; + name?: string | null; /** * Deprecated! Use initial_num_replicas instead. */ - numReplicas?: number; + numReplicas?: number | null; /** * The list of resource views that should be updated with all the replicas that are managed by this pool. */ - resourceViews?: string[]; + resourceViews?: string[] | null; /** * [Output Only] A self-link to the replica pool. */ - selfLink?: string; + selfLink?: string | null; /** * Deprecated, please use target_pools instead. */ - targetPool?: string; + targetPool?: string | null; /** * A list of target pools to update with the replicas that are managed by this pool. If specified, the replicas in this replica pool will be added to the specified target pools for load balancing purposes. The replica pool must live in the same region as the specified target pools. These values must be the target pool resource names, and not fully qualified URLs. */ - targetPools?: string[]; + targetPools?: string[] | null; /** * The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts. */ @@ -372,16 +372,16 @@ export namespace replicapool_v1beta1 { /** * Deprecated! Do not set. */ - type?: string; + type?: string | null; } export interface Schema$PoolsDeleteRequest { /** * If there are instances you would like to keep, you can specify them here. These instances won't be deleted, but the associated replica objects will be removed. */ - abandonInstances?: string[]; + abandonInstances?: string[] | null; } export interface Schema$PoolsListResponse { - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Pool[]; } /** @@ -391,11 +391,11 @@ export namespace replicapool_v1beta1 { /** * [Output Only] The name of the Replica object. */ - name?: string; + name?: string | null; /** * [Output Only] The self-link of the Replica. */ - selfLink?: string; + selfLink?: string | null; /** * [Output Only] Last known status of the Replica. */ @@ -405,10 +405,10 @@ export namespace replicapool_v1beta1 { /** * Whether the instance resource represented by this replica should be deleted or abandoned. If abandoned, the replica will be deleted but the virtual machine instance will remain. By default, this is set to false and the instance will be deleted along with the replica. */ - abandonInstance?: boolean; + abandonInstance?: boolean | null; } export interface Schema$ReplicasListResponse { - nextPageToken?: string; + nextPageToken?: string | null; resources?: Schema$Replica[]; } /** @@ -418,23 +418,23 @@ export namespace replicapool_v1beta1 { /** * [Output Only] Human-readable details about the current state of the replica */ - details?: string; + details?: string | null; /** * [Output Only] The state of the Replica. */ - state?: string; + state?: string | null; /** * [Output Only] The template used to build the replica. */ - templateVersion?: string; + templateVersion?: string | null; /** * [Output Only] Link to the virtual machine that this Replica represents. */ - vmLink?: string; + vmLink?: string | null; /** * [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned. */ - vmStartTime?: string; + vmStartTime?: string | null; } /** * A Compute Engine service account, identical to the Compute Engine resource. @@ -443,11 +443,11 @@ export namespace replicapool_v1beta1 { /** * The service account email address, for example: 123845678986@project.gserviceaccount.com */ - email?: string; + email?: string | null; /** * The list of OAuth2 scopes to obtain for the service account, for example: https://www.googleapis.com/auth/devstorage.full_control */ - scopes?: string[]; + scopes?: string[] | null; } /** * A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. @@ -456,11 +456,11 @@ export namespace replicapool_v1beta1 { /** * The fingerprint of the tag. Required for updating the list of tags. */ - fingerPrint?: string; + fingerPrint?: string | null; /** * Items contained in this tag. */ - items?: string[]; + items?: string[] | null; } /** * The template used for creating replicas in the pool. @@ -477,7 +477,7 @@ export namespace replicapool_v1beta1 { /** * A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1. */ - version?: string; + version?: string | null; /** * The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM. */ @@ -490,15 +490,15 @@ export namespace replicapool_v1beta1 { /** * Deprecated. Please use baseInstanceName instead. */ - baseInstanceName?: string; + baseInstanceName?: string | null; /** * Enables IP Forwarding, which allows this instance to receive packets destined for a different IP address, and send packets with a different source IP. See IP Forwarding for more information. */ - canIpForward?: boolean; + canIpForward?: boolean | null; /** * An optional textual description of the instance. */ - description?: string; + description?: string | null; /** * A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica. */ @@ -510,7 +510,7 @@ export namespace replicapool_v1beta1 { /** * The machine type for this instance. The resource name (e.g. n1-standard-1). */ - machineType?: string; + machineType?: string | null; /** * The metadata key/value pairs assigned to this instance. */ @@ -519,7 +519,7 @@ export namespace replicapool_v1beta1 { * A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine, ONE_TO_ONE_NAT. */ networkInterfaces?: Schema$NetworkInterface[]; - onHostMaintenance?: string; + onHostMaintenance?: string | null; /** * A list of Service Accounts to enable for this instance. */ diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index c42f6d38ccc..c07e56fdc09 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -112,43 +112,43 @@ export namespace reseller_v1 { /** * A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. */ - addressLine1?: string; + addressLine1?: string | null; /** * Line 2 of the address. */ - addressLine2?: string; + addressLine2?: string | null; /** * Line 3 of the address. */ - addressLine3?: string; + addressLine3?: string | null; /** * The customer contact's name. This is required. */ - contactName?: string; + contactName?: string | null; /** * For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer. */ - countryCode?: string; + countryCode?: string | null; /** * Identifies the resource as a customer address. Value: customers#address */ - kind?: string; + kind?: string | null; /** * An example of a locality value is the city of San Francisco. */ - locality?: string; + locality?: string | null; /** * The company or company division name. This is required. */ - organizationName?: string; + organizationName?: string | null; /** * A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. */ - postalCode?: string; + postalCode?: string | null; /** * An example of a region value is CA for the state of California. */ - region?: string; + region?: string | null; } /** * JSON template for the ChangePlan rpc request. @@ -157,19 +157,19 @@ export namespace reseller_v1 { /** * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in changePlan request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply. */ - dealCode?: string; + dealCode?: string | null; /** * Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest */ - kind?: string; + kind?: string | null; /** * The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan */ - planName?: string; + planName?: string | null; /** * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. */ - purchaseOrderId?: string; + purchaseOrderId?: string | null; /** * This is a required property. The seats property is the number of user seat licenses. */ @@ -182,27 +182,27 @@ export namespace reseller_v1 { /** * Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain. */ - alternateEmail?: string; + alternateEmail?: string | null; /** * The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer. */ - customerDomain?: string; + customerDomain?: string | null; /** * Whether the customer's primary domain has been verified. */ - customerDomainVerified?: boolean; + customerDomainVerified?: boolean | null; /** * This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google. */ - customerId?: string; + customerId?: string | null; /** * Identifies the resource as a customer. Value: reseller#customer */ - kind?: string; + kind?: string | null; /** * Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid. */ - phoneNumber?: string; + phoneNumber?: string | null; /** * A customer's address information. Each field has a limit of 255 charcters. */ @@ -210,7 +210,7 @@ export namespace reseller_v1 { /** * URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console. */ - resourceUiUrl?: string; + resourceUiUrl?: string | null; } /** * JSON template for a subscription renewal settings. @@ -219,11 +219,11 @@ export namespace reseller_v1 { /** * Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings */ - kind?: string; + kind?: string | null; /** * Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property. */ - renewalType?: string; + renewalType?: string | null; } /** * JSON template for resellernotify getwatchdetails response. @@ -232,11 +232,11 @@ export namespace reseller_v1 { /** * List of registered service accounts. */ - serviceAccountEmailAddresses?: string[]; + serviceAccountEmailAddresses?: string[] | null; /** * Topic name of the PubSub */ - topicName?: string; + topicName?: string | null; } /** * JSON template for resellernotify response. @@ -245,7 +245,7 @@ export namespace reseller_v1 { /** * Topic name of the PubSub */ - topicName?: string; + topicName?: string | null; } /** * JSON template for subscription seats. @@ -254,19 +254,19 @@ export namespace reseller_v1 { /** * Identifies the resource as a subscription seat setting. Value: subscriptions#seats */ - kind?: string; + kind?: string | null; /** * Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku */ - licensedNumberOfSeats?: number; + licensedNumberOfSeats?: number | null; /** * This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user. */ - maximumNumberOfSeats?: number; + maximumNumberOfSeats?: number | null; /** * This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user. */ - numberOfSeats?: number; + numberOfSeats?: number | null; } /** * JSON template for a subscription. @@ -275,27 +275,27 @@ export namespace reseller_v1 { /** * Read-only field that returns the current billing method for a subscription. */ - billingMethod?: string; + billingMethod?: string | null; /** * The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter. */ - creationTime?: string; + creationTime?: string | null; /** * Primary domain name of the customer */ - customerDomain?: string; + customerDomain?: string | null; /** * This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google. */ - customerId?: string; + customerId?: string | null; /** * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty. */ - dealCode?: string; + dealCode?: string | null; /** * Identifies the resource as a Subscription. Value: reseller#subscription */ - kind?: string; + kind?: string | null; /** * The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts. */ @@ -303,11 +303,11 @@ export namespace reseller_v1 { commitmentInterval?: {endTime?: string; startTime?: string}; isCommitmentPlan?: boolean; planName?: string; - }; + } | null; /** * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. */ - purchaseOrderId?: string; + purchaseOrderId?: string | null; /** * Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. */ @@ -315,7 +315,7 @@ export namespace reseller_v1 { /** * URL to customer's Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console. */ - resourceUiUrl?: string; + resourceUiUrl?: string | null; /** * This is a required property. The number and limit of user seat licenses in the plan. */ @@ -323,34 +323,34 @@ export namespace reseller_v1 { /** * A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs. */ - skuId?: string; + skuId?: string | null; /** * Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs. */ - skuName?: string; + skuName?: string | null; /** * This is an optional property. */ - status?: string; + status?: string | null; /** * The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions. */ - subscriptionId?: string; + subscriptionId?: string | null; /** * Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. - RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED - The customer's trial expired without a plan selected. - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). */ - suspensionReasons?: string[]; + suspensionReasons?: string[] | null; /** * Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer. */ transferInfo?: { minimumTransferableSeats?: number; transferabilityExpirationTime?: string; - }; + } | null; /** * The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts. */ - trialSettings?: {isInTrial?: boolean; trialEndTime?: string}; + trialSettings?: {isInTrial?: boolean; trialEndTime?: string} | null; } /** * JSON template for a subscription list. @@ -359,11 +359,11 @@ export namespace reseller_v1 { /** * Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The subscriptions in this page of results. */ diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 73ad00c5091..4f2cd464050 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -128,7 +128,7 @@ export namespace run_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -137,23 +137,23 @@ export namespace run_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } export class Resource$Projects { diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index f5e6fc848d4..a136a0b9ce6 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -126,8 +126,8 @@ export namespace run_v1alpha1 { /** * Deprecated - use url instead. */ - hostname?: string; - url?: string; + hostname?: string | null; + url?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -140,7 +140,7 @@ export namespace run_v1alpha1 { /** * 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; + 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. @@ -149,11 +149,11 @@ export namespace run_v1alpha1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via [Webmaster Central](https://www.google.com/webmasters/verification/home). @@ -162,11 +162,11 @@ export namespace run_v1alpha1 { /** * Relative name of the domain authorized for use. Example: `example.com`. */ - id?: string; + id?: string | null; /** * Read only. Full path to the `AuthorizedDomain` resource in the API. Example: `apps/myapp/authorizedDomains/example.com`. */ - name?: string; + name?: string | null; } /** * Associates `members` with a `role`. @@ -179,11 +179,11 @@ export namespace run_v1alpha1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Adds and removes POSIX capabilities from running containers. @@ -192,11 +192,11 @@ export namespace run_v1alpha1 { /** * Added capabilities +optional */ - add?: string[]; + add?: string[] | null; /** * Removed capabilities +optional */ - drop?: string[]; + drop?: string[] | null; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. @@ -209,7 +209,7 @@ export namespace run_v1alpha1 { /** * Specify whether the ConfigMap must be defined +optional */ - optional?: boolean; + optional?: boolean | null; } /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported Selects a key from a ConfigMap. @@ -218,7 +218,7 @@ export namespace run_v1alpha1 { /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported The key to select. */ - key?: string; + key?: string | null; /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported The ConfigMap to select from. */ @@ -226,7 +226,7 @@ export namespace run_v1alpha1 { /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported Specify whether the ConfigMap or its key must be defined +optional */ - optional?: boolean; + optional?: boolean | null; } /** * Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. @@ -235,7 +235,7 @@ export namespace run_v1alpha1 { /** * Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */ - defaultMode?: number; + defaultMode?: number | null; /** * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. */ @@ -243,11 +243,11 @@ export namespace run_v1alpha1 { /** * Name of the config. */ - name?: string; + name?: string | null; /** * Specify whether the Secret or its keys must be defined. */ - optional?: boolean; + optional?: boolean | null; } /** * Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration @@ -256,11 +256,11 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of resource, in this case always "Configuration". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Configuration, including name, namespace, labels, and annotations. */ @@ -281,27 +281,27 @@ export namespace run_v1alpha1 { /** * Last time the condition transitioned from one status to another. +optional */ - lastTransitionTime?: string; + lastTransitionTime?: string | null; /** * Human-readable message indicating details about last transition. +optional */ - message?: string; + message?: string | null; /** * One-word CamelCase reason for the condition's last transition. +optional */ - reason?: string; + reason?: string | null; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ - severity?: string; + severity?: string | null; /** * Status of the condition, one of True, False, Unknown. */ - status?: string; + status?: string | null; /** * ConfigurationConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include:"Ready" */ - type?: string; + type?: string | null; } /** * ConfigurationSpec holds the desired state of the Configuration (from the client). @@ -310,7 +310,7 @@ export namespace run_v1alpha1 { /** * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ - generation?: number; + generation?: number | null; /** * RevisionTemplate holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn't otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. */ @@ -331,15 +331,15 @@ export namespace run_v1alpha1 { /** * LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, for that use LatestReadyRevisionName. */ - latestCreatedRevisionName?: string; + latestCreatedRevisionName?: string | null; /** * LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True". */ - latestReadyRevisionName?: string; + latestReadyRevisionName?: string | null; /** * ObservedGeneration is the 'Generation' of the Configuration that was last processed by the controller. The observed generation is updated even if the controller failed to process the spec and create the Revision. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False. */ - observedGeneration?: number; + observedGeneration?: number | null; } /** * A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. @@ -348,11 +348,11 @@ export namespace run_v1alpha1 { /** * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional */ - args?: string[]; + args?: string[] | null; /** * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional */ - command?: string[]; + command?: string[] | null; /** * List of environment variables to set in the container. Cannot be updated. +optional */ @@ -364,11 +364,11 @@ export namespace run_v1alpha1 { /** * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images */ - image?: string; + image?: string | null; /** * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images +optional */ - imagePullPolicy?: string; + imagePullPolicy?: string | null; /** * Actions that the management system should take in response to container lifecycle events. Cannot be updated. +optional */ @@ -380,7 +380,7 @@ export namespace run_v1alpha1 { /** * Name of the container specified as a DNS_LABEL. Each container must have a unique name (DNS_LABEL). Cannot be updated. */ - name?: string; + name?: string | null; /** * List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +optional */ @@ -400,23 +400,23 @@ export namespace run_v1alpha1 { /** * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional */ - stdin?: boolean; + stdin?: boolean | null; /** * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional */ - stdinOnce?: boolean; + stdinOnce?: boolean | null; /** * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional */ - terminationMessagePath?: string; + terminationMessagePath?: string | null; /** * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. +optional */ - terminationMessagePolicy?: string; + terminationMessagePolicy?: string | null; /** * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional */ - tty?: boolean; + tty?: boolean | null; /** * volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future. +optional */ @@ -428,7 +428,7 @@ export namespace run_v1alpha1 { /** * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional */ - workingDir?: string; + workingDir?: string | null; } /** * ContainerPort represents a network port in a single container. @@ -437,23 +437,23 @@ export namespace run_v1alpha1 { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. */ - containerPort?: number; + containerPort?: number | null; /** * What host IP to bind the external port to. +optional */ - hostIP?: string; + hostIP?: string | null; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional */ - hostPort?: number; + hostPort?: number | null; /** * If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional */ - name?: string; + name?: string | null; /** * Protocol for port. Must be UDP or TCP. Defaults to "TCP". +optional */ - protocol?: string; + protocol?: string | null; } /** * Resource to hold the state and status of a user's domain mapping. @@ -462,11 +462,11 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "domains.cloudrun.com/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of resource, in this case "DomainMapping". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this BuildTemplate. */ @@ -487,27 +487,27 @@ export namespace run_v1alpha1 { /** * Last time the condition transitioned from one status to another. +optional */ - lastTransitionTime?: string; + lastTransitionTime?: string | null; /** * Human readable message indicating details about the current status. +optional */ - message?: string; + message?: string | null; /** * One-word CamelCase reason for the condition's current status. +optional */ - reason?: string; + reason?: string | null; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ - severity?: string; + severity?: string | null; /** * Status of the condition, one of True, False, Unknown. */ - status?: string; + status?: string | null; /** * Type of domain mapping condition. */ - type?: string; + type?: string | null; } /** * The desired state of the Domain Mapping. @@ -516,15 +516,15 @@ export namespace run_v1alpha1 { /** * The mode of the certificate. */ - certificateMode?: string; + certificateMode?: string | null; /** * If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning. */ - forceOverride?: boolean; + forceOverride?: boolean | null; /** * The name of the Knative Route that this DomainMapping applies to. The route must exist. */ - routeName?: string; + routeName?: string | null; } /** * The current state of the Domain Mapping. @@ -537,11 +537,11 @@ export namespace run_v1alpha1 { /** * The name of the route that the mapping currently points to. */ - mappedRouteName?: string; + mappedRouteName?: string | null; /** * ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. */ - observedGeneration?: number; + observedGeneration?: number | null; /** * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. */ @@ -562,7 +562,7 @@ export namespace run_v1alpha1 { /** * An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. +optional */ - prefix?: string; + prefix?: string | null; /** * The Secret to select from +optional */ @@ -575,11 +575,11 @@ export namespace run_v1alpha1 { /** * Name of the environment variable. Must be a C_IDENTIFIER. */ - name?: string; + name?: string | null; /** * Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional */ - value?: string; + value?: string | null; /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported Source for the environment variable's value. Cannot be used if value is not empty. +optional */ @@ -602,11 +602,11 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "eventing.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of resource, in this case "EventType". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this EventType. */ @@ -620,11 +620,11 @@ export namespace run_v1alpha1 { /** * The API version of the importer CRD. */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of the importer CRD. */ - kind?: string; + kind?: string | null; /** * Parameters required to create an importer for the EventType. */ @@ -634,21 +634,21 @@ export namespace run_v1alpha1 { /** * Description of the parameter. E.g. "Google Cloud Project Id." */ - description?: string; + description?: string | null; /** * Name of the parameter. E.g. googleCloudProject. */ - name?: string; + name?: string | null; } export interface Schema$EventTypeSpec { /** * Refers to the Broker that can provide the EventType. */ - broker?: string; + broker?: string | null; /** * Description is a string describing what the EventType is about. +optional */ - description?: string; + description?: string | null; /** * The importer that provides this EventType to the eventing mesh. */ @@ -656,15 +656,15 @@ export namespace run_v1alpha1 { /** * Schema is a URI with the EventType schema. It may be a JSON schema, a protobuf schema, etc. +optional */ - schema?: string; + schema?: string | null; /** * Source is a valid URI. Refers to the CloudEvent source as it enters into the eventing mesh. */ - source?: string; + source?: string | null; /** * Type is authoritative. This refers to the CloudEvent type as it enters into the eventing mesh. */ - type?: string; + type?: string | null; } /** * ExecAction describes a "run in container" action. @@ -673,7 +673,7 @@ export namespace run_v1alpha1 { /** * Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional */ - command?: string; + command?: string | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -682,19 +682,19 @@ export namespace run_v1alpha1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -703,15 +703,15 @@ export namespace run_v1alpha1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Handler defines a specific action that should be taken @@ -737,7 +737,7 @@ export namespace run_v1alpha1 { /** * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional */ - host?: string; + host?: string | null; /** * Custom headers to set in the request. HTTP allows repeated headers. +optional */ @@ -745,7 +745,7 @@ export namespace run_v1alpha1 { /** * Path to access on the HTTP server. +optional */ - path?: string; + path?: string | null; /** * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ @@ -753,7 +753,7 @@ export namespace run_v1alpha1 { /** * Scheme to use for connecting to the host. Defaults to HTTP. +optional */ - scheme?: string; + scheme?: string | null; } /** * HTTPHeader describes a custom header to be used in HTTP probes @@ -762,11 +762,11 @@ export namespace run_v1alpha1 { /** * The header field name */ - name?: string; + name?: string | null; /** * The header field value */ - value?: string; + value?: string | null; } /** * Initializer is information about an initializer that has not yet completed. @@ -775,7 +775,7 @@ export namespace run_v1alpha1 { /** * name of the process that is responsible for initializing this object. */ - name?: string; + name?: string | null; } /** * Initializers tracks the progress of initialization. @@ -793,15 +793,15 @@ export namespace run_v1alpha1 { /** * The int value. */ - intVal?: number; + intVal?: number | null; /** * The string value. */ - strVal?: string; + strVal?: string | null; /** * The type of the value. */ - type?: number; + type?: number | null; } /** * Maps a string key to a path within a volume. @@ -810,15 +810,15 @@ export namespace run_v1alpha1 { /** * The key to project. */ - key?: string; + key?: string | null; /** * Mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional */ - mode?: number; + mode?: number | null; /** * The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ - path?: string; + path?: string | null; } /** * Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. @@ -844,7 +844,7 @@ export namespace run_v1alpha1 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * ListConfigurationsResponse is a list of Configuration resources. @@ -853,7 +853,7 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * List of Configurations. */ @@ -861,7 +861,7 @@ export namespace run_v1alpha1 { /** * The kind of this resource, in this case "ConfigurationList". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Configuration list. */ @@ -869,11 +869,11 @@ export namespace run_v1alpha1 { /** * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. */ - regionDetails?: {[key: string]: Schema$RegionDetails}; + regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * ListDomainMappingsResponse is a list of DomainMapping resources. @@ -882,7 +882,7 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "domains.cloudrun.com/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * List of DomainMappings. */ @@ -890,7 +890,7 @@ export namespace run_v1alpha1 { /** * The kind of this resource, in this case "DomainMappingList". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this DomainMapping list. */ @@ -898,7 +898,7 @@ export namespace run_v1alpha1 { /** * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. */ - regionDetails?: {[key: string]: Schema$RegionDetails}; + regionDetails?: {[key: string]: Schema$RegionDetails} | null; } /** * ListEventTypesResponse is a list of EventType resources. @@ -907,7 +907,7 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "eventing.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * List of EventTypes. */ @@ -915,7 +915,7 @@ export namespace run_v1alpha1 { /** * The kind of this resource, in this case "EventTypeList". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this EventType list. */ @@ -923,11 +923,11 @@ export namespace run_v1alpha1 { /** * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. */ - regionDetails?: {[key: string]: Schema$RegionDetails}; + regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -940,7 +940,7 @@ export namespace run_v1alpha1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. @@ -949,15 +949,15 @@ export namespace run_v1alpha1 { /** * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. */ - continue?: string; + continue?: string | null; /** * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional */ - resourceVersion?: string; + resourceVersion?: string | null; /** * SelfLink is a URL representing this object. Populated by the system. Read-only. +optional */ - selfLink?: string; + selfLink?: string | null; } /** * ListRevisionsResponse is a list of Revision resources. @@ -966,7 +966,7 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * List of Revisions. */ @@ -974,7 +974,7 @@ export namespace run_v1alpha1 { /** * The kind of this resource, in this case "RevisionList". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this revision list. */ @@ -982,11 +982,11 @@ export namespace run_v1alpha1 { /** * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. */ - regionDetails?: {[key: string]: Schema$RegionDetails}; + regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * ListRoutesResponse is a list of Route resources. @@ -995,7 +995,7 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * List of Routes. */ @@ -1003,7 +1003,7 @@ export namespace run_v1alpha1 { /** * The kind of this resource, in this case always "RouteList". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Route list. */ @@ -1011,11 +1011,11 @@ export namespace run_v1alpha1 { /** * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. */ - regionDetails?: {[key: string]: Schema$RegionDetails}; + regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * A list of Service resources. @@ -1024,7 +1024,7 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * List of Services. */ @@ -1032,7 +1032,7 @@ export namespace run_v1alpha1 { /** * The kind of this resource, in this case "ServiceList". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Service list. */ @@ -1040,11 +1040,11 @@ export namespace run_v1alpha1 { /** * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. */ - regionDetails?: {[key: string]: Schema$RegionDetails}; + regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * ListTriggersResponse is a list of Trigger resources. @@ -1053,7 +1053,7 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "eventing.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * List of Triggers. */ @@ -1061,7 +1061,7 @@ export namespace run_v1alpha1 { /** * The kind of this resource, in this case "TriggerList". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Trigger list. */ @@ -1069,11 +1069,11 @@ export namespace run_v1alpha1 { /** * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. */ - regionDetails?: {[key: string]: Schema$RegionDetails}; + regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. @@ -1082,7 +1082,7 @@ export namespace run_v1alpha1 { /** * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ - name?: string; + name?: string | null; } /** * A resource that represents Google Cloud Platform location. @@ -1091,23 +1091,23 @@ export namespace run_v1alpha1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. @@ -1116,35 +1116,35 @@ export namespace run_v1alpha1 { /** * Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional */ - annotations?: {[key: string]: string}; + annotations?: {[key: string]: string} | null; /** * Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional */ - clusterName?: string; + clusterName?: string | null; /** * CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional */ - creationTimestamp?: string; + creationTimestamp?: string | null; /** * Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional */ - deletionGracePeriodSeconds?: number; + deletionGracePeriodSeconds?: number | null; /** * DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional */ - deletionTimestamp?: string; + deletionTimestamp?: string | null; /** * Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge */ - finalizers?: string[]; + finalizers?: string[] | null; /** * Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional string generateName = 2; */ - generateName?: string; + generateName?: string | null; /** * A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional */ - generation?: number; + generation?: number | null; /** * Not currently supported by Cloud Run. An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. */ @@ -1152,15 +1152,15 @@ export namespace run_v1alpha1 { /** * Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels +optional */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional */ - name?: string; + name?: string | null; /** * Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. */ - namespace?: string; + namespace?: string | null; /** * List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional */ @@ -1168,15 +1168,15 @@ export namespace run_v1alpha1 { /** * An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional */ - resourceVersion?: string; + resourceVersion?: string | null; /** * SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4; */ - selfLink?: string; + selfLink?: string | null; /** * UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional */ - uid?: string; + uid?: string | null; } /** * ObjectReference contains enough information to let you inspect or modify the referred object. @@ -1185,31 +1185,31 @@ export namespace run_v1alpha1 { /** * API version of the referent. +optional */ - apiVersion?: string; + apiVersion?: string | null; /** * If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. */ - fieldPath?: string; + fieldPath?: string | null; /** * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional */ - kind?: string; + kind?: string | null; /** * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional */ - name?: string; + name?: string | null; /** * Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional */ - namespace?: string; + namespace?: string | null; /** * Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional */ - resourceVersion?: string; + resourceVersion?: string | null; /** * UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional */ - uid?: string; + uid?: string | null; } /** * OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. @@ -1218,27 +1218,27 @@ export namespace run_v1alpha1 { /** * API version of the referent. */ - apiVersion?: string; + apiVersion?: string | null; /** * If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional */ - blockOwnerDeletion?: boolean; + blockOwnerDeletion?: boolean | null; /** * If true, this reference points to the managing controller. +optional */ - controller?: boolean; + controller?: boolean | null; /** * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds */ - kind?: string; + kind?: string | null; /** * Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names */ - name?: string; + name?: string | null; /** * UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids */ - uid?: string; + uid?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -1255,11 +1255,11 @@ export namespace run_v1alpha1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. @@ -1268,7 +1268,7 @@ export namespace run_v1alpha1 { /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional */ - failureThreshold?: number; + failureThreshold?: number | null; /** * The action taken to determine the health of a container */ @@ -1276,19 +1276,19 @@ export namespace run_v1alpha1 { /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ - initialDelaySeconds?: number; + initialDelaySeconds?: number | null; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional */ - periodSeconds?: number; + periodSeconds?: number | null; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional */ - successThreshold?: number; + successThreshold?: number | null; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ - timeoutSeconds?: number; + timeoutSeconds?: number | null; } /** * The view model of a single quantity, e.g. "800 MiB". Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto @@ -1297,7 +1297,7 @@ export namespace run_v1alpha1 { /** * Stringified version of the quantity, e.g., "800 MiB". */ - string?: string; + string?: string | null; } /** * Information for a regional call used for a global API. @@ -1315,15 +1315,15 @@ export namespace run_v1alpha1 { /** * Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: 'www'. */ - name?: string; + name?: string | null; /** * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ - rrdata?: string; + rrdata?: string | null; /** * Resource record type. Example: `AAAA`. */ - type?: string; + type?: string | null; } /** * ResourceRequirements describes the compute resource requirements. @@ -1332,19 +1332,19 @@ export namespace run_v1alpha1 { /** * Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go */ - limits?: {[key: string]: string}; + limits?: {[key: string]: string} | null; /** * Limits describes the maximum amount of compute resources allowed. This is a temporary field created to migrate away from the map<string, Quantity> limits field. This is done to become compliant with k8s style API. This field is deprecated in favor of limits field. */ - limitsInMap?: {[key: string]: Schema$Quantity}; + limitsInMap?: {[key: string]: Schema$Quantity} | null; /** * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go */ - requests?: {[key: string]: string}; + requests?: {[key: string]: string} | null; /** * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. This is a temporary field created to migrate away from the map<string, Quantity> requests field. This is done to become compliant with k8s style API. This field is deprecated in favor of requests field. */ - requestsInMap?: {[key: string]: Schema$Quantity}; + requestsInMap?: {[key: string]: Schema$Quantity} | null; } /** * Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision @@ -1353,11 +1353,11 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of this resource, in this case "Revision". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Revision, including name, namespace, labels, and annotations. */ @@ -1378,27 +1378,27 @@ export namespace run_v1alpha1 { /** * Last time the condition transitioned from one status to another. +optional */ - lastTransitionTime?: string; + lastTransitionTime?: string | null; /** * Human readable message indicating details about the current status. +optional */ - message?: string; + message?: string | null; /** * One-word CamelCase reason for the condition's last transition. +optional */ - reason?: string; + reason?: string | null; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ - severity?: string; + severity?: string | null; /** * Status of the condition, one of True, False, Unknown. */ - status?: string; + status?: string | null; /** * RevisionConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: * "Ready": True when the Revision is ready. * "ResourcesAvailable": True when underlying resources have been provisioned. * "ContainerHealthy": True when the Revision readiness check completes. * "Active": True when the Revision may receive traffic. */ - type?: string; + type?: string | null; } /** * RevisionSpec holds the desired state of the Revision (from the client). @@ -1407,7 +1407,7 @@ export namespace run_v1alpha1 { /** * ConcurrencyModel specifies the desired concurrency model (Single or Multi) for the Revision. Defaults to Multi. Deprecated in favor of ContainerConcurrency. +optional */ - concurrencyModel?: string; + concurrencyModel?: string | null; /** * Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md */ @@ -1415,7 +1415,7 @@ export namespace run_v1alpha1 { /** * (Optional) ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. Cloud Run fully managed: supported, defaults to 80 Cloud Run on GKE: supported, defaults to 0, which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler. */ - containerConcurrency?: number; + containerConcurrency?: number | null; /** * Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. */ @@ -1423,19 +1423,19 @@ export namespace run_v1alpha1 { /** * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ - generation?: number; + generation?: number | null; /** * Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. */ - serviceAccountName?: string; + serviceAccountName?: string | null; /** * ServingState holds a value describing the state the resources are in for this Revision. Users must not specify this when creating a revision. It is expected that the system will manipulate this based on routability and load. Populated by the system. Read-only. */ - servingState?: string; + servingState?: string | null; /** * TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Not currently used by Cloud Run. */ - timeoutSeconds?: number; + timeoutSeconds?: number | null; volumes?: Schema$Volume[]; } /** @@ -1449,19 +1449,19 @@ export namespace run_v1alpha1 { /** * ImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. */ - imageDigest?: string; + imageDigest?: string | null; /** * Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config. +optional */ - logUrl?: string; + logUrl?: string | null; /** * ObservedGeneration is the 'Generation' of the Revision that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False. */ - observedGeneration?: number; + observedGeneration?: number | null; /** * Not currently used by Cloud Run. */ - serviceName?: string; + serviceName?: string | null; } /** * RevisionTemplateSpec describes the data a revision should have when created from a template. Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 @@ -1483,11 +1483,11 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of this resource, in this case always "Route". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Route, including name, namespace, labels, and annotations. */ @@ -1508,27 +1508,27 @@ export namespace run_v1alpha1 { /** * Last time the condition transitioned from one status to another. +optional */ - lastTransitionTime?: string; + lastTransitionTime?: string | null; /** * Human-readable message indicating details about last transition. +optional */ - message?: string; + message?: string | null; /** * One-word CamelCase reason for the condition's last transition. +optional */ - reason?: string; + reason?: string | null; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ - severity?: string; + severity?: string | null; /** * Status of the condition, one of "True", "False", "Unknown". */ - status?: string; + status?: string | null; /** * RouteConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: "Ready". */ - type?: string; + type?: string | null; } /** * RouteSpec holds the desired state of the Route (from the client). @@ -1537,7 +1537,7 @@ export namespace run_v1alpha1 { /** * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ - generation?: number; + generation?: number | null; /** * Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName. */ @@ -1558,15 +1558,15 @@ export namespace run_v1alpha1 { /** * Deprecated - use url instead. Domain holds the top-level domain that will distribute traffic over the provided targets. */ - domain?: string; + domain?: string | null; /** * Deprecated - use address instead. For Cloud Run, identifical to domain. */ - domainInternal?: string; + domainInternal?: string | null; /** * ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. Note that providing a trafficTarget that only has a configurationName will result in a Route that does not increment either its metadata.generation or its observedGeneration, as new "latest ready" revisions from the Configuration are processed without an update to the Route's spec. */ - observedGeneration?: number; + observedGeneration?: number | null; /** * Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. */ @@ -1574,7 +1574,7 @@ export namespace run_v1alpha1 { /** * URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app */ - url?: string; + url?: string | null; } /** * SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. @@ -1587,7 +1587,7 @@ export namespace run_v1alpha1 { /** * Specify whether the Secret must be defined +optional */ - optional?: boolean; + optional?: boolean | null; } /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. @@ -1596,7 +1596,7 @@ export namespace run_v1alpha1 { /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported The key of the secret to select from. Must be a valid secret key. */ - key?: string; + key?: string | null; /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod's namespace to select from. */ @@ -1604,7 +1604,7 @@ export namespace run_v1alpha1 { /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported Specify whether the Secret or its key must be defined +optional */ - optional?: boolean; + optional?: boolean | null; } /** * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. @@ -1613,7 +1613,7 @@ export namespace run_v1alpha1 { /** * Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */ - defaultMode?: number; + defaultMode?: number | null; /** * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. */ @@ -1621,11 +1621,11 @@ export namespace run_v1alpha1 { /** * Specify whether the Secret or its keys must be defined. */ - optional?: boolean; + optional?: boolean | null; /** * Name of the secret in the container's namespace to use. */ - secretName?: string; + secretName?: string | null; } /** * SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. @@ -1634,7 +1634,7 @@ export namespace run_v1alpha1 { /** * AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN +optional */ - allowPrivilegeEscalation?: boolean; + allowPrivilegeEscalation?: boolean | null; /** * The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. +optional */ @@ -1642,23 +1642,23 @@ export namespace run_v1alpha1 { /** * Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional */ - privileged?: boolean; + privileged?: boolean | null; /** * Whether this container has a read-only root filesystem. Default is false. +optional */ - readOnlyRootFilesystem?: boolean; + readOnlyRootFilesystem?: boolean | null; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ - runAsGroup?: number; + runAsGroup?: number | null; /** * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ - runAsNonRoot?: boolean; + runAsNonRoot?: boolean | null; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ - runAsUser?: number; + runAsUser?: number | null; /** * The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ @@ -1671,19 +1671,19 @@ export namespace run_v1alpha1 { /** * Level is SELinux level label that applies to the container. +optional */ - level?: string; + level?: string | null; /** * Role is a SELinux role label that applies to the container. +optional */ - role?: string; + role?: string | null; /** * Type is a SELinux type label that applies to the container. +optional */ - type?: string; + type?: string | null; /** * User is a SELinux user label that applies to the container. +optional */ - user?: string; + user?: string | null; } /** * Service acts as a top-level container that manages a set of Routes and Configurations which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets). The Service's controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service @@ -1692,11 +1692,11 @@ export namespace run_v1alpha1 { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of resource, in this case "Service". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Service, including name, namespace, labels, and annotations. */ @@ -1717,27 +1717,27 @@ export namespace run_v1alpha1 { /** * Last time the condition transitioned from one status to another. +optional */ - lastTransitionTime?: string; + lastTransitionTime?: string | null; /** * Human-readable message indicating details about last transition. +optional */ - message?: string; + message?: string | null; /** * One-word CamelCase reason for the condition's last transition. +optional */ - reason?: string; + reason?: string | null; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ - severity?: string; + severity?: string | null; /** * Status of the condition, one of True, False, Unknown. */ - status?: string; + status?: string | null; /** * ServiceConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: "Ready", "ConfigurationsReady", and "RoutesReady". "Ready" will be true when the underlying Route and Configuration are ready. */ - type?: string; + type?: string | null; } /** * ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). @@ -1746,7 +1746,7 @@ export namespace run_v1alpha1 { /** * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ - generation?: number; + generation?: number | null; /** * Manual contains the options for configuring a manual service. See ServiceSpec for more details. Not currently supported by Cloud Run. */ @@ -1787,7 +1787,7 @@ export namespace run_v1alpha1 { /** * The revision name to pin this service to until changed to a different service type. */ - revisionName?: string; + revisionName?: string | null; } /** * ServiceSpecReleaseType contains the options for slowly releasing revisions. See ServiceSpec for more details. Not currently supported by Cloud Run. @@ -1800,11 +1800,11 @@ export namespace run_v1alpha1 { /** * Revisions is an ordered list of 1 or 2 revisions. The first is the current revision, and the second is the candidate revision. If a single revision is provided, traffic will be pinned at that revision. "@latest" is a shortcut for usage that refers to the latest created revision by the configuration. */ - revisions?: string[]; + revisions?: string[] | null; /** * RolloutPercent is the percent of traffic that should be sent to the candidate revision, i.e. the 2nd revision in the revisions list. Valid values are between 0 and 99 inclusive. */ - rolloutPercent?: number; + rolloutPercent?: number | null; } /** * ServiceSpecRunLatest contains the options for always having a route to the latest configuration. See ServiceSpec for more details. @@ -1830,19 +1830,19 @@ export namespace run_v1alpha1 { /** * From RouteStatus. Domain holds the top-level domain that will distribute traffic over the provided targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app */ - domain?: string; + domain?: string | null; /** * From ConfigurationStatus. LatestCreatedRevisionName is the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName. */ - latestCreatedRevisionName?: string; + latestCreatedRevisionName?: string | null; /** * From ConfigurationStatus. LatestReadyRevisionName holds the name of the latest Revision stamped out from this Service's Configuration that has had its "Ready" condition become "True". */ - latestReadyRevisionName?: string; + latestReadyRevisionName?: string | null; /** * ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. */ - observedGeneration?: number; + observedGeneration?: number | null; /** * From RouteStatus. Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. */ @@ -1850,7 +1850,7 @@ export namespace run_v1alpha1 { /** * From RouteStatus. URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app */ - url?: string; + url?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -1863,7 +1863,7 @@ export namespace run_v1alpha1 { /** * 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; + updateMask?: string | null; } export interface Schema$SubscriberSpec { /** @@ -1873,7 +1873,7 @@ export namespace run_v1alpha1 { /** * Reference to a 'known' endpoint where no resolving is done. http://k8s-service for example http://myexternalhandler.example.com/foo/bar */ - uri?: string; + uri?: string | null; } /** * TCPSocketAction describes an action based on opening a socket @@ -1882,7 +1882,7 @@ export namespace run_v1alpha1 { /** * Optional: Host name to connect to, defaults to the pod IP. +optional */ - host?: string; + host?: string | null; /** * Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ @@ -1895,7 +1895,7 @@ export namespace run_v1alpha1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -1904,7 +1904,7 @@ export namespace run_v1alpha1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * TrafficTarget holds a single entry of the routing table for a Route. @@ -1913,41 +1913,41 @@ export namespace run_v1alpha1 { /** * ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName. */ - configurationName?: string; + configurationName?: string | null; /** * LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty. +optional */ - latestRevision?: boolean; + latestRevision?: boolean | null; /** * Name is optionally used to expose a dedicated hostname for referencing this target exclusively. Not currently supported by Cloud Run. +optional */ - name?: string; + name?: string | null; /** * Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry. */ - percent?: number; + percent?: number | null; /** * RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run. */ - revisionName?: string; + revisionName?: string | null; /** * Tag is optionally used to expose a dedicated url for referencing this target exclusively. Not currently supported in Cloud Run. +optional */ - tag?: string; + tag?: string | null; /** * Output only. URL displays the URL for accessing named traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc. Not currently supported in Cloud Run. */ - url?: string; + url?: string | null; } export interface Schema$Trigger { /** * The API version for this call such as "eventing.knative.dev/v1alpha1". */ - apiVersion?: string; + apiVersion?: string | null; /** * The kind of resource, in this case "Trigger". */ - kind?: string; + kind?: string | null; /** * Metadata associated with this Trigger. */ @@ -1968,47 +1968,54 @@ export namespace run_v1alpha1 { /** * Last time the condition transitioned from one status to another. +optional */ - lastTransitionTime?: string; + lastTransitionTime?: string | null; /** * Human readable message indicating details about the current status. +optional */ - message?: string; + message?: string | null; /** * One-word CamelCase reason for the condition's current status. +optional */ - reason?: string; + reason?: string | null; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ - severity?: string; + severity?: string | null; /** * Status of the condition, one of True, False, Unknown. */ - status?: string; + status?: string | null; /** * Type of Trigger condition. */ - type?: string; + type?: string | null; } export interface Schema$TriggerFilter { + /** + * Cloud Run fully managed: not supported Cloud Run on GKE: supported Attributes filters events by exact match on event context attributes. Each key in the map is compared with the equivalent key in the event context. An event passes the filter if all values are equal to the specified values. Nested context attributes are not supported as keys. Only string values are supported. +optional + */ + attributes?: {[key: string]: string} | null; + /** + * SourceAndType filters events based on exact matches on the CloudEvents type and source attributes. This field has been replaced by the Attributes field. +optional + */ sourceAndType?: Schema$TriggerFilterSourceAndType; } /** * TriggerFilterSourceAndType filters events based on exact matches on the cloud event's type and source attributes. Only exact matches will pass the filter. */ export interface Schema$TriggerFilterSourceAndType { - source?: string; - type?: string; + source?: string | null; + type?: string | null; } export interface Schema$TriggerImporterSpec { /** * Arguments to use for the importer. These must match the parameters in the EventType's importer. */ - arguments?: {[key: string]: string}; + arguments?: {[key: string]: string} | null; /** * Name of the EventType that this importer provides. */ - eventTypeName?: string; + eventTypeName?: string | null; } /** * The desired state of the Trigger. @@ -2017,7 +2024,7 @@ export namespace run_v1alpha1 { /** * Broker is the broker that this trigger receives events from. If not specified, will default to 'default'. Not currently supported by Cloud Run. */ - broker?: string; + broker?: string | null; /** * Filter is the filter to apply against all events from the Broker. Only events that pass this filter will be sent to the Subscriber. */ @@ -2042,11 +2049,11 @@ export namespace run_v1alpha1 { /** * ObservedGeneration is the 'Generation' of the Trigger that was last processed by the controller. */ - observedGeneration?: number; + observedGeneration?: number | null; /** * SubscriberURI is the resolved URI of the receiver for this Trigger. */ - subscriberUri?: string; + subscriberUri?: string | null; } /** * Volume represents a named volume in a container. @@ -2056,7 +2063,7 @@ export namespace run_v1alpha1 { /** * Volume's name. */ - name?: string; + name?: string | null; secret?: Schema$SecretVolumeSource; } /** @@ -2066,11 +2073,11 @@ export namespace run_v1alpha1 { /** * devicePath is the path inside of the container that the device will be mapped to. */ - devicePath?: string; + devicePath?: string | null; /** * name must match the name of a persistentVolumeClaim in the pod */ - name?: string; + name?: string | null; } /** * VolumeMount describes a mounting of a Volume within a container. @@ -2079,23 +2086,23 @@ export namespace run_v1alpha1 { /** * Path within the container at which the volume should be mounted. Must not contain ':'. */ - mountPath?: string; + mountPath?: string | null; /** * mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is beta in 1.10. +optional */ - mountPropagation?: string; + mountPropagation?: string | null; /** * This must match the Name of a Volume. */ - name?: string; + name?: string | null; /** * Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional */ - readOnly?: boolean; + readOnly?: boolean | null; /** * Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional */ - subPath?: string; + subPath?: string | null; } export class Resource$Namespaces { diff --git a/src/apis/runtimeconfig/v1.ts b/src/apis/runtimeconfig/v1.ts index 70d42340067..66a5be9c2d4 100644 --- a/src/apis/runtimeconfig/v1.ts +++ b/src/apis/runtimeconfig/v1.ts @@ -132,7 +132,7 @@ export namespace runtimeconfig_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -145,7 +145,7 @@ export namespace runtimeconfig_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -153,15 +153,15 @@ export namespace runtimeconfig_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -170,15 +170,15 @@ export namespace runtimeconfig_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Operations { diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index 9634142b486..44a0b20863a 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -128,11 +128,11 @@ export namespace runtimeconfig_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to `2`, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = "value1"` + `/foo/variable2 = "value2"` + `/bar/variable3 = "value3"` It would not satisfy the same condition with the `number` set to `3`, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted. @@ -141,11 +141,11 @@ export namespace runtimeconfig_v1beta1 { /** * The number variables under the `path` that must exist to meet this condition. Defaults to 1 if not specified. */ - number?: number; + number?: number | null; /** * The root of the variable subtree to monitor. For example, `/foo`. */ - path?: string; + path?: 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 `{}`. @@ -167,19 +167,19 @@ export namespace runtimeconfig_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * `ListConfigs()` returns the following response. The order of returned objects is arbitrary; that is, it is not ordered in any particular way. @@ -192,7 +192,7 @@ export namespace runtimeconfig_v1beta1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for the `ListVariables()` method. @@ -201,7 +201,7 @@ export namespace runtimeconfig_v1beta1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of variables and their values. The order of returned variable objects is arbitrary. */ @@ -214,7 +214,7 @@ export namespace runtimeconfig_v1beta1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Found waiters in the project. */ @@ -227,7 +227,7 @@ export namespace runtimeconfig_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -235,15 +235,15 @@ export namespace runtimeconfig_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -256,11 +256,11 @@ export namespace runtimeconfig_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. A RuntimeConfig resource consists of metadata and a hierarchy of variables. @@ -269,11 +269,11 @@ export namespace runtimeconfig_v1beta1 { /** * An optional description of the RuntimeConfig object. */ - description?: string; + description?: string | null; /** * The resource name of a runtime config. The name must have the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression. The length of `[CONFIG_NAME]` must be less than 64 characters. You pick the RuntimeConfig resource name, but the server will validate that the name adheres to this format. After you create the resource, you cannot change the resource's name. */ - name?: string; + name?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -291,15 +291,15 @@ export namespace runtimeconfig_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -308,7 +308,7 @@ export namespace runtimeconfig_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -317,7 +317,7 @@ export namespace runtimeconfig_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Describes a single variable within a RuntimeConfig resource. The name denotes the hierarchical variable name. For example, `ports/serving_port` is a valid variable name. The variable value is an opaque string and only leaf variables can have values (that is, variables that do not have any child variables). @@ -326,23 +326,23 @@ export namespace runtimeconfig_v1beta1 { /** * The name of the variable resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system file path naming. The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression. The length of a `[VARIABLE_NAME]` must be less than 256 characters. Once you create a variable, you cannot change the variable name. */ - name?: string; + name?: string | null; /** * Output only. The current state of the variable. The variable state indicates the outcome of the `variables().watch` call and is visible through the `get` and `list` calls. */ - state?: string; + state?: string | null; /** * The string value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. For example, `text: "my text value"`. The string must be valid UTF-8. */ - text?: string; + text?: string | null; /** * Output only. The time of the last variable update. Timestamp will be UTC timestamp. */ - updateTime?: string; + updateTime?: string | null; /** * The binary value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. The value must be base64 encoded, and must comply with IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text` can be set. */ - value?: string; + value?: string | null; } /** * A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) documentation. @@ -351,11 +351,11 @@ export namespace runtimeconfig_v1beta1 { /** * Output only. The instant at which this Waiter resource was created. Adding the value of `timeout` to this instant yields the timeout deadline for the waiter. */ - createTime?: string; + createTime?: string | null; /** * Output only. If the value is `false`, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, `error` will be set. */ - done?: boolean; + done?: boolean | null; /** * Output only. If the waiter ended due to a failure or timeout, this value will be set. */ @@ -367,7 +367,7 @@ export namespace runtimeconfig_v1beta1 { /** * The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC 1035 segment specification, and the length of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name. */ - name?: string; + name?: string | null; /** * [Required] The success condition. If this condition is met, `done` will be set to `true` and the `error` value will remain unset. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated. */ @@ -375,7 +375,7 @@ export namespace runtimeconfig_v1beta1 { /** * [Required] Specifies the timeout of the waiter in seconds, beginning from the instant that `waiters().create` method is called. If this time elapses before the success or failure conditions are met, the waiter fails and sets the `error` code to `DEADLINE_EXCEEDED`. */ - timeout?: string; + timeout?: string | null; } /** * Request for the `WatchVariable()` method. @@ -384,7 +384,7 @@ export namespace runtimeconfig_v1beta1 { /** * If specified, checks the current timestamp of the variable and if the current timestamp is newer than `newerThan` timestamp, the method returns immediately. If not specified or the variable has an older timestamp, the watcher waits for a the value to change before returning. */ - newerThan?: string; + newerThan?: string | null; } export class Resource$Projects { diff --git a/src/apis/safebrowsing/v4.ts b/src/apis/safebrowsing/v4.ts index e4a8368fcad..12a0d263953 100644 --- a/src/apis/safebrowsing/v4.ts +++ b/src/apis/safebrowsing/v4.ts @@ -136,7 +136,7 @@ export namespace safebrowsing_v4 { /** * The SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database. */ - sha256?: string; + sha256?: string | null; } /** * The client metadata associated with Safe Browsing API requests. @@ -145,11 +145,11 @@ export namespace safebrowsing_v4 { /** * A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API. */ - clientId?: string; + clientId?: string | null; /** * The version of the client implementation. */ - clientVersion?: string; + clientVersion?: string | null; } /** * The constraints for this update. @@ -158,27 +158,27 @@ export namespace safebrowsing_v4 { /** * A client's physical location, expressed as a ISO 31166-1 alpha-2 region code. */ - deviceLocation?: string; + deviceLocation?: string | null; /** * Requests the lists for a specific language. Expects ISO 639 alpha-2 format. */ - language?: string; + language?: string | null; /** * Sets the maximum number of entries that the client is willing to have in the local database. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set. */ - maxDatabaseEntries?: number; + maxDatabaseEntries?: number | null; /** * The maximum size in number of entries. The update will not contain more entries than this value. This should be a power of 2 between 2**10 and 2**20. If zero, no update size limit is set. */ - maxUpdateEntries?: number; + maxUpdateEntries?: number | null; /** * Requests the list for a specific geographic location. If not set the server may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2 format. */ - region?: string; + region?: string | null; /** * The compression types supported by the client. */ - supportedCompressions?: string[]; + supportedCompressions?: 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 `{}`. @@ -205,7 +205,7 @@ export namespace safebrowsing_v4 { /** * The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want. */ - minimumWaitDuration?: string; + minimumWaitDuration?: string | null; } /** * Request to return full hashes matched by the provided hash prefixes. @@ -222,7 +222,7 @@ export namespace safebrowsing_v4 { /** * The current client states for each of the client's local threat lists. */ - clientStates?: string[]; + clientStates?: string[] | null; /** * The lists and hashes to be checked. */ @@ -236,11 +236,11 @@ export namespace safebrowsing_v4 { /** * The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want. */ - minimumWaitDuration?: string; + minimumWaitDuration?: string | null; /** * For requested entities that did not match the threat list, how long to cache the response. */ - negativeCacheDuration?: string; + negativeCacheDuration?: string | null; } /** * Request to check entries against lists. @@ -278,19 +278,19 @@ export namespace safebrowsing_v4 { /** * The type of platform at risk by entries present in the list. */ - platformType?: string; + platformType?: string | null; /** * The current state of the client for the requested list (the encrypted client state that was received from the last successful list update). */ - state?: string; + state?: string | null; /** * The types of entries present in the list. */ - threatEntryType?: string; + threatEntryType?: string | null; /** * The type of threat posed by entries present in the list. */ - threatType?: string; + threatType?: string | null; } /** * An update to an individual list. @@ -307,11 +307,11 @@ export namespace safebrowsing_v4 { /** * The new client state, in encrypted format. Opaque to clients. */ - newClientState?: string; + newClientState?: string | null; /** * The platform type for which data is returned. */ - platformType?: string; + platformType?: string | null; /** * A set of entries to remove from a local threat type's list. In practice, this field is empty or contains exactly one ThreatEntrySet. */ @@ -319,15 +319,15 @@ export namespace safebrowsing_v4 { /** * The type of response. This may indicate that an action is required by the client when the response is received. */ - responseType?: string; + responseType?: string | null; /** * The format of the threats. */ - threatEntryType?: string; + threatEntryType?: string | null; /** * The threat type for which data is returned. */ - threatType?: string; + threatType?: string | null; } /** * A single metadata entry. @@ -336,11 +336,11 @@ export namespace safebrowsing_v4 { /** * The metadata entry key. For JSON requests, the key is base64-encoded. */ - key?: string; + key?: string | null; /** * The metadata entry value. For JSON requests, the value is base64-encoded. */ - value?: string; + value?: string | null; } /** * The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression. @@ -349,11 +349,11 @@ export namespace safebrowsing_v4 { /** * The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). */ - prefixSize?: number; + prefixSize?: number | null; /** * The hashes, in binary format, concatenated into one long string. Hashes are sorted in lexicographic order. For JSON API users, hashes are base64-encoded. */ - rawHashes?: string; + rawHashes?: string | null; } /** * A set of raw indices to remove from a local list. @@ -362,7 +362,7 @@ export namespace safebrowsing_v4 { /** * The indices to remove from a lexicographically-sorted local list. */ - indices?: number[]; + indices?: number[] | null; } /** * The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices. @@ -371,19 +371,19 @@ export namespace safebrowsing_v4 { /** * The encoded deltas that are encoded using the Golomb-Rice coder. */ - encodedData?: string; + encodedData?: string | null; /** * The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value. If the field is empty or missing, assume zero. */ - firstValue?: string; + firstValue?: string | null; /** * The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`. */ - numEntries?: number; + numEntries?: number | null; /** * The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero. */ - riceParameter?: number; + riceParameter?: number | null; } /** * An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. @@ -392,15 +392,15 @@ export namespace safebrowsing_v4 { /** * The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded. */ - digest?: string; + digest?: string | null; /** * A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded. */ - hash?: string; + hash?: string | null; /** * A URL. */ - url?: string; + url?: string | null; } /** * The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type. @@ -418,7 +418,7 @@ export namespace safebrowsing_v4 { /** * The compression type for the entries in this set. */ - compressionType?: string; + compressionType?: string | null; /** * The raw SHA256-formatted entries. */ @@ -448,7 +448,7 @@ export namespace safebrowsing_v4 { /** * The platform type reported. */ - platformType?: string; + platformType?: string | null; /** * The resources related to the threat hit. */ @@ -456,7 +456,7 @@ export namespace safebrowsing_v4 { /** * The threat type reported. */ - threatType?: string; + threatType?: string | null; /** * Details about the user that encountered the threat. */ @@ -469,7 +469,7 @@ export namespace safebrowsing_v4 { /** * The platform types to be checked. */ - platformTypes?: string[]; + platformTypes?: string[] | null; /** * The threat entries to be checked. */ @@ -477,11 +477,11 @@ export namespace safebrowsing_v4 { /** * The entry types to be checked. */ - threatEntryTypes?: string[]; + threatEntryTypes?: string[] | null; /** * The threat types to be checked. */ - threatTypes?: string[]; + threatTypes?: string[] | null; } /** * Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list. @@ -490,15 +490,15 @@ export namespace safebrowsing_v4 { /** * The platform type targeted by the list's entries. */ - platformType?: string; + platformType?: string | null; /** * The entry types contained in the list. */ - threatEntryType?: string; + threatEntryType?: string | null; /** * The threat type posed by the list's entries. */ - threatType?: string; + threatType?: string | null; } /** * A match when checking a threat entry in the Safe Browsing threat lists. @@ -507,11 +507,11 @@ export namespace safebrowsing_v4 { /** * The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives. */ - cacheDuration?: string; + cacheDuration?: string | null; /** * The platform type matching this threat. */ - platformType?: string; + platformType?: string | null; /** * The threat matching this threat. */ @@ -523,11 +523,11 @@ export namespace safebrowsing_v4 { /** * The threat entry type matching this threat. */ - threatEntryType?: string; + threatEntryType?: string | null; /** * The threat type matching this threat. */ - threatType?: string; + threatType?: string | null; } /** * A single resource related to a threat hit. @@ -536,19 +536,19 @@ export namespace safebrowsing_v4 { /** * Referrer of the resource. Only set if the referrer is available. */ - referrer?: string; + referrer?: string | null; /** * The remote IP of the resource in ASCII format. Either IPv4 or IPv6. */ - remoteIp?: string; + remoteIp?: string | null; /** * The type of source reported. */ - type?: string; + type?: string | null; /** * The URL of the resource. */ - url?: string; + url?: string | null; } /** * Details about the user that encountered the threat. @@ -557,11 +557,11 @@ export namespace safebrowsing_v4 { /** * The UN M.49 region code associated with the user's location. */ - regionCode?: string; + regionCode?: string | null; /** * Unique user identifier defined by the client. */ - userId?: string; + userId?: string | null; } export class Resource$Encodedfullhashes { diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index 99345589861..9b6c20eb3a7 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -132,7 +132,7 @@ export namespace script_v1 { /** * The script project's Drive ID. */ - scriptId?: string; + scriptId?: string | null; } /** * Request to create a script project. @@ -141,11 +141,11 @@ export namespace script_v1 { /** * The Drive ID of a parent file that the created script project is bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google Slides file. If not set, a standalone script project is created. */ - parentId?: string; + parentId?: string | null; /** * The title for the project. */ - title?: string; + title?: string | null; } /** * Representation of a single script deployment. @@ -158,7 +158,7 @@ export namespace script_v1 { /** * The deployment ID for this deployment. */ - deploymentId?: string; + deploymentId?: string | null; /** * The deployment's entry points. */ @@ -166,7 +166,7 @@ export namespace script_v1 { /** * Last modified date time stamp. */ - updateTime?: string; + updateTime?: string | null; } /** * Metadata the defines how a deployment is configured. @@ -175,19 +175,19 @@ export namespace script_v1 { /** * The description for this deployment. */ - description?: string; + description?: string | null; /** * The manifest file name for this deployment. */ - manifestFileName?: string; + manifestFileName?: string | null; /** * The script project's Drive ID. */ - scriptId?: string; + scriptId?: string | null; /** * The version number on which this deployment is based. */ - versionNumber?: number; + versionNumber?: number | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -204,7 +204,7 @@ export namespace script_v1 { /** * The type of the entry point. */ - entryPointType?: string; + entryPointType?: string | null; /** * An entry point specification for Apps Script API execution calls. */ @@ -230,11 +230,11 @@ export namespace script_v1 { /** * The error message thrown by Apps Script, usually localized into the user's language. */ - errorMessage?: string; + errorMessage?: string | null; /** * The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included. */ - errorType?: string; + errorType?: string | null; /** * An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first. */ @@ -247,19 +247,19 @@ export namespace script_v1 { /** * If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Apps Script API. Optional; default is `false`. */ - devMode?: boolean; + devMode?: boolean | null; /** * The name of the function to execute in the given script. The name does not include parentheses or parameters. It can reference a function in an included library such as `Library.libFunction1`. */ - function?: string; + function?: string | null; /** * The parameters to be passed to the function being executed. The object type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific object types (such as a `Document` or a `Calendar`); they can only be primitive types such as `string`, `number`, `array`, `object`, or `boolean`. Optional. */ - parameters?: any[]; + parameters?: any[] | null; /** * <b>Deprecated</b>. For use with Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the [Intent](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/bound) script&mdash;that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. Optional. */ - sessionState?: string; + sessionState?: string | null; } /** * An object that provides the return value of a function executed using the Apps Script API. If the script function returns successfully, the response body's response field contains this `ExecutionResponse` object. @@ -268,7 +268,7 @@ export namespace script_v1 { /** * The return value of the script function. The type matches the object type returned in Apps Script. Functions called using the Apps Script API cannot return Apps Script-specific objects (such as a `Document` or a `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`. */ - result?: any; + result?: any | null; } /** * An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files. @@ -277,7 +277,7 @@ export namespace script_v1 { /** * Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project. */ - createTime?: string; + createTime?: string | null; /** * The defined set of functions in the script file, if any. */ @@ -289,19 +289,19 @@ export namespace script_v1 { /** * The name of the file. The file extension is not part of the file name, which can be identified from the type field. */ - name?: string; + name?: string | null; /** * The file content. */ - source?: string; + source?: string | null; /** * The type of the file. */ - type?: string; + type?: string | null; /** * Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project. */ - updateTime?: string; + updateTime?: string | null; } /** * An add-on entry point. @@ -310,27 +310,27 @@ export namespace script_v1 { /** * The add-on's required list of supported container types. */ - addOnType?: string; + addOnType?: string | null; /** * The add-on's optional description. */ - description?: string; + description?: string | null; /** * The add-on's optional help URL. */ - helpUrl?: string; + helpUrl?: string | null; /** * The add-on's required post install tip URL. */ - postInstallTipUrl?: string; + postInstallTipUrl?: string | null; /** * The add-on's optional report issue URL. */ - reportIssueUrl?: string; + reportIssueUrl?: string | null; /** * The add-on's required title. */ - title?: string; + title?: string | null; } /** * API executable entry point configuration. @@ -339,7 +339,7 @@ export namespace script_v1 { /** * Who has permission to run the API executable. */ - access?: string; + access?: string | null; } /** * An API executable entry point. @@ -357,7 +357,7 @@ export namespace script_v1 { /** * The function name in the script project. */ - name?: string; + name?: string | null; } /** * A set of functions. No duplicates are permitted. @@ -375,31 +375,31 @@ export namespace script_v1 { /** * Duration the execution spent executing. */ - duration?: string; + duration?: string | null; /** * Name of the function the started the execution. */ - functionName?: string; + functionName?: string | null; /** * The executions status. */ - processStatus?: string; + processStatus?: string | null; /** * The executions type. */ - processType?: string; + processType?: string | null; /** * Name of the script being executed. */ - projectName?: string; + projectName?: string | null; /** * Time the execution started. */ - startTime?: string; + startTime?: string | null; /** * The executing users access level to the script. */ - userAccessLevel?: string; + userAccessLevel?: string | null; } /** * A simple user profile resource. @@ -408,19 +408,19 @@ export namespace script_v1 { /** * The user's domain. */ - domain?: string; + domain?: string | null; /** * The user's identifying email address. */ - email?: string; + email?: string | null; /** * The user's display name. */ - name?: string; + name?: string | null; /** * The user's photo. */ - photoUrl?: string; + photoUrl?: string | null; } /** * Web app entry point configuration. @@ -429,11 +429,11 @@ export namespace script_v1 { /** * Who has permission to run the web app. */ - access?: string; + access?: string | null; /** * Who to execute the web app as. */ - executeAs?: string; + executeAs?: string | null; } /** * A web application entry point. @@ -446,7 +446,7 @@ export namespace script_v1 { /** * The URL for the web application. */ - url?: string; + url?: string | null; } /** * Response with the list of deployments for the specified Apps Script project. @@ -459,7 +459,7 @@ export namespace script_v1 { /** * The token that can be used in the next call to get the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response with the list of Process resources. @@ -468,7 +468,7 @@ export namespace script_v1 { /** * Token for the next page of results. If empty, there are no more pages remaining. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of processes matching request parameters. */ @@ -481,7 +481,7 @@ export namespace script_v1 { /** * Token for the next page of results. If empty, there are no more pages remaining. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of processes matching request parameters. */ @@ -503,7 +503,7 @@ export namespace script_v1 { /** * The token use to fetch the next page of records. if not exist in the response, that means no more versions to list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of versions. */ @@ -533,15 +533,15 @@ export namespace script_v1 { /** * Required field indicating the end time of the interval. */ - endTime?: string; + endTime?: string | null; /** * Required field indicating the start time of the interval. */ - startTime?: string; + startTime?: string | null; /** * Indicates the number of executions counted. */ - value?: string; + value?: string | null; } /** * A representation of an execution of an Apps Script function started with run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). <p>After execution has started, it can have one of four outcomes:</p> <ul> <li> If the script function returns successfully, the response field contains an ExecutionResponse object with the function's return value in the object's `result` field.</li> <li> If the script function (or Apps Script itself) throws an exception, the error field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.</li> <li> If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present.</li> <li> If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries automatically convert a 4XX response into an exception class.</li> </ul> @@ -550,7 +550,7 @@ export namespace script_v1 { /** * This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed. */ - done?: boolean; + done?: boolean | null; /** * If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error. */ @@ -558,7 +558,7 @@ export namespace script_v1 { /** * If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * The script project resource. @@ -567,7 +567,7 @@ export namespace script_v1 { /** * When the script was created. */ - createTime?: string; + createTime?: string | null; /** * User who originally created the script. */ @@ -579,19 +579,19 @@ export namespace script_v1 { /** * The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This filed is optional, and if not set, a stand-alone script will be created. */ - parentId?: string; + parentId?: string | null; /** * The script project's Drive ID. */ - scriptId?: string; + scriptId?: string | null; /** * The title for the project. */ - title?: string; + title?: string | null; /** * When the script was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The result of an execution Based on ScriptExecutionResult at: google3/apps/maestro/api/frontend_execution_common.proto?q=message%5c%20ScriptExecutionResult @@ -609,11 +609,11 @@ export namespace script_v1 { /** * The name of the function that failed. */ - function?: string; + function?: string | null; /** * The line number where the script failed. */ - lineNumber?: number; + lineNumber?: number | null; } /** * If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object. @@ -622,15 +622,15 @@ export namespace script_v1 { /** * The status code. For this API, this value either: <ul> <li> 10, indicating a `SCRIPT_TIMEOUT` error,</li> <li> 3, indicating an `INVALID_ARGUMENT` error, or</li> <li> 1, indicating a `CANCELLED` execution.</li> </ul> */ - code?: number; + code?: number | null; /** * An array that contains a single ExecutionError object that provides information about the nature of the error. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. Based on Struct at: google3/apps/maestro/api/struct.proto?q=message%5c%20Struct @@ -639,7 +639,7 @@ export namespace script_v1 { /** * Unordered map of dynamically typed values. */ - fields?: {[key: string]: Schema$Value}; + fields?: {[key: string]: Schema$Value} | null; } /** * Request with deployment information to update an existing deployment. @@ -657,15 +657,15 @@ export namespace script_v1 { /** * Represents a boolean value. */ - boolValue?: boolean; + boolValue?: boolean | null; /** * Represents raw byte values. */ - bytesValue?: string; + bytesValue?: string | null; /** * Represents a date in ms since the epoch. */ - dateValue?: string; + dateValue?: string | null; /** * Represents a repeated `Value`. */ @@ -673,19 +673,19 @@ export namespace script_v1 { /** * Represents a null value. */ - nullValue?: string; + nullValue?: string | null; /** * Represents a double value. */ - numberValue?: number; + numberValue?: number | null; /** * Represents a structured proto value. */ - protoValue?: {[key: string]: any}; + protoValue?: {[key: string]: any} | null; /** * Represents a string value. */ - stringValue?: string; + stringValue?: string | null; /** * Represents a structured value. */ @@ -698,19 +698,19 @@ export namespace script_v1 { /** * When the version was created. */ - createTime?: string; + createTime?: string | null; /** * The description for this version. */ - description?: string; + description?: string | null; /** * The script project's Drive ID. */ - scriptId?: string; + scriptId?: string | null; /** * The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created. */ - versionNumber?: number; + versionNumber?: number | null; } export class Resource$Processes { @@ -2207,7 +2207,7 @@ export namespace script_v1 { /** * script.scripts.run - * @desc Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab. The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script. + * @desc Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab. The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script. * @alias script.scripts.run * @memberOf! () * diff --git a/src/apis/searchconsole/v1.ts b/src/apis/searchconsole/v1.ts index 5489ef3d41d..5f463b8d84c 100644 --- a/src/apis/searchconsole/v1.ts +++ b/src/apis/searchconsole/v1.ts @@ -124,7 +124,7 @@ export namespace searchconsole_v1 { /** * URL of the blocked resource. */ - url?: string; + url?: string | null; } /** * Describe image data. @@ -133,11 +133,11 @@ export namespace searchconsole_v1 { /** * 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; + data?: string | null; /** * The mime-type of the image data. */ - mimeType?: string; + mimeType?: string | null; } /** * Mobile-friendly issue. @@ -146,7 +146,7 @@ export namespace searchconsole_v1 { /** * Rule violated. */ - rule?: string; + rule?: string | null; } /** * Information about a resource with issue. @@ -164,11 +164,11 @@ export namespace searchconsole_v1 { /** * Whether or not screenshot is requested. Default is false. */ - requestScreenshot?: boolean; + requestScreenshot?: boolean | null; /** * URL for inspection. */ - url?: string; + url?: string | null; } /** * Mobile-friendly test response, including mobile-friendly issues and resource issues. @@ -177,7 +177,7 @@ export namespace searchconsole_v1 { /** * Test verdict, whether the page is mobile friendly or not. */ - mobileFriendliness?: string; + mobileFriendliness?: string | null; /** * List of mobile-usability issues. */ @@ -202,11 +202,11 @@ export namespace searchconsole_v1 { /** * Error details if applicable. */ - details?: string; + details?: string | null; /** * Status of the test. */ - status?: string; + status?: string | null; } export class Resource$Urltestingtools { diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 49974b464ad..dfe27e637c7 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -124,7 +124,7 @@ export namespace securitycenter_v1 { /** * The time at which the asset was created in Cloud SCC. */ - createTime?: string; + createTime?: string | null; /** * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. */ @@ -132,11 +132,11 @@ export namespace securitycenter_v1 { /** * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/assets/456". */ - name?: string; + name?: string | null; /** * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. */ - resourceProperties?: {[key: string]: any}; + resourceProperties?: {[key: string]: any} | null; /** * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. */ @@ -148,7 +148,7 @@ export namespace securitycenter_v1 { /** * The time at which the asset was last updated, added, or deleted in Cloud SCC. */ - updateTime?: string; + updateTime?: string | null; } /** * The configuration used for Asset Discovery runs. @@ -157,11 +157,11 @@ export namespace securitycenter_v1 { /** * The mode to use for filtering asset discovery. */ - inclusionMode?: string; + inclusionMode?: string | null; /** * The project ids to use for filtering asset discovery. */ - projectIds?: string[]; + projectIds?: string[] | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -174,7 +174,7 @@ export namespace securitycenter_v1 { /** * 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; + 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. @@ -183,11 +183,11 @@ export namespace securitycenter_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -200,11 +200,11 @@ export namespace securitycenter_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -217,19 +217,19 @@ export namespace securitycenter_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. @@ -238,31 +238,31 @@ export namespace securitycenter_v1 { /** * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ - category?: string; + category?: string | null; /** * The time at which the finding was created in Cloud SCC. */ - createTime?: string; + createTime?: string | null; /** * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. */ - eventTime?: string; + eventTime?: string | null; /** * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. */ - externalUri?: string; + externalUri?: string | null; /** * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" */ - name?: string; + name?: string | null; /** * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/123/sources/456" */ - parent?: string; + parent?: string | null; /** * The full resource name of the Google Cloud Platform (GCP) resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name This field is immutable after creation time. */ - resourceName?: string; + resourceName?: string | null; /** * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ @@ -270,11 +270,11 @@ export namespace securitycenter_v1 { /** * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. */ - sourceProperties?: {[key: string]: any}; + sourceProperties?: {[key: string]: any} | null; /** * The state of the finding. */ - state?: string; + state?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -292,7 +292,7 @@ export namespace securitycenter_v1 { /** * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * Response of asset discovery run @@ -301,11 +301,11 @@ export namespace securitycenter_v1 { /** * The duration between asset discovery run start and end */ - duration?: string; + duration?: string | null; /** * The state of an asset discovery run. */ - state?: string; + state?: string | null; } /** * Response of asset discovery run @@ -314,11 +314,11 @@ export namespace securitycenter_v1 { /** * The duration between asset discovery run start and end */ - duration?: string; + duration?: string | null; /** * The state of an asset discovery run. */ - state?: string; + state?: string | null; } /** * Request message for grouping by assets. @@ -327,27 +327,27 @@ export namespace securitycenter_v1 { /** * When compare_duration is set, the GroupResult's "state_change" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`. */ - compareDuration?: string; + compareDuration?: string | null; /** * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. */ - filter?: string; + filter?: string | null; /** * Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type */ - groupBy?: string; + groupBy?: string | null; /** * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ - pageSize?: number; + pageSize?: number | null; /** * The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data. */ - pageToken?: string; + pageToken?: string | null; /** * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ - readTime?: string; + readTime?: string | null; } /** * Response message for grouping by assets. @@ -360,15 +360,15 @@ export namespace securitycenter_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the groupBy request. */ - readTime?: string; + readTime?: string | null; /** * The total number of results matching the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Request message for grouping by findings. @@ -377,27 +377,27 @@ export namespace securitycenter_v1 { /** * When compare_duration is set, the GroupResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`. */ - compareDuration?: string; + compareDuration?: string | null; /** * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "event_time = \"2019-06-10T16:07:18-07:00\"" "event_time = 1560208038000" * security_marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. */ - filter?: string; + filter?: string | null; /** * Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: * resource_name * category * state * parent The following fields are supported when compare_duration is set: * state_change */ - groupBy?: string; + groupBy?: string | null; /** * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ - pageSize?: number; + pageSize?: number | null; /** * The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data. */ - pageToken?: string; + pageToken?: string | null; /** * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ - readTime?: string; + readTime?: string | null; } /** * Response message for group by findings. @@ -410,15 +410,15 @@ export namespace securitycenter_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the groupBy request. */ - readTime?: string; + readTime?: string | null; /** * The total number of results matching the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Result containing the properties and count of a groupBy request. @@ -427,11 +427,11 @@ export namespace securitycenter_v1 { /** * Total count of resources for the given properties. */ - count?: string; + count?: string | null; /** * Properties matching the groupBy fields in the request. */ - properties?: {[key: string]: any}; + properties?: {[key: string]: any} | null; } /** * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. @@ -440,7 +440,7 @@ export namespace securitycenter_v1 { /** * The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details. */ - policyBlob?: string; + policyBlob?: string | null; } /** * Response message for listing assets. @@ -453,15 +453,15 @@ export namespace securitycenter_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the list request. */ - readTime?: string; + readTime?: string | null; /** * The total number of assets matching the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Result containing the Asset and its State. @@ -474,7 +474,7 @@ export namespace securitycenter_v1 { /** * State change of the asset between the points in time. */ - stateChange?: string; + stateChange?: string | null; } /** * Response message for listing findings. @@ -487,15 +487,15 @@ export namespace securitycenter_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the list request. */ - readTime?: string; + readTime?: string | null; /** * The total number of findings matching the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Result containing the Finding and its StateChange. @@ -508,7 +508,7 @@ export namespace securitycenter_v1 { /** * State change of the finding between the points in time. */ - stateChange?: string; + stateChange?: string | null; } /** * The response message for Operations.ListOperations. @@ -517,7 +517,7 @@ export namespace securitycenter_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -530,7 +530,7 @@ export namespace securitycenter_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Sources belonging to the requested parent. */ @@ -543,7 +543,7 @@ export namespace securitycenter_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -551,15 +551,15 @@ export namespace securitycenter_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * User specified settings that are attached to the Cloud Security Command Center (Cloud SCC) organization. @@ -572,11 +572,11 @@ export namespace securitycenter_v1 { /** * A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur. */ - enableAssetDiscovery?: boolean; + enableAssetDiscovery?: boolean | null; /** * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". */ - name?: string; + name?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -593,11 +593,11 @@ export namespace securitycenter_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Request message for running asset discovery for an organization. @@ -610,23 +610,23 @@ export namespace securitycenter_v1 { /** * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ - resourceName?: string; + resourceName?: string | null; /** * Owners of the Google Cloud resource. */ - resourceOwners?: string[]; + resourceOwners?: string[] | null; /** * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ - resourceParent?: string; + resourceParent?: 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; + resourceProject?: string | null; /** * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. */ - resourceType?: string; + resourceType?: string | null; } /** * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. @@ -635,11 +635,11 @@ export namespace securitycenter_v1 { /** * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: - Keys and values are treated as case insensitive - Keys must be between 1 - 256 characters (inclusive) - Keys must be letters, numbers, underscores, or dashes - Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) */ - marks?: {[key: string]: string}; + marks?: {[key: string]: string} | null; /** * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ - name?: string; + name?: string | null; } /** * Request message for updating a finding's state. @@ -648,11 +648,11 @@ export namespace securitycenter_v1 { /** * The time at which the updated state takes effect. */ - startTime?: string; + startTime?: string | null; /** * The desired State of the finding. */ - state?: string; + state?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -665,7 +665,7 @@ export namespace securitycenter_v1 { /** * 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; + updateMask?: string | null; } /** * Cloud Security Command Center's (Cloud SCC) finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. @@ -674,15 +674,15 @@ export namespace securitycenter_v1 { /** * The description of the source (max of 1024 characters). Example: "Cloud Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." */ - description?: string; + description?: string | null; /** * The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). */ - displayName?: string; + displayName?: string | null; /** * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" */ - name?: string; + name?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -691,15 +691,15 @@ export namespace securitycenter_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -708,7 +708,7 @@ export namespace securitycenter_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -717,7 +717,7 @@ export namespace securitycenter_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$Organizations { diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index ef63f725047..78da748bac3 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -124,15 +124,15 @@ export namespace securitycenter_v1beta1 { /** * The time at which the asset was created in Cloud SCC. */ - createTime?: string; + createTime?: string | null; /** * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/assets/456". */ - name?: string; + name?: string | null; /** * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. */ - resourceProperties?: {[key: string]: any}; + resourceProperties?: {[key: string]: any} | null; /** * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. */ @@ -144,7 +144,7 @@ export namespace securitycenter_v1beta1 { /** * The time at which the asset was last updated, added, or deleted in Cloud SCC. */ - updateTime?: string; + updateTime?: string | null; } /** * The configuration used for Asset Discovery runs. @@ -153,11 +153,11 @@ export namespace securitycenter_v1beta1 { /** * The mode to use for filtering asset discovery. */ - inclusionMode?: string; + inclusionMode?: string | null; /** * The project ids to use for filtering asset discovery. */ - projectIds?: string[]; + projectIds?: string[] | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -170,7 +170,7 @@ export namespace securitycenter_v1beta1 { /** * 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; + 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. @@ -179,11 +179,11 @@ export namespace securitycenter_v1beta1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -196,11 +196,11 @@ export namespace securitycenter_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * The request message for Operations.CancelOperation. @@ -217,19 +217,19 @@ export namespace securitycenter_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. @@ -238,31 +238,31 @@ export namespace securitycenter_v1beta1 { /** * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ - category?: string; + category?: string | null; /** * The time at which the finding was created in Cloud SCC. */ - createTime?: string; + createTime?: string | null; /** * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. */ - eventTime?: string; + eventTime?: string | null; /** * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. */ - externalUri?: string; + externalUri?: string | null; /** * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" */ - name?: string; + name?: string | null; /** * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/123/sources/456" */ - parent?: string; + parent?: string | null; /** * The full resource name of the Google Cloud Platform (GCP) resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name This field is immutable after creation time. */ - resourceName?: string; + resourceName?: string | null; /** * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ @@ -270,11 +270,11 @@ export namespace securitycenter_v1beta1 { /** * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. */ - sourceProperties?: {[key: string]: any}; + sourceProperties?: {[key: string]: any} | null; /** * The state of the finding. */ - state?: string; + state?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -292,7 +292,7 @@ export namespace securitycenter_v1beta1 { /** * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * Response of asset discovery run @@ -301,11 +301,11 @@ export namespace securitycenter_v1beta1 { /** * The duration between asset discovery run start and end */ - duration?: string; + duration?: string | null; /** * The state of an asset discovery run. */ - state?: string; + state?: string | null; } /** * Response of asset discovery run @@ -314,11 +314,11 @@ export namespace securitycenter_v1beta1 { /** * The duration between asset discovery run start and end */ - duration?: string; + duration?: string | null; /** * The state of an asset discovery run. */ - state?: string; + state?: string | null; } /** * Request message for grouping by assets. @@ -327,27 +327,27 @@ export namespace securitycenter_v1beta1 { /** * When compare_duration is set, the Asset's "state" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state 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" values when compare_duration is specified: * "ADDED": indicates that the asset was not present before compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. This field is ignored if `state` is not a field in `group_by`. */ - compareDuration?: string; + 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 not 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. For example, `resource_properties.size = 100` is a valid filter string. */ - filter?: string; + filter?: string | null; /** * Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type */ - groupBy?: string; + groupBy?: string | null; /** * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ - pageSize?: number; + pageSize?: number | null; /** * The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data. */ - pageToken?: string; + pageToken?: string | null; /** * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ - readTime?: string; + readTime?: string | null; } /** * Response message for grouping by assets. @@ -360,11 +360,11 @@ export namespace securitycenter_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the groupBy request. */ - readTime?: string; + readTime?: string | null; } /** * Request message for grouping by findings. @@ -373,23 +373,23 @@ export namespace securitycenter_v1beta1 { /** * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string. */ - filter?: string; + filter?: string | null; /** * Expression that defines what assets fields to use for grouping (including `state`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: * resource_name * category * state * parent */ - groupBy?: string; + groupBy?: string | null; /** * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ - pageSize?: number; + pageSize?: number | null; /** * The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data. */ - pageToken?: string; + pageToken?: string | null; /** * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ - readTime?: string; + readTime?: string | null; } /** * Response message for group by findings. @@ -402,11 +402,11 @@ export namespace securitycenter_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the groupBy request. */ - readTime?: string; + readTime?: string | null; } /** * Result containing the properties and count of a groupBy request. @@ -415,11 +415,11 @@ export namespace securitycenter_v1beta1 { /** * Total count of resources for the given properties. */ - count?: string; + count?: string | null; /** * Properties matching the groupBy fields in the request. */ - properties?: {[key: string]: any}; + properties?: {[key: string]: any} | null; } /** * Response message for listing assets. @@ -432,15 +432,15 @@ export namespace securitycenter_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the list request. */ - readTime?: string; + readTime?: string | null; /** * The total number of assets matching the query. */ - totalSize?: number; + totalSize?: number | null; } /** * Result containing the Asset and its State. @@ -453,7 +453,7 @@ export namespace securitycenter_v1beta1 { /** * State of the asset. */ - state?: string; + state?: string | null; } /** * Response message for listing findings. @@ -466,15 +466,15 @@ export namespace securitycenter_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Time used for executing the list request. */ - readTime?: string; + readTime?: string | null; /** * The total number of findings matching the query. */ - totalSize?: number; + totalSize?: number | null; } /** * The response message for Operations.ListOperations. @@ -483,7 +483,7 @@ export namespace securitycenter_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -496,7 +496,7 @@ export namespace securitycenter_v1beta1 { /** * Token to retrieve the next page of results, or empty if there are no more results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Sources belonging to the requested parent. */ @@ -509,7 +509,7 @@ export namespace securitycenter_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -517,15 +517,15 @@ export namespace securitycenter_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * User specified settings that are attached to the Cloud Security Command Center (Cloud SCC) organization. @@ -538,11 +538,11 @@ export namespace securitycenter_v1beta1 { /** * A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur. */ - enableAssetDiscovery?: boolean; + enableAssetDiscovery?: boolean | null; /** * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". */ - name?: string; + name?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -559,11 +559,11 @@ export namespace securitycenter_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Request message for running asset discovery for an organization. @@ -576,23 +576,23 @@ export namespace securitycenter_v1beta1 { /** * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ - resourceName?: string; + resourceName?: string | null; /** * Owners of the Google Cloud resource. */ - resourceOwners?: string[]; + resourceOwners?: string[] | null; /** * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ - resourceParent?: string; + resourceParent?: 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; + resourceProject?: string | null; /** * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. */ - resourceType?: string; + resourceType?: string | null; } /** * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. @@ -601,11 +601,11 @@ export namespace securitycenter_v1beta1 { /** * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: - Keys and values are treated as case insensitive - Keys must be between 1 - 256 characters (inclusive) - Keys must be letters, numbers, underscores, or dashes - Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) */ - marks?: {[key: string]: string}; + marks?: {[key: string]: string} | null; /** * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ - name?: string; + name?: string | null; } /** * Request message for updating a finding's state. @@ -614,11 +614,11 @@ export namespace securitycenter_v1beta1 { /** * The time at which the updated state takes effect. */ - startTime?: string; + startTime?: string | null; /** * The desired State of the finding. */ - state?: string; + state?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -631,7 +631,7 @@ export namespace securitycenter_v1beta1 { /** * 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; + updateMask?: string | null; } /** * Cloud Security Command Center's (Cloud SCC) finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. @@ -640,15 +640,15 @@ export namespace securitycenter_v1beta1 { /** * The description of the source (max of 1024 characters). Example: "Cloud Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." */ - description?: string; + description?: string | null; /** * The source’s display name. A source’s display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). */ - displayName?: string; + displayName?: string | null; /** * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" */ - name?: string; + name?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -657,15 +657,15 @@ export namespace securitycenter_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request message for `TestIamPermissions` method. @@ -674,7 +674,7 @@ export namespace securitycenter_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -683,7 +683,7 @@ export namespace securitycenter_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$Organizations { diff --git a/src/apis/securitycenter/v1p1alpha1.ts b/src/apis/securitycenter/v1p1alpha1.ts index 01832c7eeff..980786e285c 100644 --- a/src/apis/securitycenter/v1p1alpha1.ts +++ b/src/apis/securitycenter/v1p1alpha1.ts @@ -128,11 +128,11 @@ export namespace securitycenter_v1p1alpha1 { /** * The duration between asset discovery run start and end */ - duration?: string; + duration?: string | null; /** * The state of an asset discovery run. */ - state?: string; + state?: string | null; } /** * Response of asset discovery run @@ -141,11 +141,11 @@ export namespace securitycenter_v1p1alpha1 { /** * The duration between asset discovery run start and end */ - duration?: string; + duration?: string | null; /** * The state of an asset discovery run. */ - state?: string; + state?: string | null; } /** * The response message for Operations.ListOperations. @@ -154,7 +154,7 @@ export namespace securitycenter_v1p1alpha1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -167,7 +167,7 @@ export namespace securitycenter_v1p1alpha1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -175,15 +175,15 @@ export namespace securitycenter_v1p1alpha1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -192,15 +192,15 @@ export namespace securitycenter_v1p1alpha1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Organizations { diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index 0fb97ae97f5..87c442bc347 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -128,11 +128,11 @@ export namespace servicebroker_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -145,11 +145,11 @@ export namespace servicebroker_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -167,7 +167,7 @@ export namespace servicebroker_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -176,7 +176,7 @@ export namespace servicebroker_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -185,19 +185,19 @@ export namespace servicebroker_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } export class Resource$V1 { @@ -213,7 +213,7 @@ export namespace servicebroker_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -461,7 +461,7 @@ export namespace servicebroker_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index e9cebe9eaae..df661f78a16 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -126,27 +126,27 @@ export namespace servicebroker_v1alpha1 { /** * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ - binding_id?: string; + binding_id?: string | null; /** * A JSON object that contains data for platform resources associated with the binding to be created. */ - bind_resource?: {[key: string]: any}; + bind_resource?: {[key: string]: any} | null; /** * Output only. Timestamp for when the binding was created. */ - createTime?: string; + createTime?: string | null; /** * Configuration options for the service binding. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; /** * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ - plan_id?: string; + plan_id?: string | null; /** * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ - service_id?: string; + service_id?: string | null; } /** * Response for the `CreateBinding()` method. @@ -155,27 +155,27 @@ export namespace servicebroker_v1alpha1 { /** * Credentials to use the binding. */ - credentials?: {[key: string]: any}; + credentials?: {[key: string]: any} | null; /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously. */ - operation?: string; + operation?: string | null; /** * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ - route_service_url?: string; + route_service_url?: string | null; /** * From where to read system logs. */ - syslog_drain_url?: string; + syslog_drain_url?: string | null; /** * An array of configuration for mounting volumes. */ - volume_mounts?: Array<{[key: string]: any}>; + volume_mounts?: Array<{[key: string]: any}> | null; } /** * Response for the `CreateServiceInstance()` method. @@ -184,11 +184,11 @@ export namespace servicebroker_v1alpha1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success. */ - operation?: string; + operation?: string | null; } /** * Message containing information required to activate Dashboard SSO feature. @@ -197,15 +197,15 @@ export namespace servicebroker_v1alpha1 { /** * The id of the Oauth client that the dashboard will use. */ - id?: string; + id?: string | null; /** * A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. */ - redirect_uri?: string; + redirect_uri?: string | null; /** * A secret for the dashboard client. */ - secret?: string; + secret?: string | null; } /** * Response for the `DeleteBinding()` method. @@ -214,11 +214,11 @@ export namespace servicebroker_v1alpha1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ - operation?: string; + operation?: string | null; } /** * Response for the `DeleteServiceInstance()` method. @@ -227,11 +227,11 @@ export namespace servicebroker_v1alpha1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ - operation?: string; + operation?: string | null; } /** * Response for the `GetBinding()` method. @@ -240,23 +240,23 @@ export namespace servicebroker_v1alpha1 { /** * Credentials to use the binding. */ - credentials?: {[key: string]: any}; + credentials?: {[key: string]: any} | null; /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ - route_service_url?: string; + route_service_url?: string | null; /** * From where to read system logs. */ - syslog_drain_url?: string; + syslog_drain_url?: string | null; /** * An array of configuration for mounting volumes. */ - volume_mounts?: Array<{[key: string]: any}>; + volume_mounts?: Array<{[key: string]: any}> | null; } /** * The response for the `ListBindings()` method. @@ -269,11 +269,11 @@ export namespace servicebroker_v1alpha1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for the `ListCatalog()` method. @@ -282,11 +282,11 @@ export namespace servicebroker_v1alpha1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The services available for the requested GCP project. */ @@ -299,7 +299,7 @@ export namespace servicebroker_v1alpha1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * The list of the instances in the broker. */ @@ -307,7 +307,7 @@ export namespace servicebroker_v1alpha1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Describes a long running operation, which conforms to OpenService API. @@ -316,11 +316,11 @@ export namespace servicebroker_v1alpha1 { /** * Optional description of the Operation state. */ - description?: string; + description?: string | null; /** * The state of the operation. Valid values are: "in progress", "succeeded", and "failed". */ - state?: string; + state?: string | null; } /** * Plan message describes a Service Plan. @@ -329,31 +329,31 @@ export namespace servicebroker_v1alpha1 { /** * Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed. */ - bindable?: boolean; + bindable?: boolean | null; /** * Textual description of the plan. Optional. */ - description?: string; + description?: string | null; /** * Whether the service is free. */ - free?: boolean; + free?: boolean | null; /** * ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field. */ - id?: string; + id?: string | null; /** * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). */ - name?: string; + name?: string | null; /** * Schema definitions for service instances and bindings for the plan. */ - schemas?: {[key: string]: any}; + schemas?: {[key: string]: any} | null; } /** * The resource model mostly follows the Open Service Broker API, as described here: https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md Though due to Google Specifics it has additional optional fields. @@ -362,11 +362,11 @@ export namespace servicebroker_v1alpha1 { /** * Specifies whether instances of the service can be bound to applications. Required. */ - bindable?: boolean; + bindable?: boolean | null; /** * Whether the service provides an endpoint to get service bindings. */ - binding_retrievable?: boolean; + binding_retrievable?: boolean | null; /** * Information to activate Dashboard SSO feature. */ @@ -374,23 +374,23 @@ export namespace servicebroker_v1alpha1 { /** * Textual description of the service. Required. */ - description?: string; + description?: string | null; /** * ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string. */ - id?: string; + id?: string | null; /** * Whether the service provides an endpoint to get service instances. */ - instance_retrievable?: boolean; + instance_retrievable?: boolean | null; /** * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * User friendly service name. Name must match [a-z0-9]+ regexp. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). Required. */ - name?: string; + name?: string | null; /** * A list of plans for this service. At least one plan is required. */ @@ -398,11 +398,11 @@ export namespace servicebroker_v1alpha1 { /** * Whether the service supports upgrade/downgrade for some plans. */ - plan_updateable?: boolean; + plan_updateable?: boolean | null; /** * Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service. */ - tags?: string[]; + tags?: string[] | null; } /** * Message describing inputs to Provision and Update Service instance requests. @@ -411,47 +411,47 @@ export namespace servicebroker_v1alpha1 { /** * Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information. */ - context?: {[key: string]: any}; + context?: {[key: string]: any} | null; /** * Output only. Timestamp for when the instance was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. Name of the Deployment Manager deployment used for provisioning of this service instance. */ - deploymentName?: string; + deploymentName?: string | null; /** * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ - instance_id?: string; + instance_id?: string | null; /** * The platform GUID for the organization under which the service is to be provisioned. Required. */ - organization_guid?: string; + organization_guid?: string | null; /** * Configuration options for the service instance. Parameters is JSON object serialized to string. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; /** * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ - plan_id?: string; + plan_id?: string | null; /** * Used only in UpdateServiceInstance request to optionally specify previous fields. */ - previous_values?: {[key: string]: any}; + previous_values?: {[key: string]: any} | null; /** * Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id */ - resourceName?: string; + resourceName?: string | null; /** * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ - service_id?: string; + service_id?: string | null; /** * The identifier for the project space within the platform organization. Required. */ - space_guid?: string; + space_guid?: string | null; } /** * Response for the `UpdateServiceInstance()` method. @@ -460,11 +460,11 @@ export namespace servicebroker_v1alpha1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ - operation?: string; + operation?: string | null; } /** * Associates `members` with a `role`. @@ -477,11 +477,11 @@ export namespace servicebroker_v1alpha1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -494,11 +494,11 @@ export namespace servicebroker_v1alpha1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -516,7 +516,7 @@ export namespace servicebroker_v1alpha1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -525,7 +525,7 @@ export namespace servicebroker_v1alpha1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" @@ -534,19 +534,19 @@ export namespace servicebroker_v1alpha1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } export class Resource$Projects { @@ -2304,7 +2304,7 @@ export namespace servicebroker_v1alpha1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2555,7 +2555,7 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index 553fb446be4..f8b1ea30136 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -126,35 +126,35 @@ export namespace servicebroker_v1beta1 { /** * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ - binding_id?: string; + binding_id?: string | null; /** * A JSON object that contains data for platform resources associated with the binding to be created. */ - bind_resource?: {[key: string]: any}; + bind_resource?: {[key: string]: any} | null; /** * Output only. Timestamp for when the binding was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. String containing the Deployment Manager deployment name that was created for this binding, */ - deploymentName?: string; + deploymentName?: string | null; /** * Configuration options for the service binding. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; /** * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ - plan_id?: string; + plan_id?: string | null; /** * Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. */ - resourceName?: string; + resourceName?: string | null; /** * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ - service_id?: string; + service_id?: string | null; } /** * Broker represents a consumable collection of Service Registry catalogs exposed as an OSB Broker. @@ -163,19 +163,19 @@ export namespace servicebroker_v1beta1 { /** * Output only. Timestamp for when the broker was created. */ - createTime?: string; + createTime?: string | null; /** * Name of the broker in the format: <projects>/<project-id>/brokers/<broker>. This allows for multiple brokers per project which can be used to enable having custom brokers per GKE cluster, for example. */ - name?: string; + name?: string | null; /** * User friendly title of the broker. Limited to 1024 characters. Requests with longer titles will be rejected. */ - title?: string; + title?: string | null; /** * Output only. URL of the broker OSB-compliant endpoint, for example: https://servicebroker.googleapis.com/projects/<project>/brokers/<broker> */ - url?: string; + url?: string | null; } /** * Response for the `CreateBinding()` method. @@ -184,27 +184,27 @@ export namespace servicebroker_v1beta1 { /** * Credentials to use the binding. */ - credentials?: {[key: string]: any}; + credentials?: {[key: string]: any} | null; /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously. */ - operation?: string; + operation?: string | null; /** * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ - route_service_url?: string; + route_service_url?: string | null; /** * From where to read system logs. */ - syslog_drain_url?: string; + syslog_drain_url?: string | null; /** * An array of configuration for mounting volumes. */ - volume_mounts?: Array<{[key: string]: any}>; + volume_mounts?: Array<{[key: string]: any}> | null; } /** * Response for the `CreateServiceInstance()` method. @@ -213,11 +213,11 @@ export namespace servicebroker_v1beta1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success. */ - operation?: string; + operation?: string | null; } /** * Message containing information required to activate Dashboard SSO feature. @@ -226,15 +226,15 @@ export namespace servicebroker_v1beta1 { /** * The id of the Oauth client that the dashboard will use. */ - id?: string; + id?: string | null; /** * A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. */ - redirect_uri?: string; + redirect_uri?: string | null; /** * A secret for the dashboard client. */ - secret?: string; + secret?: string | null; } /** * Response for the `DeleteBinding()` method. @@ -243,11 +243,11 @@ export namespace servicebroker_v1beta1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ - operation?: string; + operation?: string | null; } /** * Response for the `DeleteServiceInstance()` method. @@ -256,11 +256,11 @@ export namespace servicebroker_v1beta1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ - operation?: string; + operation?: string | null; } /** * Response for the `GetBinding()` method. @@ -269,31 +269,31 @@ export namespace servicebroker_v1beta1 { /** * Credentials to use the binding. */ - credentials?: {[key: string]: any}; + credentials?: {[key: string]: any} | null; /** * String containing the Deployment Manager deployment name that was created for this binding, */ - deploymentName?: string; + deploymentName?: string | null; /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. */ - resourceName?: string; + resourceName?: string | null; /** * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ - route_service_url?: string; + route_service_url?: string | null; /** * From where to read system logs. */ - syslog_drain_url?: string; + syslog_drain_url?: string | null; /** * An array of configurations for mounting volumes. */ - volume_mounts?: Array<{[key: string]: any}>; + volume_mounts?: Array<{[key: string]: any}> | null; } /** * The response for the `ListBindings()` method. @@ -306,11 +306,11 @@ export namespace servicebroker_v1beta1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for the `ListBrokers()` method. @@ -323,7 +323,7 @@ export namespace servicebroker_v1beta1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for the `ListCatalog()` method. @@ -332,11 +332,11 @@ export namespace servicebroker_v1beta1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The services available for the requested GCP project. */ @@ -349,7 +349,7 @@ export namespace servicebroker_v1beta1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * The list of instances in the broker. */ @@ -357,7 +357,7 @@ export namespace servicebroker_v1beta1 { /** * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Describes a long running operation, which conforms to OpenService API. @@ -366,11 +366,11 @@ export namespace servicebroker_v1beta1 { /** * Optional description of the Operation state. */ - description?: string; + description?: string | null; /** * The state of the operation. Valid values are: "in progress", "succeeded", and "failed". */ - state?: string; + state?: string | null; } /** * Plan message describes a Service Plan. @@ -379,31 +379,31 @@ export namespace servicebroker_v1beta1 { /** * Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed. */ - bindable?: boolean; + bindable?: boolean | null; /** * Textual description of the plan. Optional. */ - description?: string; + description?: string | null; /** * Whether the service is free. */ - free?: boolean; + free?: boolean | null; /** * ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field. */ - id?: string; + id?: string | null; /** * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). */ - name?: string; + name?: string | null; /** * Schema definitions for service instances and bindings for the plan. */ - schemas?: {[key: string]: any}; + schemas?: {[key: string]: any} | null; } /** * The resource model mostly follows the Open Service Broker API, as described here: https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md Though due to Google Specifics it has additional optional fields. @@ -412,15 +412,15 @@ export namespace servicebroker_v1beta1 { /** * Specifies whether instances of the service can be bound to applications. Required. */ - bindable?: boolean; + bindable?: boolean | null; /** * Whether the service provides an endpoint to get service bindings. */ - bindings_retrievable?: boolean; + bindings_retrievable?: boolean | null; /** * Whether the service provides an endpoint to get service bindings. */ - binding_retrievable?: boolean; + binding_retrievable?: boolean | null; /** * Information to activate Dashboard SSO feature. */ @@ -428,23 +428,23 @@ export namespace servicebroker_v1beta1 { /** * Textual description of the service. Required. */ - description?: string; + description?: string | null; /** * ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string. */ - id?: string; + id?: string | null; /** * Whether the service provides an endpoint to get service instances. */ - instances_retrievable?: boolean; + instances_retrievable?: boolean | null; /** * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * User friendly service name. Name must match [a-z0-9]+ regexp. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). Required. */ - name?: string; + name?: string | null; /** * A list of plans for this service. At least one plan is required. */ @@ -452,11 +452,11 @@ export namespace servicebroker_v1beta1 { /** * Whether the service supports upgrade/downgrade for some plans. */ - plan_updateable?: boolean; + plan_updateable?: boolean | null; /** * Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service. */ - tags?: string[]; + tags?: string[] | null; } /** * Message describing inputs to Provision and Update Service instance requests. @@ -465,51 +465,51 @@ export namespace servicebroker_v1beta1 { /** * Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information. */ - context?: {[key: string]: any}; + context?: {[key: string]: any} | null; /** * Output only. Timestamp for when the instance was created. */ - createTime?: string; + createTime?: string | null; /** * Output only. String containing the Deployment Manager deployment name that was created for this instance, */ - deploymentName?: string; + deploymentName?: string | null; /** * To return errors when GetInstance call is done via HTTP to be unified with other methods. */ - description?: string; + description?: string | null; /** * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ - instance_id?: string; + instance_id?: string | null; /** * The platform GUID for the organization under which the service is to be provisioned. Required. */ - organization_guid?: string; + organization_guid?: string | null; /** * Configuration options for the service instance. Parameters is JSON object serialized to string. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; /** * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ - plan_id?: string; + plan_id?: string | null; /** * Used only in UpdateServiceInstance request to optionally specify previous fields. */ - previous_values?: {[key: string]: any}; + previous_values?: {[key: string]: any} | null; /** * Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id */ - resourceName?: string; + resourceName?: string | null; /** * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ - service_id?: string; + service_id?: string | null; /** * The identifier for the project space within the platform organization. Required. */ - space_guid?: string; + space_guid?: string | null; } /** * Response for the `UpdateServiceInstance()` method. @@ -518,11 +518,11 @@ export namespace servicebroker_v1beta1 { /** * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ - description?: string; + description?: string | null; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ - operation?: string; + operation?: string | null; } /** * Associates `members` with a `role`. @@ -535,11 +535,11 @@ export namespace servicebroker_v1beta1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). @@ -552,11 +552,11 @@ export namespace servicebroker_v1beta1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Request message for `SetIamPolicy` method. @@ -574,7 +574,7 @@ export namespace servicebroker_v1beta1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -583,7 +583,7 @@ export namespace servicebroker_v1beta1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -596,19 +596,19 @@ export namespace servicebroker_v1beta1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } export class Resource$Projects { @@ -2857,7 +2857,7 @@ export namespace servicebroker_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3108,7 +3108,7 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 94286417f1e..ff679c71d3a 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -130,7 +130,7 @@ export namespace serviceconsumermanagement_v1 { /** * Tag of the added project. Must be less than 128 characters. Required. */ - tag?: string; + tag?: string | null; } /** * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. @@ -147,7 +147,7 @@ export namespace serviceconsumermanagement_v1 { /** * The fully qualified name of this interface, including package name followed by the interface's simple name. */ - name?: string; + name?: string | null; /** * Any metadata attached to the interface. */ @@ -159,11 +159,11 @@ export namespace serviceconsumermanagement_v1 { /** * The source syntax of the service. */ - syntax?: string; + syntax?: string | null; /** * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ - version?: string; + version?: string | null; } /** * Request to apply configuration to an existing tenant project. @@ -176,7 +176,7 @@ export namespace serviceconsumermanagement_v1 { /** * Tag of the project. Must be less than 128 characters. Required. */ - tag?: string; + tag?: string | null; } /** * Request to attach an existing project to the tenancy unit as a new tenant resource. @@ -185,15 +185,15 @@ export namespace serviceconsumermanagement_v1 { /** * When attaching an external project, this is in the format of `projects/{project_number}`. */ - externalResource?: string; + externalResource?: string | null; /** * When attaching a reserved project already in tenancy units, this is the tag of a tenant resource under the tenancy unit for the managed service's service producer project. The reserved tenant resource must be in an active state. */ - reservedResource?: string; + reservedResource?: string | null; /** * Tag of the tenant resource after attachment. Must be less than 128 characters. Required. */ - tag?: string; + tag?: string | null; } /** * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -215,7 +215,7 @@ export namespace serviceconsumermanagement_v1 { /** * If true, the service accepts API keys without any other credential. */ - allowWithoutCredential?: boolean; + allowWithoutCredential?: boolean | null; /** * The requirements for OAuth credentials. */ @@ -227,7 +227,7 @@ export namespace serviceconsumermanagement_v1 { /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -236,23 +236,23 @@ export namespace serviceconsumermanagement_v1 { /** * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ - authorizationUrl?: string; + authorizationUrl?: string | null; /** * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ - id?: string; + id?: string | null; /** * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ - issuer?: string; + issuer?: string | null; /** * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ - jwksUri?: string; + jwksUri?: string | null; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -261,11 +261,11 @@ export namespace serviceconsumermanagement_v1 { /** * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * id from authentication provider. Example: provider_id: bookstore_auth */ - providerId?: string; + providerId?: string | null; } /** * `Backend` defines the backend configuration for a service. @@ -283,28 +283,28 @@ export namespace serviceconsumermanagement_v1 { /** * The address of the API backend. */ - address?: string; + address?: string | null; /** * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ - deadline?: number; + deadline?: number | null; /** * The JWT audience is used when generating a JWT id token for the backend. */ - jwtAudience?: string; + jwtAudience?: string | null; /** * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ - minDeadline?: number; + minDeadline?: number | null; /** * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ - operationDeadline?: number; - pathTranslation?: string; + operationDeadline?: number | null; + pathTranslation?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count @@ -322,7 +322,7 @@ export namespace serviceconsumermanagement_v1 { /** * Name of the billing account. For example `billingAccounts/012345-567890-ABCDEF`. */ - billingAccount?: string; + billingAccount?: string | null; } /** * Configuration of a specific billing destination (Currently only support bill against consumer project). @@ -331,11 +331,11 @@ export namespace serviceconsumermanagement_v1 { /** * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * The request message for Operations.CancelOperation. @@ -357,23 +357,23 @@ export namespace serviceconsumermanagement_v1 { /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ - allowedRequestExtensions?: string[]; + allowedRequestExtensions?: string[] | null; /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ - allowedResponseExtensions?: string[]; + allowedResponseExtensions?: string[] | null; /** * A list of full type names of provided contexts. */ - provided?: string[]; + provided?: string[] | null; /** * A list of full type names of requested contexts. */ - requested?: string[]; + requested?: string[] | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. @@ -382,7 +382,7 @@ export namespace serviceconsumermanagement_v1 { /** * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ - environment?: string; + environment?: string | null; } /** * Request to create a tenancy unit for a service consumer of a managed service. @@ -391,7 +391,7 @@ export namespace serviceconsumermanagement_v1 { /** * Optional service producer-provided identifier of the tenancy unit. Must be no longer than 40 characters and preferably URI friendly. If it isn't provided, a UID for the tenancy unit is automatically generated. The identifier must be unique across a managed service. If the tenancy unit already exists for the managed service and service consumer pair, calling `CreateTenancyUnit` returns the existing tenancy unit if the provided identifier is identical or empty, otherwise the call fails. */ - tenancyUnitId?: string; + tenancyUnitId?: string | null; } /** * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError @@ -404,7 +404,7 @@ export namespace serviceconsumermanagement_v1 { /** * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ - types?: string[]; + types?: string[] | null; } /** * A custom error rule. @@ -413,11 +413,11 @@ export namespace serviceconsumermanagement_v1 { /** * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ - isErrorType?: boolean; + isErrorType?: boolean | null; /** * Selects messages to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A custom pattern is used for defining custom HTTP verb. @@ -426,11 +426,11 @@ export namespace serviceconsumermanagement_v1 { /** * The name of this custom HTTP verb. */ - kind?: string; + kind?: string | null; /** * The path matched by this custom verb. */ - path?: string; + path?: string | null; } /** * Request message to delete tenant project resource from the tenancy unit. @@ -439,7 +439,7 @@ export namespace serviceconsumermanagement_v1 { /** * Tag of the resource within the tenancy unit. */ - tag?: string; + tag?: 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. @@ -448,11 +448,11 @@ export namespace serviceconsumermanagement_v1 { /** * The URL to the root of documentation. */ - documentationRootUrl?: string; + documentationRootUrl?: string | null; /** * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ - overview?: string; + overview?: string | null; /** * The top level pages for the documentation set. */ @@ -464,11 +464,11 @@ export namespace serviceconsumermanagement_v1 { /** * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. */ - serviceRootUrl?: string; + serviceRootUrl?: string | null; /** * A short summary of what the service does. Can only be provided by plain text. */ - summary?: string; + summary?: string | null; } /** * A documentation rule provides information about individual API elements. @@ -477,15 +477,15 @@ export namespace serviceconsumermanagement_v1 { /** * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ - deprecationDescription?: string; + deprecationDescription?: string | null; /** * Description of the selected API(s). */ - description?: string; + description?: string | null; /** * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ - selector?: string; + selector?: 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 `{}`. @@ -498,23 +498,23 @@ export namespace serviceconsumermanagement_v1 { /** * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ - aliases?: string[]; + aliases?: string[] | null; /** * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ - allowCors?: boolean; + allowCors?: boolean | null; /** * The list of features enabled on this endpoint. */ - features?: string[]; + features?: string[] | null; /** * The canonical name of this endpoint. */ - name?: string; + name?: string | null; /** * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ - target?: string; + target?: string | null; } /** * Enum type definition. @@ -527,7 +527,7 @@ export namespace serviceconsumermanagement_v1 { /** * Enum type name. */ - name?: string; + name?: string | null; /** * Protocol buffer options. */ @@ -539,7 +539,7 @@ export namespace serviceconsumermanagement_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Enum value definition. @@ -548,11 +548,11 @@ export namespace serviceconsumermanagement_v1 { /** * Enum value name. */ - name?: string; + name?: string | null; /** * Enum value number. */ - number?: number; + number?: number | null; /** * Protocol buffer options. */ @@ -565,31 +565,31 @@ export namespace serviceconsumermanagement_v1 { /** * The field cardinality. */ - cardinality?: string; + cardinality?: string | null; /** * The string value of the default value of this field. Proto2 syntax only. */ - defaultValue?: string; + defaultValue?: string | null; /** * The field JSON name. */ - jsonName?: string; + jsonName?: string | null; /** * The field type. */ - kind?: string; + kind?: string | null; /** * The field name. */ - name?: string; + name?: string | null; /** * The field number. */ - number?: number; + number?: number | null; /** * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ - oneofIndex?: number; + oneofIndex?: number | null; /** * The protocol buffer options. */ @@ -597,11 +597,11 @@ export namespace serviceconsumermanagement_v1 { /** * Whether to use alternative packed wire representation. */ - packed?: boolean; + packed?: boolean | null; /** * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ - typeUrl?: string; + typeUrl?: string | null; } /** * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. @@ -610,7 +610,7 @@ export namespace serviceconsumermanagement_v1 { /** * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ - fullyDecodeReservedExpansion?: boolean; + fullyDecodeReservedExpansion?: boolean | null; /** * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -627,7 +627,7 @@ export namespace serviceconsumermanagement_v1 { /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ - body?: string; + body?: string | null; /** * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ @@ -635,31 +635,31 @@ export namespace serviceconsumermanagement_v1 { /** * Maps to HTTP DELETE. Used for deleting a resource. */ - delete?: string; + delete?: string | null; /** * Maps to HTTP GET. Used for listing and getting information about resources. */ - get?: string; + get?: string | null; /** * Maps to HTTP PATCH. Used for updating a resource. */ - patch?: string; + patch?: string | null; /** * Maps to HTTP POST. Used for creating a resource or performing an action. */ - post?: string; + post?: string | null; /** * Maps to HTTP PUT. Used for replacing a resource. */ - put?: string; + put?: string | null; /** * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ - responseBody?: string; + responseBody?: string | null; /** * Selects a method to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A description of a label. @@ -668,15 +668,15 @@ export namespace serviceconsumermanagement_v1 { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * The response message for Operations.ListOperations. @@ -685,7 +685,7 @@ export namespace serviceconsumermanagement_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -698,7 +698,7 @@ export namespace serviceconsumermanagement_v1 { /** * Pagination token for large results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Tenancy units matching the request. */ @@ -711,11 +711,11 @@ export namespace serviceconsumermanagement_v1 { /** * A human-readable description of this log. This information appears in the documentation and can contain details. */ - description?: string; + description?: string | null; /** * The human-readable name for this log. This information appears on the user interface and should be concise. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ @@ -723,7 +723,7 @@ export namespace serviceconsumermanagement_v1 { /** * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ - name?: string; + name?: string | null; } /** * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history @@ -745,11 +745,11 @@ export namespace serviceconsumermanagement_v1 { /** * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ - logs?: string[]; + logs?: string[] | null; /** * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * Method represents a method of an API interface. @@ -758,7 +758,7 @@ export namespace serviceconsumermanagement_v1 { /** * The simple name of this method. */ - name?: string; + name?: string | null; /** * Any metadata attached to the method. */ @@ -766,23 +766,23 @@ export namespace serviceconsumermanagement_v1 { /** * If true, the request is streamed. */ - requestStreaming?: boolean; + requestStreaming?: boolean | null; /** * A URL of the input message type. */ - requestTypeUrl?: string; + requestTypeUrl?: string | null; /** * If true, the response is streamed. */ - responseStreaming?: boolean; + responseStreaming?: boolean | null; /** * The URL of the output message type. */ - responseTypeUrl?: string; + responseTypeUrl?: string | null; /** * The source syntax of this method. */ - syntax?: string; + syntax?: string | null; } /** * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. @@ -791,11 +791,11 @@ export namespace serviceconsumermanagement_v1 { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ @@ -803,7 +803,7 @@ export namespace serviceconsumermanagement_v1 { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -811,23 +811,23 @@ export namespace serviceconsumermanagement_v1 { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -836,15 +836,15 @@ export namespace serviceconsumermanagement_v1 { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -853,11 +853,11 @@ export namespace serviceconsumermanagement_v1 { /** * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ - metricCosts?: {[key: string]: string}; + metricCosts?: {[key: string]: string} | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } @@ -866,11 +866,11 @@ export namespace serviceconsumermanagement_v1 { /** * The fully qualified name of the interface which is included. */ - name?: string; + name?: string | null; /** * If non-empty specifies a path under which inherited HTTP paths are rooted. */ - root?: string; + root?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. @@ -879,11 +879,11 @@ export namespace serviceconsumermanagement_v1 { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ @@ -891,15 +891,15 @@ export namespace serviceconsumermanagement_v1 { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count @@ -921,11 +921,11 @@ export namespace serviceconsumermanagement_v1 { /** * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. @@ -934,7 +934,7 @@ export namespace serviceconsumermanagement_v1 { /** * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ - canonicalScopes?: string; + canonicalScopes?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -943,7 +943,7 @@ export namespace serviceconsumermanagement_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -951,15 +951,15 @@ export namespace serviceconsumermanagement_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A protocol buffer option, which can be attached to a message, field, enumeration, etc. @@ -968,11 +968,11 @@ export namespace serviceconsumermanagement_v1 { /** * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ - name?: string; + name?: string | null; /** * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ - value?: {[key: string]: any}; + value?: {[key: string]: any} | null; } /** * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. @@ -981,11 +981,11 @@ export namespace serviceconsumermanagement_v1 { /** * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ - content?: string; + content?: string | null; /** * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ - name?: string; + name?: string | null; /** * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ @@ -998,11 +998,11 @@ export namespace serviceconsumermanagement_v1 { /** * Uses the same format as in IAM policy. `member` must include both a prefix and ID. For example, `user:{emailId}`, `serviceAccount:{emailId}`, `group:{emailId}`. */ - members?: string[]; + members?: string[] | null; /** * Role. (https://cloud.google.com/iam/docs/understanding-roles) For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 @@ -1024,43 +1024,43 @@ export namespace serviceconsumermanagement_v1 { /** * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ - defaultLimit?: string; + defaultLimit?: string | null; /** * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ - description?: string; + description?: string | null; /** * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ - displayName?: string; + displayName?: string | null; /** - * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. + * Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */ - duration?: string; + duration?: string | null; /** * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ - freeTier?: string; + freeTier?: string | null; /** * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ - maxLimit?: string; + maxLimit?: string | null; /** * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ - metric?: string; + metric?: string | null; /** * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ - name?: string; + name?: string | null; /** * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ - unit?: string; + unit?: string | null; /** * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ - values?: {[key: string]: string}; + values?: {[key: string]: string} | null; } /** * Request message to remove a tenant project resource from the tenancy unit. @@ -1069,7 +1069,7 @@ export namespace serviceconsumermanagement_v1 { /** * Tag of the resource within the tenancy unit. */ - tag?: string; + tag?: string | null; } /** * Response for the search query. @@ -1078,7 +1078,7 @@ export namespace serviceconsumermanagement_v1 { /** * Pagination token for large results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Tenancy Units matching the request. */ @@ -1107,7 +1107,7 @@ export namespace serviceconsumermanagement_v1 { /** * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ - configVersion?: number; + configVersion?: number | null; /** * Context configuration. */ @@ -1139,7 +1139,7 @@ export namespace serviceconsumermanagement_v1 { /** * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ - id?: string; + id?: string | null; /** * Logging configuration. */ @@ -1163,11 +1163,11 @@ export namespace serviceconsumermanagement_v1 { /** * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ - name?: string; + name?: string | null; /** * The Google project that owns this service. */ - producerProjectId?: string; + producerProjectId?: string | null; /** * Quota configuration. */ @@ -1187,7 +1187,7 @@ export namespace serviceconsumermanagement_v1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ @@ -1204,11 +1204,11 @@ export namespace serviceconsumermanagement_v1 { /** * ID of the IAM service account to be created in tenant project. The email format of the service account is "<account-id>@<tenant-project-id>.iam.gserviceaccount.com". This account ID must be unique within tenant project and service producers have to guarantee it. The ID must be 6-30 characters long, and match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`. */ - accountId?: string; + accountId?: string | null; /** * Roles for the associated service account for the tenant project. */ - tenantProjectRoles?: string[]; + tenantProjectRoles?: string[] | null; } /** * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. @@ -1217,7 +1217,7 @@ export namespace serviceconsumermanagement_v1 { /** * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ - fileName?: string; + fileName?: string | null; } /** * Source information used to create a Service Config @@ -1226,7 +1226,7 @@ export namespace serviceconsumermanagement_v1 { /** * All files used during config generation. */ - sourceFiles?: Array<{[key: string]: any}>; + sourceFiles?: Array<{[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). @@ -1235,15 +1235,15 @@ export namespace serviceconsumermanagement_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. @@ -1252,15 +1252,15 @@ export namespace serviceconsumermanagement_v1 { /** * Define the HTTP header name to use for the parameter. It is case insensitive. */ - httpHeader?: string; + httpHeader?: string | null; /** * Define the name of the parameter, such as "api_key" . It is case sensitive. */ - name?: string; + name?: string | null; /** * Define the URL query parameter name to use for the parameter. It is case sensitive. */ - urlQueryParameter?: string; + urlQueryParameter?: string | null; } /** * Define a system parameter rule mapping system parameter definitions to methods. @@ -1273,7 +1273,7 @@ export namespace serviceconsumermanagement_v1 { /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. @@ -1291,19 +1291,19 @@ export namespace serviceconsumermanagement_v1 { /** * @OutputOnly Cloud resource name of the consumer of this service. For example 'projects/123456'. */ - consumer?: string; + consumer?: string | null; /** * @OutputOnly The time this tenancy unit was created. */ - createTime?: string; + createTime?: string | null; /** * Globally unique identifier of this tenancy unit "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}" */ - name?: string; + name?: string | null; /** * Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. */ - service?: string; + service?: string | null; /** * Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. */ @@ -1320,11 +1320,11 @@ export namespace serviceconsumermanagement_v1 { /** * Folder where project in this tenancy unit must be located This folder must have been previously created with the required permissions for the caller to create and configure a project in it. Valid folder resource names have the format `folders/{folder_number}` (for example, `folders/123456`). */ - folder?: string; + folder?: string | null; /** * Labels that are applied to this project. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Configuration for the IAM service account on the tenant project. */ @@ -1332,7 +1332,7 @@ export namespace serviceconsumermanagement_v1 { /** * Google Cloud API names of services that are activated on this project during provisioning. If any of these services can't be activated, the request fails. For example: 'compute.googleapis.com','cloudfunctions.googleapis.com' */ - services?: string[]; + services?: string[] | null; /** * Describes ownership and policies for the new tenant project. Required. */ @@ -1354,15 +1354,15 @@ export namespace serviceconsumermanagement_v1 { /** * @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. */ - resource?: string; + resource?: string | null; /** * Status of tenant resource. */ - status?: string; + status?: string | null; /** * Unique per single tenancy unit. */ - tag?: string; + tag?: string | null; } /** * A protocol buffer message type. @@ -1375,11 +1375,11 @@ export namespace serviceconsumermanagement_v1 { /** * The fully qualified message name. */ - name?: string; + name?: string | null; /** * The list of types appearing in `oneof` definitions in this type. */ - oneofs?: string[]; + oneofs?: string[] | null; /** * The protocol buffer options. */ @@ -1391,7 +1391,7 @@ export namespace serviceconsumermanagement_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Request message to undelete tenant project resource previously deleted from the tenancy unit. @@ -1400,7 +1400,7 @@ export namespace serviceconsumermanagement_v1 { /** * Tag of the resource within the tenancy unit. */ - tag?: string; + tag?: string | null; } /** * Configuration controlling usage of a service. @@ -1409,11 +1409,11 @@ export namespace serviceconsumermanagement_v1 { /** * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ - producerNotificationChannel?: string; + producerNotificationChannel?: string | null; /** * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ - requirements?: string[]; + requirements?: string[] | null; /** * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -1426,15 +1426,15 @@ export namespace serviceconsumermanagement_v1 { /** * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ - allowUnregisteredCalls?: boolean; + allowUnregisteredCalls?: boolean | null; /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; /** * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ - skipServiceControl?: boolean; + skipServiceControl?: boolean | null; } /** * Response message for the `AddVisibilityLabels` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. @@ -1443,7 +1443,7 @@ export namespace serviceconsumermanagement_v1 { /** * The updated set of visibility labels for this consumer on this service. */ - labels?: string[]; + labels?: string[] | null; } /** * Response message for BatchCreateProducerOverrides @@ -1478,23 +1478,23 @@ export namespace serviceconsumermanagement_v1 { /** * If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: - Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. - "project" is not a valid key; the project is already specified in the parent resource name. - "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. - If "region" appears as a key, its value must be a valid Cloud region. - If "zone" appears as a key, its value must be a valid Cloud zone. - If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. */ - dimensions?: {[key: string]: string}; + dimensions?: {[key: string]: string} | null; /** * The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` */ - metric?: string; + metric?: string | null; /** * The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` */ - name?: string; + name?: string | null; /** * The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */ - overrideValue?: string; + overrideValue?: string | null; /** * The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. */ - unit?: string; + unit?: string | null; } /** * Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. @@ -1528,7 +1528,7 @@ export namespace serviceconsumermanagement_v1 { /** * The updated set of visibility labels for this consumer on this service. */ - labels?: string[]; + labels?: string[] | null; } /** * A service account in the Identity and Access Management API. @@ -1537,23 +1537,23 @@ export namespace serviceconsumermanagement_v1 { /** * The email address of the service account. */ - email?: string; + email?: string | null; /** * Deprecated. See b/136209818. */ - iamAccountName?: string; + iamAccountName?: string | null; /** * P4 SA resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` */ - name?: string; + name?: string | null; /** * The P4 SA configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to "default". */ - tag?: string; + tag?: string | null; /** * The unique and stable id of the service account. */ - uniqueId?: string; + uniqueId?: string | null; } export class Resource$Operations { diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index aedf3488fc4..240642d373b 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -121,7 +121,7 @@ export namespace servicecontrol_v1 { /** * A list of label keys that were unused by the server in processing the request. Thus, for similar requests repeated in a certain future time window, the caller can choose to ignore these labels in the requests to achieve better client-side cache hits and quota aggregation for rate quota. This field is not populated for allocation quota checks. */ - unusedArguments?: string[]; + unusedArguments?: string[] | null; } /** * Request message for the AllocateQuota method. @@ -134,7 +134,7 @@ export namespace servicecontrol_v1 { /** * Specifies which version of service configuration should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. */ - serviceConfigId?: string; + serviceConfigId?: string | null; } /** * Response message for the AllocateQuota method. @@ -151,7 +151,7 @@ export namespace servicecontrol_v1 { /** * The same operation_id value used in the AllocateQuotaRequest. Used for logging and diagnostics purposes. */ - operationId?: string; + operationId?: string | null; /** * Quota metrics to indicate the result of allocation. Depending on the request, one or more of the following metrics will be included: 1. Per quota group or per quota metric incremental usage will be specified using the following delta metric : "serviceruntime.googleapis.com/api/consumer/quota_used_count" 2. The quota limit reached condition will be specified using the following boolean metric : "serviceruntime.googleapis.com/quota/exceeded" */ @@ -159,7 +159,7 @@ export namespace servicecontrol_v1 { /** * ID of the actual config used to process the request. */ - serviceConfigId?: string; + serviceConfigId?: string | null; } /** * Common audit log format for Google Cloud Platform API operations. @@ -176,19 +176,19 @@ export namespace servicecontrol_v1 { /** * Other service-specific data about the request, response, and other information associated with the current audited event. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The name of the service method or operation. For API calls, this should be the name of the API method. For example, "google.datastore.v1.Datastore.RunQuery" "google.logging.v1.LoggingService.DeleteLog" */ - methodName?: string; + methodName?: string | null; /** * The number of items returned from a List or Query API method, if applicable. */ - numResponseItems?: string; + numResponseItems?: string | null; /** * The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ - request?: {[key: string]: any}; + request?: {[key: string]: any} | null; /** * Metadata about the operation. */ @@ -200,23 +200,23 @@ export namespace servicecontrol_v1 { /** * The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example: "shelves/SHELF_ID/books" "shelves/SHELF_ID/books/BOOK_ID" */ - resourceName?: string; + resourceName?: string | null; /** * The resource's original state before mutation. Present only for operations which have successfully modified the targeted resource(s). In general, this field should contain all changed fields, except those that are already been included in `request`, `response`, `metadata` or `service_data` fields. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ - resourceOriginalState?: {[key: string]: any}; + resourceOriginalState?: {[key: string]: any} | null; /** * The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; /** * Deprecated, use `metadata` field instead. Other service-specific data about the request, response, and other activities. */ - serviceData?: {[key: string]: any}; + serviceData?: {[key: string]: any} | null; /** * The name of the API service performing the operation. For example, `"datastore.googleapis.com"`. */ - serviceName?: string; + serviceName?: string | null; /** * The status of the overall operation. */ @@ -229,23 +229,23 @@ export namespace servicecontrol_v1 { /** * A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL" */ - accessLevels?: string[]; + accessLevels?: string[] | null; /** * The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential such as ["pubsub.googleapis.com", "storage.googleapis.com"] * A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"] * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided. */ - audiences?: string[]; + audiences?: string[] | null; /** * Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure. */ - claims?: {[key: string]: any}; + claims?: {[key: string]: any} | null; /** * The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com". */ - presenter?: string; + presenter?: string | null; /** * The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}" */ - principal?: string; + principal?: string | null; } /** * Authentication information for the operation. @@ -254,11 +254,11 @@ export namespace servicecontrol_v1 { /** * The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority. */ - authoritySelector?: string; + authoritySelector?: string | null; /** * The email address of the authenticated user (or service account on behalf of third party principal) making the request. For privacy reasons, the principal email address is redacted for all read-only operations that fail with a "permission denied" error. */ - principalEmail?: string; + principalEmail?: string | null; /** * Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. */ @@ -266,11 +266,11 @@ export namespace servicecontrol_v1 { /** * The name of the service account key used to create or exchange credentials for authenticating the service account making the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}" */ - serviceAccountKeyName?: string; + serviceAccountKeyName?: string | null; /** * The third party identification (if any) of the authenticated user making the request. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ - thirdPartyPrincipal?: {[key: string]: any}; + thirdPartyPrincipal?: {[key: string]: any} | null; } /** * Authorization information for the operation. @@ -279,15 +279,15 @@ export namespace servicecontrol_v1 { /** * Whether or not authorization for `resource` and `permission` was granted. */ - granted?: boolean; + granted?: boolean | null; /** * The required IAM permission. */ - permission?: string; + permission?: string | null; /** * The resource being accessed, as a REST-style string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID */ - resource?: string; + resource?: string | null; /** * Resource attributes used in IAM condition evaluation. This field contains resource attributes like resource type and resource name. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into `AuditLog.request_metadata.request_attributes`. */ @@ -300,11 +300,11 @@ export namespace servicecontrol_v1 { /** * The error code. */ - code?: string; + code?: string | null; /** * Free-form text providing details on the error cause of the error. */ - detail?: string; + detail?: string | null; /** * Contains public information about the check error. If available, `status.code` will be non zero and client can propagate it out as public error. */ @@ -312,7 +312,7 @@ export namespace servicecontrol_v1 { /** * Subject to whom this error applies. See the specific code enum for more details on this field. For example: - “project:<project-id or project-number>” - “folder:<folder-id>” - “organization:<organization-id>” */ - subject?: string; + subject?: string | null; } /** * Contains additional information about the check operation. @@ -325,7 +325,7 @@ export namespace servicecontrol_v1 { /** * A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation. */ - unusedArguments?: string[]; + unusedArguments?: string[] | null; } /** * Request message for the Check method. @@ -338,15 +338,15 @@ export namespace servicecontrol_v1 { /** * Requests the project settings to be returned as part of the check response. */ - requestProjectSettings?: boolean; + requestProjectSettings?: boolean | null; /** * Specifies which version of service configuration should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. */ - serviceConfigId?: string; + serviceConfigId?: string | null; /** * Indicates if service activation check should be skipped for this request. Default behavior is to perform the check and apply relevant quota. WARNING: Setting this flag to "true" will disable quota enforcement. */ - skipActivationCheck?: boolean; + skipActivationCheck?: boolean | null; } /** * Response message for the Check method. @@ -363,7 +363,7 @@ export namespace servicecontrol_v1 { /** * The same operation_id value used in the CheckRequest. Used for logging and diagnostics purposes. */ - operationId?: string; + operationId?: string | null; /** * Quota information for the check request associated with this response. */ @@ -371,11 +371,11 @@ export namespace servicecontrol_v1 { /** * The actual config id used to process the request. */ - serviceConfigId?: string; + serviceConfigId?: string | null; /** * Unimplemented. The current service rollout id used to process the request. */ - serviceRolloutId?: string; + serviceRolloutId?: string | null; } /** * `ConsumerInfo` provides information about the consumer. @@ -384,15 +384,15 @@ export namespace servicecontrol_v1 { /** * The consumer identity number, can be Google cloud project number, folder number or organization number e.g. 1234567890. A value of 0 indicates no consumer number is found. */ - consumerNumber?: string; + consumerNumber?: string | null; /** * The Google cloud project number, e.g. 1234567890. A value of 0 indicates no project number is found. NOTE: This field is deprecated after Chemist support flexible consumer id. New code should not depend on this field anymore. */ - projectNumber?: string; + projectNumber?: string | null; /** * The type of the consumer which should have been defined in [Google Resource Manager](https://cloud.google.com/resource-manager/). */ - type?: string; + type?: string | null; } /** * Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information: - the arithmetic mean of the samples - the minimum and maximum of the samples - the sum-squared-deviation of the samples, used to compute variance - a histogram of the values of the sample points @@ -401,11 +401,11 @@ export namespace servicecontrol_v1 { /** * The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted. */ - bucketCounts?: string[]; + bucketCounts?: string[] | null; /** * The total number of samples in the distribution. Must be >= 0. */ - count?: string; + count?: string | null; /** * Example points. Must be in increasing order of `value` field. */ @@ -425,19 +425,19 @@ export namespace servicecontrol_v1 { /** * The maximum of the population of values. Ignored if `count` is zero. */ - maximum?: number; + maximum?: number | null; /** * The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero. */ - mean?: number; + mean?: number | null; /** * The minimum of the population of values. Ignored if `count` is zero. */ - minimum?: number; + minimum?: number | null; /** * The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails. */ - sumOfSquaredDeviation?: number; + sumOfSquaredDeviation?: number | null; } /** * Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc. @@ -446,15 +446,15 @@ export namespace servicecontrol_v1 { /** * Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. */ - attachments?: Array<{[key: string]: any}>; + attachments?: Array<{[key: string]: any}> | null; /** * The observation (sampling) time of the above value. */ - timestamp?: string; + timestamp?: string | null; /** * Value of the exemplar point. This value determines to which bucket the exemplar belongs. */ - value?: number; + value?: number | null; } /** * Describing buckets with arbitrary user-provided width. @@ -463,7 +463,7 @@ export namespace servicecontrol_v1 { /** * 'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on `bucket_options` for details. The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf */ - bounds?: number[]; + bounds?: number[] | null; } /** * Describing buckets with exponentially growing width. @@ -472,15 +472,15 @@ export namespace servicecontrol_v1 { /** * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0. */ - growthFactor?: number; + growthFactor?: number | null; /** * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. */ - numFiniteBuckets?: number; + numFiniteBuckets?: number | null; /** * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0. */ - scale?: number; + scale?: number | null; } /** * First party identity principal. @@ -489,11 +489,11 @@ export namespace servicecontrol_v1 { /** * The email address of a Google account. . */ - principalEmail?: string; + principalEmail?: string | null; /** * Metadata about the service that uses the service account. . */ - serviceMetadata?: {[key: string]: any}; + serviceMetadata?: {[key: string]: any} | null; } /** * A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. @@ -502,63 +502,63 @@ export namespace servicecontrol_v1 { /** * The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. */ - cacheFillBytes?: string; + cacheFillBytes?: string | null; /** * Whether or not an entity was served from cache (with or without validation). */ - cacheHit?: boolean; + cacheHit?: boolean | null; /** * Whether or not a cache lookup was attempted. */ - cacheLookup?: boolean; + cacheLookup?: boolean | null; /** * Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True. */ - cacheValidatedWithOriginServer?: boolean; + cacheValidatedWithOriginServer?: boolean | null; /** * The request processing latency on the server, from the time the request was received until the response was sent. */ - latency?: string; + latency?: string | null; /** * Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" */ - protocol?: string; + protocol?: string | null; /** * The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). */ - referer?: string; + referer?: string | null; /** * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`. */ - remoteIp?: string; + remoteIp?: string | null; /** * The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`. */ - requestMethod?: string; + requestMethod?: string | null; /** * The size of the HTTP request message in bytes, including the request headers and the request body. */ - requestSize?: string; + requestSize?: string | null; /** * The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`. */ - requestUrl?: string; + requestUrl?: string | null; /** * The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. */ - responseSize?: string; + responseSize?: string | null; /** * The IP address (IPv4 or IPv6) of the origin server that the request was sent to. */ - serverIp?: string; + serverIp?: string | null; /** * The response code indicating the status of the response. Examples: 200, 404. */ - status?: number; + status?: number | null; /** * The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`. */ - userAgent?: string; + userAgent?: string | null; } /** * Describing buckets with constant width. @@ -567,15 +567,15 @@ export namespace servicecontrol_v1 { /** * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. */ - numFiniteBuckets?: number; + numFiniteBuckets?: number | null; /** * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. */ - offset?: number; + offset?: number | null; /** * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive. */ - width?: number; + width?: number | null; } /** * An individual log entry. @@ -588,15 +588,15 @@ export namespace servicecontrol_v1 { /** * A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id. */ - insertId?: string; + insertId?: string | null; /** * A set of user-defined (key, value) data that provides additional information about the log entry. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. The log to which this log entry belongs. Examples: `"syslog"`, `"book_log"`. */ - name?: string; + name?: string | null; /** * Optional. Information about an operation associated with the log entry, if applicable. */ @@ -604,11 +604,11 @@ export namespace servicecontrol_v1 { /** * The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog. */ - protoPayload?: {[key: string]: any}; + protoPayload?: {[key: string]: any} | null; /** * The severity of the log entry. The default value is `LogSeverity.DEFAULT`. */ - severity?: string; + severity?: string | null; /** * Optional. Source code location information associated with the log entry, if any. */ @@ -616,19 +616,19 @@ export namespace servicecontrol_v1 { /** * The log entry payload, represented as a structure that is expressed as a JSON object. */ - structPayload?: {[key: string]: any}; + structPayload?: {[key: string]: any} | null; /** * The log entry payload, represented as a Unicode string (UTF-8). */ - textPayload?: string; + textPayload?: string | null; /** * The time the event described by the log entry occurred. If omitted, defaults to operation start time. */ - timestamp?: string; + timestamp?: string | null; /** * Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824` */ - trace?: string; + trace?: string | null; } /** * Additional information about a potentially long-running operation with which a log entry is associated. @@ -637,19 +637,19 @@ export namespace servicecontrol_v1 { /** * Optional. Set this to True if this is the first log entry in the operation. */ - first?: boolean; + first?: boolean | null; /** * Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. */ - id?: string; + id?: string | null; /** * Optional. Set this to True if this is the last log entry in the operation. */ - last?: boolean; + last?: boolean | null; /** * Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`. */ - producer?: string; + producer?: string | null; } /** * Additional information about the source code location that produced the log entry. @@ -658,15 +658,15 @@ export namespace servicecontrol_v1 { /** * Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. */ - file?: string; + file?: string | null; /** * Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python). */ - function?: string; + function?: string | null; /** * Optional. Line within the source file. 1-based; 0 indicates no line number available. */ - line?: string; + line?: string | null; } /** * Represents a single metric value. @@ -675,7 +675,7 @@ export namespace servicecontrol_v1 { /** * A boolean value. */ - boolValue?: boolean; + boolValue?: boolean | null; /** * A distribution value. */ @@ -683,19 +683,19 @@ export namespace servicecontrol_v1 { /** * A double precision floating point value. */ - doubleValue?: number; + doubleValue?: number | null; /** * The end of the time period over which this metric value's measurement applies. */ - endTime?: string; + endTime?: string | null; /** * A signed 64-bit integer value. */ - int64Value?: string; + int64Value?: string | null; /** * The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * A money value. */ @@ -703,11 +703,11 @@ export namespace servicecontrol_v1 { /** * The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. */ - startTime?: string; + startTime?: string | null; /** * A text string value. */ - stringValue?: string; + stringValue?: string | null; } /** * Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values. @@ -716,7 +716,7 @@ export namespace servicecontrol_v1 { /** * The metric name defined in the service configuration. */ - metricName?: string; + metricName?: string | null; /** * The values in this metric. */ @@ -729,15 +729,15 @@ export namespace servicecontrol_v1 { /** * The 3-letter currency code defined in ISO 4217. */ - currencyCode?: string; + currencyCode?: string | null; /** * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ - nanos?: number; + nanos?: number | null; /** * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ - units?: string; + units?: string | null; } /** * Represents information regarding an operation. @@ -746,19 +746,19 @@ export namespace servicecontrol_v1 { /** * Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY. */ - consumerId?: string; + consumerId?: string | null; /** * End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check. */ - endTime?: string; + endTime?: string | null; /** * DO NOT USE. This is an experimental field. */ - importance?: string; + importance?: string | null; /** * Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Represents information to be logged. */ @@ -770,11 +770,11 @@ export namespace servicecontrol_v1 { /** * Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. */ - operationId?: string; + operationId?: string | null; /** * Fully qualified name of the operation. Reserved for future use. */ - operationName?: string; + operationName?: string | null; /** * Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed. */ @@ -782,7 +782,7 @@ export namespace servicecontrol_v1 { /** * DO NOT USE. This field is deprecated, use "resources" field instead. The resource name of the parent of a resource in the resource hierarchy. This can be in one of the following formats: - “projects/<project-id or project-number>” - “folders/<folder-id>” - “organizations/<organization-id>” */ - resourceContainer?: string; + resourceContainer?: string | null; /** * The resources that are involved in the operation. The maximum supported number of entries in this field is 100. */ @@ -790,11 +790,11 @@ export namespace servicecontrol_v1 { /** * Required. Start time of the operation. */ - startTime?: string; + startTime?: string | null; /** * User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed. */ - userLabels?: {[key: string]: string}; + userLabels?: {[key: string]: string} | null; } /** * This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. @@ -803,23 +803,23 @@ export namespace servicecontrol_v1 { /** * The IP address of the peer. */ - ip?: string; + ip?: string | null; /** * The labels associated with the peer. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The network port of the peer. */ - port?: string; + port?: string | null; /** * The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request. */ - principal?: string; + principal?: string | null; /** * The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running. */ - regionCode?: string; + regionCode?: string | null; } /** * Represents error information for QuotaOperation. @@ -828,15 +828,15 @@ export namespace servicecontrol_v1 { /** * Error code. */ - code?: string; + code?: string | null; /** * Free-form text that provides details on the cause of the error. */ - description?: string; + description?: string | null; /** * Subject to whom this error applies. See the specific enum for more details on this field. For example, "clientip:<ip address of client>" or "project:<Google developer project id>". */ - subject?: string; + subject?: string | null; } /** * Contains the quota information for a quota check response. @@ -845,11 +845,11 @@ export namespace servicecontrol_v1 { /** * Quota Metrics that have exceeded quota limits. For QuotaGroup-based quota, this is QuotaGroup.name For QuotaLimit-based quota, this is QuotaLimit.name See: google.api.Quota Deprecated: Use quota_metrics to get per quota group limit exceeded status. */ - limitExceeded?: string[]; + limitExceeded?: string[] | null; /** * Map of quota group name to the actual number of tokens consumed. If the quota check was not successful, then this will not be populated due to no quota consumption. We are not merging this field with 'quota_metrics' field because of the complexity of scaling in Chemist client code base. For simplicity, we will keep this field for Castor (that scales quota usage) and 'quota_metrics' for SuperQuota (that doesn't scale quota usage). */ - quotaConsumed?: {[key: string]: number}; + quotaConsumed?: {[key: string]: number} | null; /** * Quota metrics to indicate the usage. Depending on the check request, one or more of the following metrics will be included: 1. For rate quota, per quota group or per quota metric incremental usage will be specified using the following delta metric: "serviceruntime.googleapis.com/api/consumer/quota_used_count" 2. For allocation quota, per quota metric total usage will be specified using the following gauge metric: "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" 3. For both rate quota and allocation quota, the quota limit reached condition will be specified using the following boolean metric: "serviceruntime.googleapis.com/quota/exceeded" */ @@ -862,19 +862,19 @@ export namespace servicecontrol_v1 { /** * Identity of the consumer for whom this quota operation is being performed. This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>. */ - consumerId?: string; + consumerId?: string | null; /** * Labels describing the operation. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration. This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override. Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf */ - methodName?: string; + methodName?: string | null; /** * Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. */ - operationId?: string; + operationId?: string | null; /** * Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error. This field is mutually exclusive with method_name. */ @@ -882,7 +882,7 @@ export namespace servicecontrol_v1 { /** * Quota mode for this operation. */ - quotaMode?: string; + quotaMode?: string | null; } /** * Represents the properties needed for quota operations. @@ -891,7 +891,7 @@ export namespace servicecontrol_v1 { /** * Quota mode for this operation. */ - quotaMode?: string; + quotaMode?: string | null; } /** * Represents the processing error of one Operation in the request. @@ -900,7 +900,7 @@ export namespace servicecontrol_v1 { /** * The Operation.operation_id value from the request. */ - operationId?: string; + operationId?: string | null; /** * Details of the error when processing the Operation. */ @@ -913,7 +913,7 @@ export namespace servicecontrol_v1 { /** * The Operation.operation_id value from the request. */ - operationId?: string; + operationId?: string | null; /** * Quota usage info when processing the `Operation`. */ @@ -930,7 +930,7 @@ export namespace servicecontrol_v1 { /** * Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. */ - serviceConfigId?: string; + serviceConfigId?: string | null; } /** * Response message for the Report method. @@ -947,11 +947,11 @@ export namespace servicecontrol_v1 { /** * The actual config id used to process the request. */ - serviceConfigId?: string; + serviceConfigId?: string | null; /** * Unimplemented. The current service rollout id used to process the request. */ - serviceRolloutId?: string; + serviceRolloutId?: string | null; } /** * This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. @@ -964,47 +964,47 @@ export namespace servicecontrol_v1 { /** * The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive. */ - headers?: {[key: string]: string}; + headers?: {[key: string]: string} | null; /** * The HTTP request `Host` header value. */ - host?: string; + host?: string | null; /** * The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service. */ - id?: string; + id?: string | null; /** * The HTTP request method, such as `GET`, `POST`. */ - method?: string; + method?: string | null; /** * The HTTP URL path. */ - path?: string; + path?: string | null; /** * The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details. */ - protocol?: string; + 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. */ - query?: string; + query?: string | null; /** * A special parameter for request reason. It is used by security systems to associate auditing information with a request. */ - reason?: string; + reason?: string | null; /** * The HTTP URL scheme, such as `http` and `https`. */ - scheme?: string; + scheme?: string | null; /** * The HTTP request size in bytes. If unknown, it must be -1. */ - size?: string; + size?: string | null; /** * The timestamp when the `destination` service receives the first byte of the request. */ - time?: string; + time?: string | null; } /** * Metadata about the request. @@ -1013,15 +1013,15 @@ export namespace servicecontrol_v1 { /** * The IP address of the caller. For caller from internet, this will be public IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP address, this will be the VM's external IP address. For caller from a Compute Engine VM without external IP address, if the VM is in the same organization (or project) as the accessed resource, `caller_ip` will be the VM's internal IPv4 address, otherwise the `caller_ip` will be redacted to "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more information. */ - callerIp?: string; + callerIp?: string | null; /** * The network of the caller. Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example: "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID" */ - callerNetwork?: string; + callerNetwork?: string | null; /** * The user agent of the caller. This information is not authenticated and should be treated accordingly. For example: + `google-api-python-client/1.4.0`: The request was made by the Google API client for Python. + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`: The request was made by the Google Cloud SDK CLI (gcloud). + `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`: The request was made from the `my-project` App Engine app. NOLINT */ - callerSuppliedUserAgent?: string; + callerSuppliedUserAgent?: string | null; /** * The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature. */ @@ -1038,19 +1038,19 @@ export namespace servicecontrol_v1 { /** * The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details. */ - name?: string; + name?: string | null; /** * The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request. */ - service?: string; + service?: string | null; /** * The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}". */ - type?: string; + type?: string | null; } /** * Describes a resource associated with this operation. @@ -1059,15 +1059,15 @@ export namespace servicecontrol_v1 { /** * The identifier of the parent of this resource instance. Must be in one of the following formats: - “projects/<project-id or project-number>” - “folders/<folder-id>” - “organizations/<organization-id>” */ - resourceContainer?: string; + resourceContainer?: string | null; /** * The location of the resource. If not empty, the resource will be checked against location policy. The value must be a valid zone, region or multiregion. For example: "europe-west4" or "northamerica-northeast1-a" */ - resourceLocation?: string; + resourceLocation?: string | null; /** * Name of the resource. This is used for auditing purposes. */ - resourceName?: string; + resourceName?: string | null; } /** * Location information about a resource. @@ -1076,11 +1076,11 @@ export namespace servicecontrol_v1 { /** * The locations of a resource after the execution of the operation. Requests to create or delete a location based resource must populate the 'current_locations' field and not the 'original_locations' field. For example: "europe-west1-a" "us-east1" "nam3" */ - currentLocations?: string[]; + currentLocations?: string[] | null; /** * The locations of a resource prior to the execution of the operation. Requests that mutate the resource's location must populate both the 'original_locations' as well as the 'current_locations' fields. For example: "europe-west1-a" "us-east1" "nam3" */ - originalLocations?: string[]; + originalLocations?: string[] | null; } /** * Identity delegation history of an authenticated service account. @@ -1102,15 +1102,15 @@ export namespace servicecontrol_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Third party identity principal. @@ -1119,7 +1119,7 @@ export namespace servicecontrol_v1 { /** * Metadata about third party identity. */ - thirdPartyClaims?: {[key: string]: any}; + thirdPartyClaims?: {[key: string]: any} | null; } export class Resource$Services { diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 4efcc6ea012..5d1d2adedb3 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -126,7 +126,7 @@ export namespace servicemanagement_v1 { /** * Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks. */ - description?: string; + description?: string | null; } /** * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. @@ -143,7 +143,7 @@ export namespace servicemanagement_v1 { /** * The fully qualified name of this interface, including package name followed by the interface's simple name. */ - name?: string; + name?: string | null; /** * Any metadata attached to the interface. */ @@ -155,11 +155,11 @@ export namespace servicemanagement_v1 { /** * The source syntax of the service. */ - syntax?: string; + syntax?: string | null; /** * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ - version?: string; + version?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. @@ -172,7 +172,7 @@ export namespace servicemanagement_v1 { /** * 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; + 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. @@ -181,11 +181,11 @@ export namespace servicemanagement_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -207,7 +207,7 @@ export namespace servicemanagement_v1 { /** * If true, the service accepts API keys without any other credential. */ - allowWithoutCredential?: boolean; + allowWithoutCredential?: boolean | null; /** * The requirements for OAuth credentials. */ @@ -219,7 +219,7 @@ export namespace servicemanagement_v1 { /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -228,23 +228,23 @@ export namespace servicemanagement_v1 { /** * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ - authorizationUrl?: string; + authorizationUrl?: string | null; /** * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ - id?: string; + id?: string | null; /** * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ - issuer?: string; + issuer?: string | null; /** * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ - jwksUri?: string; + jwksUri?: string | null; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -253,11 +253,11 @@ export namespace servicemanagement_v1 { /** * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * id from authentication provider. Example: provider_id: bookstore_auth */ - providerId?: string; + providerId?: string | null; } /** * `Backend` defines the backend configuration for a service. @@ -275,28 +275,28 @@ export namespace servicemanagement_v1 { /** * The address of the API backend. */ - address?: string; + address?: string | null; /** * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ - deadline?: number; + deadline?: number | null; /** * The JWT audience is used when generating a JWT id token for the backend. */ - jwtAudience?: string; + jwtAudience?: string | null; /** * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ - minDeadline?: number; + minDeadline?: number | null; /** * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ - operationDeadline?: number; - pathTranslation?: string; + operationDeadline?: number | null; + pathTranslation?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count @@ -314,11 +314,11 @@ export namespace servicemanagement_v1 { /** * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * Associates `members` with a `role`. @@ -331,11 +331,11 @@ export namespace servicemanagement_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Change report associated with a particular service configuration. It contains a list of ConfigChanges based on the comparison between two service configurations. @@ -357,19 +357,19 @@ export namespace servicemanagement_v1 { /** * The type for this change, either ADDED, REMOVED, or MODIFIED. */ - changeType?: string; + changeType?: string | null; /** * Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used. Examples: - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value - logging.producer_destinations[0] */ - element?: string; + element?: string | null; /** * Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED. */ - newValue?: string; + newValue?: string | null; /** * Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED. */ - oldValue?: string; + oldValue?: string | null; } /** * Generic specification of a source configuration file @@ -378,15 +378,15 @@ export namespace servicemanagement_v1 { /** * The bytes that constitute the file. */ - fileContents?: string; + fileContents?: string | null; /** * The file name of the configuration file (full or relative path). */ - filePath?: string; + filePath?: string | null; /** * The type of configuration file this represents. */ - fileType?: string; + fileType?: string | null; } /** * Represents a service configuration with its name and id. @@ -395,7 +395,7 @@ export namespace servicemanagement_v1 { /** * Resource name of a service config. It must have the following format: "services/{service name}/configs/{config id}". */ - name?: string; + name?: string | null; } /** * Represents a source file which is used to generate the service configuration defined by `google.api.Service`. @@ -408,7 +408,7 @@ export namespace servicemanagement_v1 { /** * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. */ - id?: string; + id?: string | null; } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. @@ -426,23 +426,23 @@ export namespace servicemanagement_v1 { /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ - allowedRequestExtensions?: string[]; + allowedRequestExtensions?: string[] | null; /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ - allowedResponseExtensions?: string[]; + allowedResponseExtensions?: string[] | null; /** * A list of full type names of provided contexts. */ - provided?: string[]; + provided?: string[] | null; /** * A list of full type names of requested contexts. */ - requested?: string[]; + requested?: string[] | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. @@ -451,7 +451,7 @@ export namespace servicemanagement_v1 { /** * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ - environment?: string; + environment?: string | null; } /** * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError @@ -464,7 +464,7 @@ export namespace servicemanagement_v1 { /** * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ - types?: string[]; + types?: string[] | null; } /** * A custom error rule. @@ -473,11 +473,11 @@ export namespace servicemanagement_v1 { /** * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ - isErrorType?: boolean; + isErrorType?: boolean | null; /** * Selects messages to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A custom pattern is used for defining custom HTTP verb. @@ -486,11 +486,11 @@ export namespace servicemanagement_v1 { /** * The name of this custom HTTP verb. */ - kind?: string; + kind?: string | null; /** * The path matched by this custom verb. */ - path?: string; + path?: string | null; } /** * Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. @@ -503,15 +503,15 @@ export namespace servicemanagement_v1 { /** * The kind of diagnostic information provided. */ - kind?: string; + kind?: string | null; /** * File name and line number of the error or warning. */ - location?: string; + location?: string | null; /** * Message describing the error or warning. */ - message?: string; + message?: string | null; } /** * Request message for DisableService method. @@ -520,7 +520,7 @@ export namespace servicemanagement_v1 { /** * The identity of consumer resource which service disablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. */ - consumerId?: string; + consumerId?: 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. @@ -529,11 +529,11 @@ export namespace servicemanagement_v1 { /** * The URL to the root of documentation. */ - documentationRootUrl?: string; + documentationRootUrl?: string | null; /** * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ - overview?: string; + overview?: string | null; /** * The top level pages for the documentation set. */ @@ -545,11 +545,11 @@ export namespace servicemanagement_v1 { /** * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. */ - serviceRootUrl?: string; + serviceRootUrl?: string | null; /** * A short summary of what the service does. Can only be provided by plain text. */ - summary?: string; + summary?: string | null; } /** * A documentation rule provides information about individual API elements. @@ -558,15 +558,15 @@ export namespace servicemanagement_v1 { /** * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ - deprecationDescription?: string; + deprecationDescription?: string | null; /** * Description of the selected API(s). */ - description?: string; + description?: string | null; /** * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ - selector?: string; + selector?: string | null; } /** * Request message for EnableService method. @@ -575,7 +575,7 @@ export namespace servicemanagement_v1 { /** * The identity of consumer resource which service enablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. */ - consumerId?: string; + consumerId?: 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 @@ -584,23 +584,23 @@ export namespace servicemanagement_v1 { /** * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ - aliases?: string[]; + aliases?: string[] | null; /** * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ - allowCors?: boolean; + allowCors?: boolean | null; /** * The list of features enabled on this endpoint. */ - features?: string[]; + features?: string[] | null; /** * The canonical name of this endpoint. */ - name?: string; + name?: string | null; /** * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ - target?: string; + target?: string | null; } /** * Enum type definition. @@ -613,7 +613,7 @@ export namespace servicemanagement_v1 { /** * Enum type name. */ - name?: string; + name?: string | null; /** * Protocol buffer options. */ @@ -625,7 +625,7 @@ export namespace servicemanagement_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Enum value definition. @@ -634,11 +634,11 @@ export namespace servicemanagement_v1 { /** * Enum value name. */ - name?: string; + name?: string | null; /** * Enum value number. */ - number?: number; + number?: number | null; /** * Protocol buffer options. */ @@ -651,19 +651,19 @@ export namespace servicemanagement_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * A single field of a message type. @@ -672,31 +672,31 @@ export namespace servicemanagement_v1 { /** * The field cardinality. */ - cardinality?: string; + cardinality?: string | null; /** * The string value of the default value of this field. Proto2 syntax only. */ - defaultValue?: string; + defaultValue?: string | null; /** * The field JSON name. */ - jsonName?: string; + jsonName?: string | null; /** * The field type. */ - kind?: string; + kind?: string | null; /** * The field name. */ - name?: string; + name?: string | null; /** * The field number. */ - number?: number; + number?: number | null; /** * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ - oneofIndex?: number; + oneofIndex?: number | null; /** * The protocol buffer options. */ @@ -704,11 +704,11 @@ export namespace servicemanagement_v1 { /** * Whether to use alternative packed wire representation. */ - packed?: boolean; + packed?: boolean | null; /** * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ - typeUrl?: string; + typeUrl?: string | null; } /** * Encapsulation of flow-specific error details for debugging. Used as a details field on an error Status, not intended for external use. @@ -717,11 +717,11 @@ export namespace servicemanagement_v1 { /** * The type of exception (as a class name). */ - exceptionType?: string; + exceptionType?: string | null; /** * The step that failed. */ - flowStepId?: string; + flowStepId?: string | null; } /** * Request message for GenerateConfigReport method. @@ -730,11 +730,11 @@ export namespace servicemanagement_v1 { /** * Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ - newConfig?: {[key: string]: any}; + newConfig?: {[key: string]: any} | null; /** * Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ - oldConfig?: {[key: string]: any}; + oldConfig?: {[key: string]: any} | null; } /** * Response message for GenerateConfigReport method. @@ -751,11 +751,11 @@ export namespace servicemanagement_v1 { /** * ID of the service configuration this report belongs to. */ - id?: string; + id?: string | null; /** * Name of the service this report belongs to. */ - serviceName?: string; + serviceName?: string | null; } /** * Request message for `GetIamPolicy` method. @@ -773,7 +773,7 @@ export namespace servicemanagement_v1 { /** * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. @@ -782,7 +782,7 @@ export namespace servicemanagement_v1 { /** * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ - fullyDecodeReservedExpansion?: boolean; + fullyDecodeReservedExpansion?: boolean | null; /** * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -799,7 +799,7 @@ export namespace servicemanagement_v1 { /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ - body?: string; + body?: string | null; /** * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ @@ -807,31 +807,31 @@ export namespace servicemanagement_v1 { /** * Maps to HTTP DELETE. Used for deleting a resource. */ - delete?: string; + delete?: string | null; /** * Maps to HTTP GET. Used for listing and getting information about resources. */ - get?: string; + get?: string | null; /** * Maps to HTTP PATCH. Used for updating a resource. */ - patch?: string; + patch?: string | null; /** * Maps to HTTP POST. Used for creating a resource or performing an action. */ - post?: string; + post?: string | null; /** * Maps to HTTP PUT. Used for replacing a resource. */ - put?: string; + put?: string | null; /** * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ - responseBody?: string; + responseBody?: string | null; /** * Selects a method to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A description of a label. @@ -840,15 +840,15 @@ export namespace servicemanagement_v1 { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * The response message for Operations.ListOperations. @@ -857,7 +857,7 @@ export namespace servicemanagement_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -870,7 +870,7 @@ export namespace servicemanagement_v1 { /** * The token of the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of service configuration resources. */ @@ -883,7 +883,7 @@ export namespace servicemanagement_v1 { /** * The token of the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of rollout resources. */ @@ -896,7 +896,7 @@ export namespace servicemanagement_v1 { /** * Token that can be passed to `ListServices` to resume a paginated query. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The returned services will only have the name field set. */ @@ -909,11 +909,11 @@ export namespace servicemanagement_v1 { /** * A human-readable description of this log. This information appears in the documentation and can contain details. */ - description?: string; + description?: string | null; /** * The human-readable name for this log. This information appears on the user interface and should be concise. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ @@ -921,7 +921,7 @@ export namespace servicemanagement_v1 { /** * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ - name?: string; + name?: string | null; } /** * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history @@ -943,11 +943,11 @@ export namespace servicemanagement_v1 { /** * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ - logs?: string[]; + logs?: string[] | null; /** * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * The full representation of a Service that is managed by Google Service Management. @@ -956,11 +956,11 @@ export namespace servicemanagement_v1 { /** * ID of the project that produces and owns this service. */ - producerProjectId?: string; + producerProjectId?: string | null; /** * The name of the service. See the [overview](/service-management/overview) for naming requirements. */ - serviceName?: string; + serviceName?: string | null; } /** * Method represents a method of an API interface. @@ -969,7 +969,7 @@ export namespace servicemanagement_v1 { /** * The simple name of this method. */ - name?: string; + name?: string | null; /** * Any metadata attached to the method. */ @@ -977,23 +977,23 @@ export namespace servicemanagement_v1 { /** * If true, the request is streamed. */ - requestStreaming?: boolean; + requestStreaming?: boolean | null; /** * A URL of the input message type. */ - requestTypeUrl?: string; + requestTypeUrl?: string | null; /** * If true, the response is streamed. */ - responseStreaming?: boolean; + responseStreaming?: boolean | null; /** * The URL of the output message type. */ - responseTypeUrl?: string; + responseTypeUrl?: string | null; /** * The source syntax of this method. */ - syntax?: string; + syntax?: string | null; } /** * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. @@ -1002,11 +1002,11 @@ export namespace servicemanagement_v1 { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ @@ -1014,7 +1014,7 @@ export namespace servicemanagement_v1 { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -1022,23 +1022,23 @@ export namespace servicemanagement_v1 { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -1047,15 +1047,15 @@ export namespace servicemanagement_v1 { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -1064,11 +1064,11 @@ export namespace servicemanagement_v1 { /** * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ - metricCosts?: {[key: string]: string}; + metricCosts?: {[key: string]: string} | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } @@ -1077,11 +1077,11 @@ export namespace servicemanagement_v1 { /** * The fully qualified name of the interface which is included. */ - name?: string; + name?: string | null; /** * If non-empty specifies a path under which inherited HTTP paths are rooted. */ - root?: string; + root?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. @@ -1090,11 +1090,11 @@ export namespace servicemanagement_v1 { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ @@ -1102,15 +1102,15 @@ export namespace servicemanagement_v1 { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count @@ -1132,11 +1132,11 @@ export namespace servicemanagement_v1 { /** * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. @@ -1145,7 +1145,7 @@ export namespace servicemanagement_v1 { /** * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ - canonicalScopes?: string; + canonicalScopes?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1154,7 +1154,7 @@ export namespace servicemanagement_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1162,15 +1162,15 @@ export namespace servicemanagement_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * The metadata associated with a long running operation resource. @@ -1179,15 +1179,15 @@ export namespace servicemanagement_v1 { /** * Percentage of completion of this operation, ranging from 0 to 100. */ - progressPercentage?: number; + progressPercentage?: number | null; /** * The full name of the resources that this operation is directly associated with. */ - resourceNames?: string[]; + resourceNames?: string[] | null; /** * The start time of the operation. */ - startTime?: string; + startTime?: string | null; /** * Detailed status information for each step. The order is undetermined. */ @@ -1200,11 +1200,11 @@ export namespace servicemanagement_v1 { /** * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ - name?: string; + name?: string | null; /** * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ - value?: {[key: string]: any}; + value?: {[key: string]: any} | null; } /** * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. @@ -1213,11 +1213,11 @@ export namespace servicemanagement_v1 { /** * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ - content?: string; + content?: string | null; /** * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ - name?: string; + name?: string | null; /** * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ @@ -1238,11 +1238,11 @@ export namespace servicemanagement_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. */ - version?: number; + version?: number | null; } /** * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 @@ -1264,43 +1264,43 @@ export namespace servicemanagement_v1 { /** * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ - defaultLimit?: string; + defaultLimit?: string | null; /** * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ - description?: string; + description?: string | null; /** * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ - displayName?: string; + displayName?: string | null; /** * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. */ - duration?: string; + duration?: string | null; /** * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ - freeTier?: string; + freeTier?: string | null; /** * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ - maxLimit?: string; + maxLimit?: string | null; /** * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ - metric?: string; + metric?: string | null; /** * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ - name?: string; + name?: string | null; /** * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ - unit?: string; + unit?: string | null; /** * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ - values?: {[key: string]: string}; + values?: {[key: string]: string} | null; } /** * A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config. @@ -1309,11 +1309,11 @@ export namespace servicemanagement_v1 { /** * The user who created the Rollout. Readonly. */ - createdBy?: string; + createdBy?: string | null; /** * Creation time of the rollout. Readonly. */ - createTime?: string; + createTime?: string | null; /** * The strategy associated with a rollout to delete a `ManagedService`. Readonly. */ @@ -1321,15 +1321,15 @@ export namespace servicemanagement_v1 { /** * Optional unique identifier of this Rollout. Only lower case letters, digits and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of <date><revision number>, where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1' */ - rolloutId?: string; + rolloutId?: string | null; /** * The name of the service associated with this Rollout. */ - serviceName?: string; + serviceName?: string | null; /** * The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly. */ - status?: string; + status?: string | null; /** * Google Service Control selects service configurations based on traffic percentage. */ @@ -1358,7 +1358,7 @@ export namespace servicemanagement_v1 { /** * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ - configVersion?: number; + configVersion?: number | null; /** * Context configuration. */ @@ -1390,7 +1390,7 @@ export namespace servicemanagement_v1 { /** * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ - id?: string; + id?: string | null; /** * Logging configuration. */ @@ -1414,11 +1414,11 @@ export namespace servicemanagement_v1 { /** * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ - name?: string; + name?: string | null; /** * The Google project that owns this service. */ - producerProjectId?: string; + producerProjectId?: string | null; /** * Quota configuration. */ @@ -1438,7 +1438,7 @@ export namespace servicemanagement_v1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ @@ -1459,7 +1459,7 @@ export namespace servicemanagement_v1 { /** * 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; + updateMask?: string | null; } /** * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. @@ -1468,7 +1468,7 @@ export namespace servicemanagement_v1 { /** * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ - fileName?: string; + fileName?: string | null; } /** * Source information used to create a Service Config @@ -1477,7 +1477,7 @@ export namespace servicemanagement_v1 { /** * All files used during config generation. */ - sourceFiles?: Array<{[key: string]: any}>; + sourceFiles?: Array<{[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). @@ -1486,15 +1486,15 @@ export namespace servicemanagement_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents the status of one operation step. @@ -1503,11 +1503,11 @@ export namespace servicemanagement_v1 { /** * The short description of the step. */ - description?: string; + description?: string | null; /** * The status code. */ - status?: string; + status?: string | null; } /** * Request message for SubmitConfigSource method. @@ -1520,7 +1520,7 @@ export namespace servicemanagement_v1 { /** * Optional. If set, this will result in the generation of a `google.api.Service` configuration based on the `ConfigSource` provided, but the generated config and the sources will NOT be persisted. */ - validateOnly?: boolean; + validateOnly?: boolean | null; } /** * Response message for SubmitConfigSource method. @@ -1538,15 +1538,15 @@ export namespace servicemanagement_v1 { /** * Define the HTTP header name to use for the parameter. It is case insensitive. */ - httpHeader?: string; + httpHeader?: string | null; /** * Define the name of the parameter, such as "api_key" . It is case sensitive. */ - name?: string; + name?: string | null; /** * Define the URL query parameter name to use for the parameter. It is case sensitive. */ - urlQueryParameter?: string; + urlQueryParameter?: string | null; } /** * Define a system parameter rule mapping system parameter definitions to methods. @@ -1559,7 +1559,7 @@ export namespace servicemanagement_v1 { /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. @@ -1577,7 +1577,7 @@ export namespace servicemanagement_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -1586,7 +1586,7 @@ export namespace servicemanagement_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured precentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } } @@ -1595,7 +1595,7 @@ export namespace servicemanagement_v1 { /** * Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0. */ - percentages?: {[key: string]: number}; + percentages?: {[key: string]: number} | null; } /** * A protocol buffer message type. @@ -1608,11 +1608,11 @@ export namespace servicemanagement_v1 { /** * The fully qualified message name. */ - name?: string; + name?: string | null; /** * The list of types appearing in `oneof` definitions in this type. */ - oneofs?: string[]; + oneofs?: string[] | null; /** * The protocol buffer options. */ @@ -1624,7 +1624,7 @@ export namespace servicemanagement_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Response message for UndeleteService method. @@ -1642,11 +1642,11 @@ export namespace servicemanagement_v1 { /** * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ - producerNotificationChannel?: string; + producerNotificationChannel?: string | null; /** * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ - requirements?: string[]; + requirements?: string[] | null; /** * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -1659,15 +1659,15 @@ export namespace servicemanagement_v1 { /** * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ - allowUnregisteredCalls?: boolean; + allowUnregisteredCalls?: boolean | null; /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; /** * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ - skipServiceControl?: boolean; + skipServiceControl?: boolean | null; } export class Resource$Operations { diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 25c4dbcd467..d39c1cd939a 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -126,35 +126,35 @@ export namespace servicenetworking_v1 { /** * Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC. */ - consumer?: string; + consumer?: string | null; /** * Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project. */ - consumerNetwork?: string; + consumerNetwork?: string | null; /** * An optional description of the subnet. */ - description?: string; + description?: string | null; /** * Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. */ - ipPrefixLength?: number; + ipPrefixLength?: number | null; /** * Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe-west1`. */ - region?: string; + region?: string | null; /** * Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails. */ - requestedAddress?: string; + requestedAddress?: string | null; /** * Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation. */ - subnetwork?: string; + subnetwork?: string | null; /** * A list of members that are granted the `compute.networkUser` role on the subnet. */ - subnetworkUsers?: string[]; + subnetworkUsers?: string[] | null; } /** * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. @@ -171,7 +171,7 @@ export namespace servicenetworking_v1 { /** * The fully qualified name of this interface, including package name followed by the interface's simple name. */ - name?: string; + name?: string | null; /** * Any metadata attached to the interface. */ @@ -183,11 +183,11 @@ export namespace servicenetworking_v1 { /** * The source syntax of the service. */ - syntax?: string; + syntax?: string | null; /** * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ - version?: string; + version?: string | null; } /** * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -209,7 +209,7 @@ export namespace servicenetworking_v1 { /** * If true, the service accepts API keys without any other credential. */ - allowWithoutCredential?: boolean; + allowWithoutCredential?: boolean | null; /** * The requirements for OAuth credentials. */ @@ -221,7 +221,7 @@ export namespace servicenetworking_v1 { /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -230,23 +230,23 @@ export namespace servicenetworking_v1 { /** * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ - authorizationUrl?: string; + authorizationUrl?: string | null; /** * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ - id?: string; + id?: string | null; /** * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ - issuer?: string; + issuer?: string | null; /** * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ - jwksUri?: string; + jwksUri?: string | null; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -255,11 +255,11 @@ export namespace servicenetworking_v1 { /** * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * id from authentication provider. Example: provider_id: bookstore_auth */ - providerId?: string; + providerId?: string | null; } /** * `Backend` defines the backend configuration for a service. @@ -277,28 +277,28 @@ export namespace servicenetworking_v1 { /** * The address of the API backend. */ - address?: string; + address?: string | null; /** * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ - deadline?: number; + deadline?: number | null; /** * The JWT audience is used when generating a JWT id token for the backend. */ - jwtAudience?: string; + jwtAudience?: string | null; /** * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ - minDeadline?: number; + minDeadline?: number | null; /** * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ - operationDeadline?: number; - pathTranslation?: string; + operationDeadline?: number | null; + pathTranslation?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count @@ -316,11 +316,11 @@ export namespace servicenetworking_v1 { /** * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * The request message for Operations.CancelOperation. @@ -333,19 +333,19 @@ export namespace servicenetworking_v1 { /** * The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network}` is the name of the service consumer's VPC network. */ - network?: string; + network?: string | null; /** * Output only. The name of the VPC Network Peering connection that was created by the service producer. */ - peering?: string; + peering?: string | null; /** * The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking CreateConnection method with a different range when connection is already established will not modify already provisioned service producer subnetworks. If CreateConnection method is invoked repeatedly to reconnect when peering connection had been disconnected on the consumer side, leaving this field empty will restore previously allocated IP ranges. */ - reservedPeeringRanges?: string[]; + reservedPeeringRanges?: string[] | null; /** * Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`. */ - service?: string; + service?: string | null; } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. @@ -363,23 +363,23 @@ export namespace servicenetworking_v1 { /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ - allowedRequestExtensions?: string[]; + allowedRequestExtensions?: string[] | null; /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ - allowedResponseExtensions?: string[]; + allowedResponseExtensions?: string[] | null; /** * A list of full type names of provided contexts. */ - provided?: string[]; + provided?: string[] | null; /** * A list of full type names of requested contexts. */ - requested?: string[]; + requested?: string[] | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. @@ -388,7 +388,7 @@ export namespace servicenetworking_v1 { /** * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ - environment?: string; + environment?: string | null; } /** * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError @@ -401,7 +401,7 @@ export namespace servicenetworking_v1 { /** * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ - types?: string[]; + types?: string[] | null; } /** * A custom error rule. @@ -410,11 +410,11 @@ export namespace servicenetworking_v1 { /** * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ - isErrorType?: boolean; + isErrorType?: boolean | null; /** * Selects messages to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A custom pattern is used for defining custom HTTP verb. @@ -423,11 +423,11 @@ export namespace servicenetworking_v1 { /** * The name of this custom HTTP verb. */ - kind?: string; + kind?: string | null; /** * The path matched by this custom verb. */ - path?: string; + path?: 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. @@ -436,11 +436,11 @@ export namespace servicenetworking_v1 { /** * The URL to the root of documentation. */ - documentationRootUrl?: string; + documentationRootUrl?: string | null; /** * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ - overview?: string; + overview?: string | null; /** * The top level pages for the documentation set. */ @@ -452,11 +452,11 @@ export namespace servicenetworking_v1 { /** * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. */ - serviceRootUrl?: string; + serviceRootUrl?: string | null; /** * A short summary of what the service does. Can only be provided by plain text. */ - summary?: string; + summary?: string | null; } /** * A documentation rule provides information about individual API elements. @@ -465,15 +465,15 @@ export namespace servicenetworking_v1 { /** * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ - deprecationDescription?: string; + deprecationDescription?: string | null; /** * Description of the selected API(s). */ - description?: string; + description?: string | null; /** * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ - selector?: string; + selector?: 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 `{}`. @@ -486,23 +486,23 @@ export namespace servicenetworking_v1 { /** * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ - aliases?: string[]; + aliases?: string[] | null; /** * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ - allowCors?: boolean; + allowCors?: boolean | null; /** * The list of features enabled on this endpoint. */ - features?: string[]; + features?: string[] | null; /** * The canonical name of this endpoint. */ - name?: string; + name?: string | null; /** * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ - target?: string; + target?: string | null; } /** * Enum type definition. @@ -515,7 +515,7 @@ export namespace servicenetworking_v1 { /** * Enum type name. */ - name?: string; + name?: string | null; /** * Protocol buffer options. */ @@ -527,7 +527,7 @@ export namespace servicenetworking_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Enum value definition. @@ -536,11 +536,11 @@ export namespace servicenetworking_v1 { /** * Enum value name. */ - name?: string; + name?: string | null; /** * Enum value number. */ - number?: number; + number?: number | null; /** * Protocol buffer options. */ @@ -553,31 +553,31 @@ export namespace servicenetworking_v1 { /** * The field cardinality. */ - cardinality?: string; + cardinality?: string | null; /** * The string value of the default value of this field. Proto2 syntax only. */ - defaultValue?: string; + defaultValue?: string | null; /** * The field JSON name. */ - jsonName?: string; + jsonName?: string | null; /** * The field type. */ - kind?: string; + kind?: string | null; /** * The field name. */ - name?: string; + name?: string | null; /** * The field number. */ - number?: number; + number?: number | null; /** * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ - oneofIndex?: number; + oneofIndex?: number | null; /** * The protocol buffer options. */ @@ -585,11 +585,11 @@ export namespace servicenetworking_v1 { /** * Whether to use alternative packed wire representation. */ - packed?: boolean; + packed?: boolean | null; /** * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ - typeUrl?: string; + typeUrl?: string | null; } /** * Represents a subnet that was created or discovered by a private access management service. @@ -598,19 +598,19 @@ export namespace servicenetworking_v1 { /** * Subnetwork CIDR range in `10.x.x.x/y` format. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ */ - name?: string; + name?: string | null; /** * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ - network?: string; + network?: string | null; /** * This is a discovered subnet that is not within the current consumer allocated ranges. */ - outsideAllocation?: boolean; + outsideAllocation?: boolean | null; } /** * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. @@ -619,7 +619,7 @@ export namespace servicenetworking_v1 { /** * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ - fullyDecodeReservedExpansion?: boolean; + fullyDecodeReservedExpansion?: boolean | null; /** * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -636,7 +636,7 @@ export namespace servicenetworking_v1 { /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ - body?: string; + body?: string | null; /** * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ @@ -644,31 +644,31 @@ export namespace servicenetworking_v1 { /** * Maps to HTTP DELETE. Used for deleting a resource. */ - delete?: string; + delete?: string | null; /** * Maps to HTTP GET. Used for listing and getting information about resources. */ - get?: string; + get?: string | null; /** * Maps to HTTP PATCH. Used for updating a resource. */ - patch?: string; + patch?: string | null; /** * Maps to HTTP POST. Used for creating a resource or performing an action. */ - post?: string; + post?: string | null; /** * Maps to HTTP PUT. Used for replacing a resource. */ - put?: string; + put?: string | null; /** * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ - responseBody?: string; + responseBody?: string | null; /** * Selects a method to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A description of a label. @@ -677,15 +677,15 @@ export namespace servicenetworking_v1 { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * ListConnectionsResponse is the response to list peering states for the given service and consumer project. @@ -703,7 +703,7 @@ export namespace servicenetworking_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -716,11 +716,11 @@ export namespace servicenetworking_v1 { /** * A human-readable description of this log. This information appears in the documentation and can contain details. */ - description?: string; + description?: string | null; /** * The human-readable name for this log. This information appears on the user interface and should be concise. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ @@ -728,7 +728,7 @@ export namespace servicenetworking_v1 { /** * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ - name?: string; + name?: string | null; } /** * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history @@ -750,11 +750,11 @@ export namespace servicenetworking_v1 { /** * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ - logs?: string[]; + logs?: string[] | null; /** * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * Method represents a method of an API interface. @@ -763,7 +763,7 @@ export namespace servicenetworking_v1 { /** * The simple name of this method. */ - name?: string; + name?: string | null; /** * Any metadata attached to the method. */ @@ -771,23 +771,23 @@ export namespace servicenetworking_v1 { /** * If true, the request is streamed. */ - requestStreaming?: boolean; + requestStreaming?: boolean | null; /** * A URL of the input message type. */ - requestTypeUrl?: string; + requestTypeUrl?: string | null; /** * If true, the response is streamed. */ - responseStreaming?: boolean; + responseStreaming?: boolean | null; /** * The URL of the output message type. */ - responseTypeUrl?: string; + responseTypeUrl?: string | null; /** * The source syntax of this method. */ - syntax?: string; + syntax?: string | null; } /** * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. @@ -796,11 +796,11 @@ export namespace servicenetworking_v1 { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ @@ -808,7 +808,7 @@ export namespace servicenetworking_v1 { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -816,23 +816,23 @@ export namespace servicenetworking_v1 { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -841,15 +841,15 @@ export namespace servicenetworking_v1 { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -858,11 +858,11 @@ export namespace servicenetworking_v1 { /** * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ - metricCosts?: {[key: string]: string}; + metricCosts?: {[key: string]: string} | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } @@ -871,11 +871,11 @@ export namespace servicenetworking_v1 { /** * The fully qualified name of the interface which is included. */ - name?: string; + name?: string | null; /** * If non-empty specifies a path under which inherited HTTP paths are rooted. */ - root?: string; + root?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. @@ -884,11 +884,11 @@ export namespace servicenetworking_v1 { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ @@ -896,15 +896,15 @@ export namespace servicenetworking_v1 { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count @@ -926,11 +926,11 @@ export namespace servicenetworking_v1 { /** * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. @@ -939,7 +939,7 @@ export namespace servicenetworking_v1 { /** * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ - canonicalScopes?: string; + canonicalScopes?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -948,7 +948,7 @@ export namespace servicenetworking_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -956,15 +956,15 @@ export namespace servicenetworking_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A protocol buffer option, which can be attached to a message, field, enumeration, etc. @@ -973,11 +973,11 @@ export namespace servicenetworking_v1 { /** * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ - name?: string; + name?: string | null; /** * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ - value?: {[key: string]: any}; + value?: {[key: string]: any} | null; } /** * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. @@ -986,11 +986,11 @@ export namespace servicenetworking_v1 { /** * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ - content?: string; + content?: string | null; /** * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ - name?: string; + name?: string | null; /** * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ @@ -1016,43 +1016,43 @@ export namespace servicenetworking_v1 { /** * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ - defaultLimit?: string; + defaultLimit?: string | null; /** * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ - description?: string; + description?: string | null; /** * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ - displayName?: string; + displayName?: string | null; /** - * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. + * Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */ - duration?: string; + duration?: string | null; /** * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ - freeTier?: string; + freeTier?: string | null; /** * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ - maxLimit?: string; + maxLimit?: string | null; /** * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ - metric?: string; + metric?: string | null; /** * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ - name?: string; + name?: string | null; /** * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ - unit?: string; + unit?: string | null; /** * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ - values?: {[key: string]: string}; + values?: {[key: string]: string} | null; } /** * Represents a found unused range. @@ -1061,11 +1061,11 @@ export namespace servicenetworking_v1 { /** * CIDR range in "10.x.x.x/y" format that is within the allocated ranges and currently unused. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ - network?: string; + network?: string | null; } /** * Request to search for an unused range within allocated ranges. @@ -1074,11 +1074,11 @@ export namespace servicenetworking_v1 { /** * Required. The prefix length of the IP range. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be determined using allocated range for the consumer peered network and returned in the result. */ - ipPrefixLength?: number; + ipPrefixLength?: number | null; /** * Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/{project}/global/networks/{network}'. {project} is a project number, as in '12345' {network} is network name. */ - network?: string; + network?: string | null; } /** * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -1103,7 +1103,7 @@ export namespace servicenetworking_v1 { /** * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ - configVersion?: number; + configVersion?: number | null; /** * Context configuration. */ @@ -1135,7 +1135,7 @@ export namespace servicenetworking_v1 { /** * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ - id?: string; + id?: string | null; /** * Logging configuration. */ @@ -1159,11 +1159,11 @@ export namespace servicenetworking_v1 { /** * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ - name?: string; + name?: string | null; /** * The Google project that owns this service. */ - producerProjectId?: string; + producerProjectId?: string | null; /** * Quota configuration. */ @@ -1183,7 +1183,7 @@ export namespace servicenetworking_v1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ @@ -1200,7 +1200,7 @@ export namespace servicenetworking_v1 { /** * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ - fileName?: string; + fileName?: string | null; } /** * Source information used to create a Service Config @@ -1209,7 +1209,7 @@ export namespace servicenetworking_v1 { /** * All files used during config generation. */ - sourceFiles?: Array<{[key: string]: any}>; + sourceFiles?: Array<{[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). @@ -1218,15 +1218,15 @@ export namespace servicenetworking_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents a subnet that was created or discovered by a private access management service. @@ -1235,19 +1235,19 @@ export namespace servicenetworking_v1 { /** * Subnetwork CIDR range in `10.x.x.x/y` format. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ */ - name?: string; + name?: string | null; /** * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ - network?: string; + network?: string | null; /** * This is a discovered subnet that is not within the current consumer allocated ranges. */ - outsideAllocation?: boolean; + outsideAllocation?: boolean | null; } /** * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. @@ -1256,15 +1256,15 @@ export namespace servicenetworking_v1 { /** * Define the HTTP header name to use for the parameter. It is case insensitive. */ - httpHeader?: string; + httpHeader?: string | null; /** * Define the name of the parameter, such as "api_key" . It is case sensitive. */ - name?: string; + name?: string | null; /** * Define the URL query parameter name to use for the parameter. It is case sensitive. */ - urlQueryParameter?: string; + urlQueryParameter?: string | null; } /** * Define a system parameter rule mapping system parameter definitions to methods. @@ -1277,7 +1277,7 @@ export namespace servicenetworking_v1 { /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. @@ -1299,11 +1299,11 @@ export namespace servicenetworking_v1 { /** * The fully qualified message name. */ - name?: string; + name?: string | null; /** * The list of types appearing in `oneof` definitions in this type. */ - oneofs?: string[]; + oneofs?: string[] | null; /** * The protocol buffer options. */ @@ -1315,7 +1315,7 @@ export namespace servicenetworking_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Configuration controlling usage of a service. @@ -1324,11 +1324,11 @@ export namespace servicenetworking_v1 { /** * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ - producerNotificationChannel?: string; + producerNotificationChannel?: string | null; /** * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ - requirements?: string[]; + requirements?: string[] | null; /** * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -1341,15 +1341,15 @@ export namespace servicenetworking_v1 { /** * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ - allowUnregisteredCalls?: boolean; + allowUnregisteredCalls?: boolean | null; /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; /** * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ - skipServiceControl?: boolean; + skipServiceControl?: boolean | null; } export class Resource$Operations { diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 5e721a4cc39..5898dffb5d5 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -126,35 +126,35 @@ export namespace servicenetworking_v1beta { /** * Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC. */ - consumer?: string; + consumer?: string | null; /** * Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project. */ - consumerNetwork?: string; + consumerNetwork?: string | null; /** * An optional description of the subnet. */ - description?: string; + description?: string | null; /** * Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. */ - ipPrefixLength?: number; + ipPrefixLength?: number | null; /** * Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe-west1`. */ - region?: string; + region?: string | null; /** * Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails. */ - requestedAddress?: string; + requestedAddress?: string | null; /** * Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation. */ - subnetwork?: string; + subnetwork?: string | null; /** * A list of members that are granted the `compute.networkUser` role on the subnet. */ - subnetworkUsers?: string[]; + subnetworkUsers?: string[] | null; } /** * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. @@ -171,7 +171,7 @@ export namespace servicenetworking_v1beta { /** * The fully qualified name of this interface, including package name followed by the interface's simple name. */ - name?: string; + name?: string | null; /** * Any metadata attached to the interface. */ @@ -183,11 +183,11 @@ export namespace servicenetworking_v1beta { /** * The source syntax of the service. */ - syntax?: string; + syntax?: string | null; /** * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ - version?: string; + version?: string | null; } /** * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -209,7 +209,7 @@ export namespace servicenetworking_v1beta { /** * If true, the service accepts API keys without any other credential. */ - allowWithoutCredential?: boolean; + allowWithoutCredential?: boolean | null; /** * The requirements for OAuth credentials. */ @@ -221,7 +221,7 @@ export namespace servicenetworking_v1beta { /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -230,23 +230,23 @@ export namespace servicenetworking_v1beta { /** * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ - authorizationUrl?: string; + authorizationUrl?: string | null; /** * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ - id?: string; + id?: string | null; /** * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ - issuer?: string; + issuer?: string | null; /** * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ - jwksUri?: string; + jwksUri?: string | null; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -255,11 +255,11 @@ export namespace servicenetworking_v1beta { /** * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * id from authentication provider. Example: provider_id: bookstore_auth */ - providerId?: string; + providerId?: string | null; } /** * `Backend` defines the backend configuration for a service. @@ -277,28 +277,28 @@ export namespace servicenetworking_v1beta { /** * The address of the API backend. */ - address?: string; + address?: string | null; /** * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ - deadline?: number; + deadline?: number | null; /** * The JWT audience is used when generating a JWT id token for the backend. */ - jwtAudience?: string; + jwtAudience?: string | null; /** * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ - minDeadline?: number; + minDeadline?: number | null; /** * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ - operationDeadline?: number; - pathTranslation?: string; + operationDeadline?: number | null; + pathTranslation?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count @@ -316,11 +316,11 @@ export namespace servicenetworking_v1beta { /** * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network. @@ -329,19 +329,19 @@ export namespace servicenetworking_v1beta { /** * The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network}` is the name of the service consumer's VPC network. */ - network?: string; + network?: string | null; /** * Output only. The name of the VPC Network Peering connection that was created by the service producer. */ - peering?: string; + peering?: string | null; /** * The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking this method with a different range when connection is already established will not modify already provisioned service producer subnetworks. */ - reservedPeeringRanges?: string[]; + reservedPeeringRanges?: string[] | null; /** * Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`. */ - service?: string; + service?: string | null; } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. @@ -359,23 +359,23 @@ export namespace servicenetworking_v1beta { /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ - allowedRequestExtensions?: string[]; + allowedRequestExtensions?: string[] | null; /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ - allowedResponseExtensions?: string[]; + allowedResponseExtensions?: string[] | null; /** * A list of full type names of provided contexts. */ - provided?: string[]; + provided?: string[] | null; /** * A list of full type names of requested contexts. */ - requested?: string[]; + requested?: string[] | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. @@ -384,7 +384,7 @@ export namespace servicenetworking_v1beta { /** * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ - environment?: string; + environment?: string | null; } /** * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError @@ -397,7 +397,7 @@ export namespace servicenetworking_v1beta { /** * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ - types?: string[]; + types?: string[] | null; } /** * A custom error rule. @@ -406,11 +406,11 @@ export namespace servicenetworking_v1beta { /** * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ - isErrorType?: boolean; + isErrorType?: boolean | null; /** * Selects messages to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A custom pattern is used for defining custom HTTP verb. @@ -419,11 +419,11 @@ export namespace servicenetworking_v1beta { /** * The name of this custom HTTP verb. */ - kind?: string; + kind?: string | null; /** * The path matched by this custom verb. */ - path?: string; + path?: 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. @@ -432,11 +432,11 @@ export namespace servicenetworking_v1beta { /** * The URL to the root of documentation. */ - documentationRootUrl?: string; + documentationRootUrl?: string | null; /** * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ - overview?: string; + overview?: string | null; /** * The top level pages for the documentation set. */ @@ -448,11 +448,11 @@ export namespace servicenetworking_v1beta { /** * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. */ - serviceRootUrl?: string; + serviceRootUrl?: string | null; /** * A short summary of what the service does. Can only be provided by plain text. */ - summary?: string; + summary?: string | null; } /** * A documentation rule provides information about individual API elements. @@ -461,15 +461,15 @@ export namespace servicenetworking_v1beta { /** * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ - deprecationDescription?: string; + deprecationDescription?: string | null; /** * Description of the selected API(s). */ - description?: string; + description?: string | null; /** * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ - selector?: string; + selector?: 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 @@ -478,23 +478,23 @@ export namespace servicenetworking_v1beta { /** * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ - aliases?: string[]; + aliases?: string[] | null; /** * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ - allowCors?: boolean; + allowCors?: boolean | null; /** * The list of features enabled on this endpoint. */ - features?: string[]; + features?: string[] | null; /** * The canonical name of this endpoint. */ - name?: string; + name?: string | null; /** * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ - target?: string; + target?: string | null; } /** * Enum type definition. @@ -507,7 +507,7 @@ export namespace servicenetworking_v1beta { /** * Enum type name. */ - name?: string; + name?: string | null; /** * Protocol buffer options. */ @@ -519,7 +519,7 @@ export namespace servicenetworking_v1beta { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Enum value definition. @@ -528,11 +528,11 @@ export namespace servicenetworking_v1beta { /** * Enum value name. */ - name?: string; + name?: string | null; /** * Enum value number. */ - number?: number; + number?: number | null; /** * Protocol buffer options. */ @@ -545,31 +545,31 @@ export namespace servicenetworking_v1beta { /** * The field cardinality. */ - cardinality?: string; + cardinality?: string | null; /** * The string value of the default value of this field. Proto2 syntax only. */ - defaultValue?: string; + defaultValue?: string | null; /** * The field JSON name. */ - jsonName?: string; + jsonName?: string | null; /** * The field type. */ - kind?: string; + kind?: string | null; /** * The field name. */ - name?: string; + name?: string | null; /** * The field number. */ - number?: number; + number?: number | null; /** * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ - oneofIndex?: number; + oneofIndex?: number | null; /** * The protocol buffer options. */ @@ -577,11 +577,11 @@ export namespace servicenetworking_v1beta { /** * Whether to use alternative packed wire representation. */ - packed?: boolean; + packed?: boolean | null; /** * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ - typeUrl?: string; + typeUrl?: string | null; } /** * Represents a subnet that was created or discovered by a private access management service. @@ -590,19 +590,19 @@ export namespace servicenetworking_v1beta { /** * Subnetwork CIDR range in `10.x.x.x/y` format. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ */ - name?: string; + name?: string | null; /** * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ - network?: string; + network?: string | null; /** * This is a discovered subnet that is not within the current consumer allocated ranges. */ - outsideAllocation?: boolean; + outsideAllocation?: boolean | null; } /** * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. @@ -611,7 +611,7 @@ export namespace servicenetworking_v1beta { /** * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ - fullyDecodeReservedExpansion?: boolean; + fullyDecodeReservedExpansion?: boolean | null; /** * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -628,7 +628,7 @@ export namespace servicenetworking_v1beta { /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ - body?: string; + body?: string | null; /** * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ @@ -636,31 +636,31 @@ export namespace servicenetworking_v1beta { /** * Maps to HTTP DELETE. Used for deleting a resource. */ - delete?: string; + delete?: string | null; /** * Maps to HTTP GET. Used for listing and getting information about resources. */ - get?: string; + get?: string | null; /** * Maps to HTTP PATCH. Used for updating a resource. */ - patch?: string; + patch?: string | null; /** * Maps to HTTP POST. Used for creating a resource or performing an action. */ - post?: string; + post?: string | null; /** * Maps to HTTP PUT. Used for replacing a resource. */ - put?: string; + put?: string | null; /** * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ - responseBody?: string; + responseBody?: string | null; /** * Selects a method to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A description of a label. @@ -669,15 +669,15 @@ export namespace servicenetworking_v1beta { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * ListConnectionsResponse is the response to list peering states for the given service and consumer project. @@ -695,11 +695,11 @@ export namespace servicenetworking_v1beta { /** * A human-readable description of this log. This information appears in the documentation and can contain details. */ - description?: string; + description?: string | null; /** * The human-readable name for this log. This information appears on the user interface and should be concise. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ @@ -707,7 +707,7 @@ export namespace servicenetworking_v1beta { /** * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ - name?: string; + name?: string | null; } /** * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history @@ -729,11 +729,11 @@ export namespace servicenetworking_v1beta { /** * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ - logs?: string[]; + logs?: string[] | null; /** * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * Method represents a method of an API interface. @@ -742,7 +742,7 @@ export namespace servicenetworking_v1beta { /** * The simple name of this method. */ - name?: string; + name?: string | null; /** * Any metadata attached to the method. */ @@ -750,23 +750,23 @@ export namespace servicenetworking_v1beta { /** * If true, the request is streamed. */ - requestStreaming?: boolean; + requestStreaming?: boolean | null; /** * A URL of the input message type. */ - requestTypeUrl?: string; + requestTypeUrl?: string | null; /** * If true, the response is streamed. */ - responseStreaming?: boolean; + responseStreaming?: boolean | null; /** * The URL of the output message type. */ - responseTypeUrl?: string; + responseTypeUrl?: string | null; /** * The source syntax of this method. */ - syntax?: string; + syntax?: string | null; } /** * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. @@ -775,11 +775,11 @@ export namespace servicenetworking_v1beta { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ @@ -787,7 +787,7 @@ export namespace servicenetworking_v1beta { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -795,23 +795,23 @@ export namespace servicenetworking_v1beta { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -820,15 +820,15 @@ export namespace servicenetworking_v1beta { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -837,11 +837,11 @@ export namespace servicenetworking_v1beta { /** * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ - metricCosts?: {[key: string]: string}; + metricCosts?: {[key: string]: string} | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } @@ -850,11 +850,11 @@ export namespace servicenetworking_v1beta { /** * The fully qualified name of the interface which is included. */ - name?: string; + name?: string | null; /** * If non-empty specifies a path under which inherited HTTP paths are rooted. */ - root?: string; + root?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. @@ -863,11 +863,11 @@ export namespace servicenetworking_v1beta { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ @@ -875,15 +875,15 @@ export namespace servicenetworking_v1beta { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count @@ -905,11 +905,11 @@ export namespace servicenetworking_v1beta { /** * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. @@ -918,7 +918,7 @@ export namespace servicenetworking_v1beta { /** * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ - canonicalScopes?: string; + canonicalScopes?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -927,7 +927,7 @@ export namespace servicenetworking_v1beta { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -935,15 +935,15 @@ export namespace servicenetworking_v1beta { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A protocol buffer option, which can be attached to a message, field, enumeration, etc. @@ -952,11 +952,11 @@ export namespace servicenetworking_v1beta { /** * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ - name?: string; + name?: string | null; /** * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ - value?: {[key: string]: any}; + value?: {[key: string]: any} | null; } /** * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. @@ -965,11 +965,11 @@ export namespace servicenetworking_v1beta { /** * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ - content?: string; + content?: string | null; /** * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ - name?: string; + name?: string | null; /** * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ @@ -995,43 +995,43 @@ export namespace servicenetworking_v1beta { /** * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ - defaultLimit?: string; + defaultLimit?: string | null; /** * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ - description?: string; + description?: string | null; /** * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ - displayName?: string; + displayName?: string | null; /** - * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. + * Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */ - duration?: string; + duration?: string | null; /** * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ - freeTier?: string; + freeTier?: string | null; /** * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ - maxLimit?: string; + maxLimit?: string | null; /** * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ - metric?: string; + metric?: string | null; /** * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ - name?: string; + name?: string | null; /** * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ - unit?: string; + unit?: string | null; /** * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ - values?: {[key: string]: string}; + values?: {[key: string]: string} | null; } /** * Represents a found unused range. @@ -1040,11 +1040,11 @@ export namespace servicenetworking_v1beta { /** * CIDR range in "10.x.x.x/y" format that is within the allocated ranges and currently unused. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ - network?: string; + network?: string | null; } /** * Request to search for an unused range within allocated ranges. @@ -1053,11 +1053,11 @@ export namespace servicenetworking_v1beta { /** * Required. The prefix length of the IP range. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be determined using allocated range for the consumer peered network and returned in the result. */ - ipPrefixLength?: number; + ipPrefixLength?: number | null; /** * Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/{project}/global/networks/{network}'. {project} is a project number, as in '12345' {network} is network name. */ - network?: string; + network?: string | null; } /** * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -1082,7 +1082,7 @@ export namespace servicenetworking_v1beta { /** * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ - configVersion?: number; + configVersion?: number | null; /** * Context configuration. */ @@ -1114,7 +1114,7 @@ export namespace servicenetworking_v1beta { /** * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ - id?: string; + id?: string | null; /** * Logging configuration. */ @@ -1138,11 +1138,11 @@ export namespace servicenetworking_v1beta { /** * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ - name?: string; + name?: string | null; /** * The Google project that owns this service. */ - producerProjectId?: string; + producerProjectId?: string | null; /** * Quota configuration. */ @@ -1162,7 +1162,7 @@ export namespace servicenetworking_v1beta { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ @@ -1179,7 +1179,7 @@ export namespace servicenetworking_v1beta { /** * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ - fileName?: string; + fileName?: string | null; } /** * Source information used to create a Service Config @@ -1188,7 +1188,7 @@ export namespace servicenetworking_v1beta { /** * All files used during config generation. */ - sourceFiles?: Array<{[key: string]: any}>; + sourceFiles?: Array<{[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). @@ -1197,15 +1197,15 @@ export namespace servicenetworking_v1beta { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents a subnet that was created or discovered by a private access management service. @@ -1214,19 +1214,19 @@ export namespace servicenetworking_v1beta { /** * Subnetwork CIDR range in `10.x.x.x/y` format. */ - ipCidrRange?: string; + ipCidrRange?: string | null; /** * Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ */ - name?: string; + name?: string | null; /** * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ - network?: string; + network?: string | null; /** * This is a discovered subnet that is not within the current consumer allocated ranges. */ - outsideAllocation?: boolean; + outsideAllocation?: boolean | null; } /** * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. @@ -1235,15 +1235,15 @@ export namespace servicenetworking_v1beta { /** * Define the HTTP header name to use for the parameter. It is case insensitive. */ - httpHeader?: string; + httpHeader?: string | null; /** * Define the name of the parameter, such as "api_key" . It is case sensitive. */ - name?: string; + name?: string | null; /** * Define the URL query parameter name to use for the parameter. It is case sensitive. */ - urlQueryParameter?: string; + urlQueryParameter?: string | null; } /** * Define a system parameter rule mapping system parameter definitions to methods. @@ -1256,7 +1256,7 @@ export namespace servicenetworking_v1beta { /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. @@ -1278,11 +1278,11 @@ export namespace servicenetworking_v1beta { /** * The fully qualified message name. */ - name?: string; + name?: string | null; /** * The list of types appearing in `oneof` definitions in this type. */ - oneofs?: string[]; + oneofs?: string[] | null; /** * The protocol buffer options. */ @@ -1294,7 +1294,7 @@ export namespace servicenetworking_v1beta { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Configuration controlling usage of a service. @@ -1303,11 +1303,11 @@ export namespace servicenetworking_v1beta { /** * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ - producerNotificationChannel?: string; + producerNotificationChannel?: string | null; /** * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ - requirements?: string[]; + requirements?: string[] | null; /** * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -1320,15 +1320,15 @@ export namespace servicenetworking_v1beta { /** * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ - allowUnregisteredCalls?: boolean; + allowUnregisteredCalls?: boolean | null; /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; /** * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ - skipServiceControl?: boolean; + skipServiceControl?: boolean | null; } export class Resource$Operations { diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 7e664ae17d8..ab035e023f9 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -134,7 +134,7 @@ export namespace serviceusage_v1 { /** * The fully qualified name of this interface, including package name followed by the interface's simple name. */ - name?: string; + name?: string | null; /** * Any metadata attached to the interface. */ @@ -146,11 +146,11 @@ export namespace serviceusage_v1 { /** * The source syntax of the service. */ - syntax?: string; + syntax?: string | null; /** * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ - version?: string; + version?: string | null; } /** * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -172,7 +172,7 @@ export namespace serviceusage_v1 { /** * If true, the service accepts API keys without any other credential. */ - allowWithoutCredential?: boolean; + allowWithoutCredential?: boolean | null; /** * The requirements for OAuth credentials. */ @@ -184,7 +184,7 @@ export namespace serviceusage_v1 { /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -193,23 +193,23 @@ export namespace serviceusage_v1 { /** * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ - authorizationUrl?: string; + authorizationUrl?: string | null; /** * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ - id?: string; + id?: string | null; /** * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ - issuer?: string; + issuer?: string | null; /** * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ - jwksUri?: string; + jwksUri?: string | null; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -218,11 +218,11 @@ export namespace serviceusage_v1 { /** * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * id from authentication provider. Example: provider_id: bookstore_auth */ - providerId?: string; + providerId?: string | null; } /** * `Backend` defines the backend configuration for a service. @@ -240,28 +240,28 @@ export namespace serviceusage_v1 { /** * The address of the API backend. */ - address?: string; + address?: string | null; /** * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ - deadline?: number; + deadline?: number | null; /** * The JWT audience is used when generating a JWT id token for the backend. */ - jwtAudience?: string; + jwtAudience?: string | null; /** * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ - minDeadline?: number; + minDeadline?: number | null; /** * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ - operationDeadline?: number; - pathTranslation?: string; + operationDeadline?: number | null; + pathTranslation?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Response message for BatchCreateAdminOverrides @@ -288,7 +288,7 @@ export namespace serviceusage_v1 { /** * The identifiers of the services to enable on the project. A valid identifier would be: serviceusage.googleapis.com Enabling services requires that each service is public or is shared with the user enabling the service. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur. */ - serviceIds?: string[]; + serviceIds?: string[] | null; } /** * Response message for the `BatchEnableServices` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. @@ -319,11 +319,11 @@ export namespace serviceusage_v1 { /** * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * The request message for Operations.CancelOperation. @@ -345,23 +345,23 @@ export namespace serviceusage_v1 { /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ - allowedRequestExtensions?: string[]; + allowedRequestExtensions?: string[] | null; /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ - allowedResponseExtensions?: string[]; + allowedResponseExtensions?: string[] | null; /** * A list of full type names of provided contexts. */ - provided?: string[]; + provided?: string[] | null; /** * A list of full type names of requested contexts. */ - requested?: string[]; + requested?: string[] | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. @@ -370,7 +370,7 @@ export namespace serviceusage_v1 { /** * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ - environment?: string; + environment?: string | null; } /** * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError @@ -383,7 +383,7 @@ export namespace serviceusage_v1 { /** * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ - types?: string[]; + types?: string[] | null; } /** * A custom error rule. @@ -392,11 +392,11 @@ export namespace serviceusage_v1 { /** * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ - isErrorType?: boolean; + isErrorType?: boolean | null; /** * Selects messages to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A custom pattern is used for defining custom HTTP verb. @@ -405,11 +405,11 @@ export namespace serviceusage_v1 { /** * The name of this custom HTTP verb. */ - kind?: string; + kind?: string | null; /** * The path matched by this custom verb. */ - path?: string; + path?: string | null; } /** * Request message for the `DisableService` method. @@ -418,7 +418,7 @@ export namespace serviceusage_v1 { /** * Indicates if services that are enabled and which depend on this service should also be disabled. If not set, an error will be generated if any enabled services depend on the service to be disabled. When set, the service, and any enabled services that depend on it, will be disabled together. */ - disableDependentServices?: boolean; + disableDependentServices?: boolean | null; } /** * Response message for the `DisableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. @@ -436,11 +436,11 @@ export namespace serviceusage_v1 { /** * The URL to the root of documentation. */ - documentationRootUrl?: string; + documentationRootUrl?: string | null; /** * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ - overview?: string; + overview?: string | null; /** * The top level pages for the documentation set. */ @@ -452,11 +452,11 @@ export namespace serviceusage_v1 { /** * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. */ - serviceRootUrl?: string; + serviceRootUrl?: string | null; /** * A short summary of what the service does. Can only be provided by plain text. */ - summary?: string; + summary?: string | null; } /** * A documentation rule provides information about individual API elements. @@ -465,15 +465,15 @@ export namespace serviceusage_v1 { /** * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ - deprecationDescription?: string; + deprecationDescription?: string | null; /** * Description of the selected API(s). */ - description?: string; + description?: string | null; /** * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ - selector?: string; + selector?: 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 `{}`. @@ -486,11 +486,11 @@ export namespace serviceusage_v1 { /** * An error message describing why the service could not be enabled. */ - errorMessage?: string; + errorMessage?: string | null; /** * The service id of a service that could not be enabled. */ - serviceId?: string; + serviceId?: string | null; } /** * Request message for the `EnableService` method. @@ -512,23 +512,23 @@ export namespace serviceusage_v1 { /** * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ - aliases?: string[]; + aliases?: string[] | null; /** * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ - allowCors?: boolean; + allowCors?: boolean | null; /** * The list of features enabled on this endpoint. */ - features?: string[]; + features?: string[] | null; /** * The canonical name of this endpoint. */ - name?: string; + name?: string | null; /** * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ - target?: string; + target?: string | null; } /** * Enum type definition. @@ -541,7 +541,7 @@ export namespace serviceusage_v1 { /** * Enum type name. */ - name?: string; + name?: string | null; /** * Protocol buffer options. */ @@ -553,7 +553,7 @@ export namespace serviceusage_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Enum value definition. @@ -562,11 +562,11 @@ export namespace serviceusage_v1 { /** * Enum value name. */ - name?: string; + name?: string | null; /** * Enum value number. */ - number?: number; + number?: number | null; /** * Protocol buffer options. */ @@ -579,31 +579,31 @@ export namespace serviceusage_v1 { /** * The field cardinality. */ - cardinality?: string; + cardinality?: string | null; /** * The string value of the default value of this field. Proto2 syntax only. */ - defaultValue?: string; + defaultValue?: string | null; /** * The field JSON name. */ - jsonName?: string; + jsonName?: string | null; /** * The field type. */ - kind?: string; + kind?: string | null; /** * The field name. */ - name?: string; + name?: string | null; /** * The field number. */ - number?: number; + number?: number | null; /** * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ - oneofIndex?: number; + oneofIndex?: number | null; /** * The protocol buffer options. */ @@ -611,11 +611,24 @@ export namespace serviceusage_v1 { /** * Whether to use alternative packed wire representation. */ - packed?: boolean; + packed?: boolean | null; /** * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ - typeUrl?: string; + typeUrl?: string | null; + } + /** + * Response message for getting service identity. + */ + export interface Schema$GetServiceIdentityResponse { + /** + * Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id. + */ + identity?: Schema$ServiceIdentity; + /** + * Service identity state. + */ + state?: string | null; } /** * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -640,7 +653,7 @@ export namespace serviceusage_v1 { /** * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ - configVersion?: number; + configVersion?: number | null; /** * Context configuration. */ @@ -672,7 +685,7 @@ export namespace serviceusage_v1 { /** * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ - id?: string; + id?: string | null; /** * Logging configuration. */ @@ -696,11 +709,11 @@ export namespace serviceusage_v1 { /** * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ - name?: string; + name?: string | null; /** * The Google project that owns this service. */ - producerProjectId?: string; + producerProjectId?: string | null; /** * Quota configuration. */ @@ -720,7 +733,7 @@ export namespace serviceusage_v1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ @@ -737,7 +750,7 @@ export namespace serviceusage_v1 { /** * The full name of the resources that this operation is directly associated with. */ - resourceNames?: string[]; + resourceNames?: string[] | null; } /** * A service that is available for use by the consumer. @@ -750,15 +763,15 @@ export namespace serviceusage_v1 { /** * The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */ - name?: string; + name?: string | null; /** * The resource name of the consumer. A valid name would be: - projects/123 */ - parent?: string; + parent?: string | null; /** * Whether or not the service has been enabled for use by the consumer. */ - state?: string; + state?: string | null; } /** * The configuration of the service. @@ -783,7 +796,7 @@ export namespace serviceusage_v1 { /** * The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */ - name?: string; + name?: string | null; /** * Quota configuration. */ @@ -791,7 +804,7 @@ export namespace serviceusage_v1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * Configuration controlling usage of this service. */ @@ -804,7 +817,7 @@ export namespace serviceusage_v1 { /** * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ - fullyDecodeReservedExpansion?: boolean; + fullyDecodeReservedExpansion?: boolean | null; /** * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -821,7 +834,7 @@ export namespace serviceusage_v1 { /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ - body?: string; + body?: string | null; /** * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ @@ -829,31 +842,31 @@ export namespace serviceusage_v1 { /** * Maps to HTTP DELETE. Used for deleting a resource. */ - delete?: string; + delete?: string | null; /** * Maps to HTTP GET. Used for listing and getting information about resources. */ - get?: string; + get?: string | null; /** * Maps to HTTP PATCH. Used for updating a resource. */ - patch?: string; + patch?: string | null; /** * Maps to HTTP POST. Used for creating a resource or performing an action. */ - post?: string; + post?: string | null; /** * Maps to HTTP PUT. Used for replacing a resource. */ - put?: string; + put?: string | null; /** * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ - responseBody?: string; + responseBody?: string | null; /** * Selects a method to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A description of a label. @@ -862,15 +875,15 @@ export namespace serviceusage_v1 { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * The response message for Operations.ListOperations. @@ -879,7 +892,7 @@ export namespace serviceusage_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -892,7 +905,7 @@ export namespace serviceusage_v1 { /** * Token that can be passed to `ListServices` to resume a paginated query. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The available services for the requested project. */ @@ -905,11 +918,11 @@ export namespace serviceusage_v1 { /** * A human-readable description of this log. This information appears in the documentation and can contain details. */ - description?: string; + description?: string | null; /** * The human-readable name for this log. This information appears on the user interface and should be concise. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ @@ -917,7 +930,7 @@ export namespace serviceusage_v1 { /** * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ - name?: string; + name?: string | null; } /** * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history @@ -939,11 +952,11 @@ export namespace serviceusage_v1 { /** * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ - logs?: string[]; + logs?: string[] | null; /** * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * Method represents a method of an API interface. @@ -952,7 +965,7 @@ export namespace serviceusage_v1 { /** * The simple name of this method. */ - name?: string; + name?: string | null; /** * Any metadata attached to the method. */ @@ -960,23 +973,23 @@ export namespace serviceusage_v1 { /** * If true, the request is streamed. */ - requestStreaming?: boolean; + requestStreaming?: boolean | null; /** * A URL of the input message type. */ - requestTypeUrl?: string; + requestTypeUrl?: string | null; /** * If true, the response is streamed. */ - responseStreaming?: boolean; + responseStreaming?: boolean | null; /** * The URL of the output message type. */ - responseTypeUrl?: string; + responseTypeUrl?: string | null; /** * The source syntax of this method. */ - syntax?: string; + syntax?: string | null; } /** * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. @@ -985,11 +998,11 @@ export namespace serviceusage_v1 { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ @@ -997,7 +1010,7 @@ export namespace serviceusage_v1 { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -1005,23 +1018,23 @@ export namespace serviceusage_v1 { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -1030,15 +1043,15 @@ export namespace serviceusage_v1 { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -1047,11 +1060,11 @@ export namespace serviceusage_v1 { /** * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ - metricCosts?: {[key: string]: string}; + metricCosts?: {[key: string]: string} | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } @@ -1060,11 +1073,11 @@ export namespace serviceusage_v1 { /** * The fully qualified name of the interface which is included. */ - name?: string; + name?: string | null; /** * If non-empty specifies a path under which inherited HTTP paths are rooted. */ - root?: string; + root?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. @@ -1073,11 +1086,11 @@ export namespace serviceusage_v1 { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ @@ -1085,15 +1098,15 @@ export namespace serviceusage_v1 { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count @@ -1115,11 +1128,11 @@ export namespace serviceusage_v1 { /** * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. @@ -1128,7 +1141,7 @@ export namespace serviceusage_v1 { /** * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ - canonicalScopes?: string; + canonicalScopes?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1137,7 +1150,7 @@ export namespace serviceusage_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1145,15 +1158,15 @@ export namespace serviceusage_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * The operation metadata returned for the batchend services operation. @@ -1162,7 +1175,7 @@ export namespace serviceusage_v1 { /** * The full name of the resources that this operation is directly associated with. */ - resourceNames?: string[]; + resourceNames?: string[] | null; } /** * A protocol buffer option, which can be attached to a message, field, enumeration, etc. @@ -1171,11 +1184,11 @@ export namespace serviceusage_v1 { /** * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ - name?: string; + name?: string | null; /** * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ - value?: {[key: string]: any}; + value?: {[key: string]: any} | null; } /** * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. @@ -1184,11 +1197,11 @@ export namespace serviceusage_v1 { /** * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ - content?: string; + content?: string | null; /** * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ - name?: string; + name?: string | null; /** * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ @@ -1214,43 +1227,43 @@ export namespace serviceusage_v1 { /** * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ - defaultLimit?: string; + defaultLimit?: string | null; /** * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ - description?: string; + description?: string | null; /** * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ - displayName?: string; + displayName?: string | null; /** - * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. + * Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */ - duration?: string; + duration?: string | null; /** * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ - freeTier?: string; + freeTier?: string | null; /** * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ - maxLimit?: string; + maxLimit?: string | null; /** * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ - metric?: string; + metric?: string | null; /** * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ - name?: string; + name?: string | null; /** * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ - unit?: string; + unit?: string | null; /** * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ - values?: {[key: string]: string}; + values?: {[key: string]: string} | null; } /** * A quota override @@ -1259,15 +1272,15 @@ export namespace serviceusage_v1 { /** * If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: - Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. - "project" is not a valid key; the project is already specified in the parent resource name. - "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. - If "region" appears as a key, its value must be a valid Cloud region. - If "zone" appears as a key, its value must be a valid Cloud zone. - If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. */ - dimensions?: {[key: string]: string}; + dimensions?: {[key: string]: string} | null; /** * The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. */ - name?: string; + name?: string | null; /** * The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */ - overrideValue?: string; + overrideValue?: string | null; } /** * Service identity for a service. This is the identity that service producer should use to access consumer resources. @@ -1276,11 +1289,11 @@ export namespace serviceusage_v1 { /** * The email address of the service account that a service producer would use to access consumer resources. */ - email?: string; + email?: string | null; /** * The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */ - uniqueId?: string; + uniqueId?: string | null; } /** * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. @@ -1289,7 +1302,7 @@ export namespace serviceusage_v1 { /** * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ - fileName?: string; + fileName?: string | null; } /** * Source information used to create a Service Config @@ -1298,7 +1311,7 @@ export namespace serviceusage_v1 { /** * All files used during config generation. */ - sourceFiles?: Array<{[key: string]: any}>; + sourceFiles?: Array<{[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). @@ -1307,15 +1320,15 @@ export namespace serviceusage_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. @@ -1324,15 +1337,15 @@ export namespace serviceusage_v1 { /** * Define the HTTP header name to use for the parameter. It is case insensitive. */ - httpHeader?: string; + httpHeader?: string | null; /** * Define the name of the parameter, such as "api_key" . It is case sensitive. */ - name?: string; + name?: string | null; /** * Define the URL query parameter name to use for the parameter. It is case sensitive. */ - urlQueryParameter?: string; + urlQueryParameter?: string | null; } /** * Define a system parameter rule mapping system parameter definitions to methods. @@ -1345,7 +1358,7 @@ export namespace serviceusage_v1 { /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. @@ -1367,11 +1380,11 @@ export namespace serviceusage_v1 { /** * The fully qualified message name. */ - name?: string; + name?: string | null; /** * The list of types appearing in `oneof` definitions in this type. */ - oneofs?: string[]; + oneofs?: string[] | null; /** * The protocol buffer options. */ @@ -1383,7 +1396,7 @@ export namespace serviceusage_v1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Configuration controlling usage of a service. @@ -1392,11 +1405,11 @@ export namespace serviceusage_v1 { /** * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ - producerNotificationChannel?: string; + producerNotificationChannel?: string | null; /** * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ - requirements?: string[]; + requirements?: string[] | null; /** * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -1409,15 +1422,15 @@ export namespace serviceusage_v1 { /** * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ - allowUnregisteredCalls?: boolean; + allowUnregisteredCalls?: boolean | null; /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; /** * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ - skipServiceControl?: boolean; + skipServiceControl?: boolean | null; } export class Resource$Operations { diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 266e0b0a1bd..b743e1e47ff 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -134,7 +134,7 @@ export namespace serviceusage_v1beta1 { /** * The fully qualified name of this interface, including package name followed by the interface's simple name. */ - name?: string; + name?: string | null; /** * Any metadata attached to the interface. */ @@ -146,11 +146,11 @@ export namespace serviceusage_v1beta1 { /** * The source syntax of the service. */ - syntax?: string; + syntax?: string | null; /** * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ - version?: string; + version?: string | null; } /** * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -172,7 +172,7 @@ export namespace serviceusage_v1beta1 { /** * If true, the service accepts API keys without any other credential. */ - allowWithoutCredential?: boolean; + allowWithoutCredential?: boolean | null; /** * The requirements for OAuth credentials. */ @@ -184,7 +184,7 @@ export namespace serviceusage_v1beta1 { /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -193,23 +193,23 @@ export namespace serviceusage_v1beta1 { /** * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ - authorizationUrl?: string; + authorizationUrl?: string | null; /** * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ - id?: string; + id?: string | null; /** * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ - issuer?: string; + issuer?: string | null; /** * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ - jwksUri?: string; + jwksUri?: string | null; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -218,11 +218,11 @@ export namespace serviceusage_v1beta1 { /** * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ - audiences?: string; + audiences?: string | null; /** * id from authentication provider. Example: provider_id: bookstore_auth */ - providerId?: string; + providerId?: string | null; } /** * `Backend` defines the backend configuration for a service. @@ -240,28 +240,28 @@ export namespace serviceusage_v1beta1 { /** * The address of the API backend. */ - address?: string; + address?: string | null; /** * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ - deadline?: number; + deadline?: number | null; /** * The JWT audience is used when generating a JWT id token for the backend. */ - jwtAudience?: string; + jwtAudience?: string | null; /** * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ - minDeadline?: number; + minDeadline?: number | null; /** * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ - operationDeadline?: number; - pathTranslation?: string; + operationDeadline?: number | null; + pathTranslation?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Response message for BatchCreateAdminOverrides @@ -288,7 +288,7 @@ export namespace serviceusage_v1beta1 { /** * The identifiers of the services to enable on the project. A valid identifier would be: serviceusage.googleapis.com Enabling services requires that each service is public or is shared with the user enabling the service. Two or more services must be specified. To enable a single service, use the `EnableService` method instead. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur. */ - serviceIds?: string[]; + serviceIds?: string[] | null; } /** * Response message for the `BatchEnableServices` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. @@ -319,11 +319,11 @@ export namespace serviceusage_v1beta1 { /** * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. @@ -341,23 +341,23 @@ export namespace serviceusage_v1beta1 { /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ - allowedRequestExtensions?: string[]; + allowedRequestExtensions?: string[] | null; /** * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ - allowedResponseExtensions?: string[]; + allowedResponseExtensions?: string[] | null; /** * A list of full type names of provided contexts. */ - provided?: string[]; + provided?: string[] | null; /** * A list of full type names of requested contexts. */ - requested?: string[]; + requested?: string[] | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. @@ -366,7 +366,7 @@ export namespace serviceusage_v1beta1 { /** * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ - environment?: string; + environment?: string | null; } /** * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError @@ -379,7 +379,7 @@ export namespace serviceusage_v1beta1 { /** * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ - types?: string[]; + types?: string[] | null; } /** * A custom error rule. @@ -388,11 +388,11 @@ export namespace serviceusage_v1beta1 { /** * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ - isErrorType?: boolean; + isErrorType?: boolean | null; /** * Selects messages to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A custom pattern is used for defining custom HTTP verb. @@ -401,11 +401,11 @@ export namespace serviceusage_v1beta1 { /** * The name of this custom HTTP verb. */ - kind?: string; + kind?: string | null; /** * The path matched by this custom verb. */ - path?: string; + path?: string | null; } /** * Request message for the `DisableService` method. @@ -427,11 +427,11 @@ export namespace serviceusage_v1beta1 { /** * The URL to the root of documentation. */ - documentationRootUrl?: string; + documentationRootUrl?: string | null; /** * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ - overview?: string; + overview?: string | null; /** * The top level pages for the documentation set. */ @@ -443,11 +443,11 @@ export namespace serviceusage_v1beta1 { /** * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. */ - serviceRootUrl?: string; + serviceRootUrl?: string | null; /** * A short summary of what the service does. Can only be provided by plain text. */ - summary?: string; + summary?: string | null; } /** * A documentation rule provides information about individual API elements. @@ -456,15 +456,15 @@ export namespace serviceusage_v1beta1 { /** * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ - deprecationDescription?: string; + deprecationDescription?: string | null; /** * Description of the selected API(s). */ - description?: string; + description?: string | null; /** * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ - selector?: string; + selector?: 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 `{}`. @@ -477,11 +477,11 @@ export namespace serviceusage_v1beta1 { /** * An error message describing why the service could not be enabled. */ - errorMessage?: string; + errorMessage?: string | null; /** * The service id of a service that could not be enabled. */ - serviceId?: string; + serviceId?: string | null; } /** * Request message for the `EnableService` method. @@ -503,23 +503,23 @@ export namespace serviceusage_v1beta1 { /** * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ - aliases?: string[]; + aliases?: string[] | null; /** * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ - allowCors?: boolean; + allowCors?: boolean | null; /** * The list of features enabled on this endpoint. */ - features?: string[]; + features?: string[] | null; /** * The canonical name of this endpoint. */ - name?: string; + name?: string | null; /** * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ - target?: string; + target?: string | null; } /** * Enum type definition. @@ -532,7 +532,7 @@ export namespace serviceusage_v1beta1 { /** * Enum type name. */ - name?: string; + name?: string | null; /** * Protocol buffer options. */ @@ -544,7 +544,7 @@ export namespace serviceusage_v1beta1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Enum value definition. @@ -553,11 +553,11 @@ export namespace serviceusage_v1beta1 { /** * Enum value name. */ - name?: string; + name?: string | null; /** * Enum value number. */ - number?: number; + number?: number | null; /** * Protocol buffer options. */ @@ -570,31 +570,31 @@ export namespace serviceusage_v1beta1 { /** * The field cardinality. */ - cardinality?: string; + cardinality?: string | null; /** * The string value of the default value of this field. Proto2 syntax only. */ - defaultValue?: string; + defaultValue?: string | null; /** * The field JSON name. */ - jsonName?: string; + jsonName?: string | null; /** * The field type. */ - kind?: string; + kind?: string | null; /** * The field name. */ - name?: string; + name?: string | null; /** * The field number. */ - number?: number; + number?: number | null; /** * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ - oneofIndex?: number; + oneofIndex?: number | null; /** * The protocol buffer options. */ @@ -602,11 +602,24 @@ export namespace serviceusage_v1beta1 { /** * Whether to use alternative packed wire representation. */ - packed?: boolean; + packed?: boolean | null; /** * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ - typeUrl?: string; + typeUrl?: string | null; + } + /** + * Response message for getting service identity. + */ + export interface Schema$GetServiceIdentityResponse { + /** + * Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id. + */ + identity?: Schema$ServiceIdentity; + /** + * Service identity state. + */ + state?: string | null; } /** * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth @@ -631,7 +644,7 @@ export namespace serviceusage_v1beta1 { /** * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ - configVersion?: number; + configVersion?: number | null; /** * Context configuration. */ @@ -663,7 +676,7 @@ export namespace serviceusage_v1beta1 { /** * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ - id?: string; + id?: string | null; /** * Logging configuration. */ @@ -687,11 +700,11 @@ export namespace serviceusage_v1beta1 { /** * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ - name?: string; + name?: string | null; /** * The Google project that owns this service. */ - producerProjectId?: string; + producerProjectId?: string | null; /** * Quota configuration. */ @@ -711,7 +724,7 @@ export namespace serviceusage_v1beta1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ @@ -728,7 +741,7 @@ export namespace serviceusage_v1beta1 { /** * The full name of the resources that this operation is directly associated with. */ - resourceNames?: string[]; + resourceNames?: string[] | null; } /** * A service that is available for use by the consumer. @@ -741,15 +754,15 @@ export namespace serviceusage_v1beta1 { /** * The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */ - name?: string; + name?: string | null; /** * The resource name of the consumer. A valid name would be: - projects/123 */ - parent?: string; + parent?: string | null; /** * Whether or not the service has been enabled for use by the consumer. */ - state?: string; + state?: string | null; } /** * The configuration of the service. @@ -774,7 +787,7 @@ export namespace serviceusage_v1beta1 { /** * The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */ - name?: string; + name?: string | null; /** * Quota configuration. */ @@ -782,7 +795,7 @@ export namespace serviceusage_v1beta1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * Configuration controlling usage of this service. */ @@ -795,7 +808,7 @@ export namespace serviceusage_v1beta1 { /** * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ - fullyDecodeReservedExpansion?: boolean; + fullyDecodeReservedExpansion?: boolean | null; /** * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -812,7 +825,7 @@ export namespace serviceusage_v1beta1 { /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ - body?: string; + body?: string | null; /** * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ @@ -820,31 +833,31 @@ export namespace serviceusage_v1beta1 { /** * Maps to HTTP DELETE. Used for deleting a resource. */ - delete?: string; + delete?: string | null; /** * Maps to HTTP GET. Used for listing and getting information about resources. */ - get?: string; + get?: string | null; /** * Maps to HTTP PATCH. Used for updating a resource. */ - patch?: string; + patch?: string | null; /** * Maps to HTTP POST. Used for creating a resource or performing an action. */ - post?: string; + post?: string | null; /** * Maps to HTTP PUT. Used for replacing a resource. */ - put?: string; + put?: string | null; /** * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ - responseBody?: string; + responseBody?: string | null; /** * Selects a method to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * A description of a label. @@ -853,15 +866,15 @@ export namespace serviceusage_v1beta1 { /** * A human-readable description for the label. */ - description?: string; + description?: string | null; /** * The label key. */ - key?: string; + key?: string | null; /** * The type of data that can be assigned to the label. */ - valueType?: string; + valueType?: string | null; } /** * The response message for Operations.ListOperations. @@ -870,7 +883,7 @@ export namespace serviceusage_v1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -883,7 +896,7 @@ export namespace serviceusage_v1beta1 { /** * Token that can be passed to `ListServices` to resume a paginated query. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The available services for the requested project. */ @@ -896,11 +909,11 @@ export namespace serviceusage_v1beta1 { /** * A human-readable description of this log. This information appears in the documentation and can contain details. */ - description?: string; + description?: string | null; /** * The human-readable name for this log. This information appears on the user interface and should be concise. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ @@ -908,7 +921,7 @@ export namespace serviceusage_v1beta1 { /** * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ - name?: string; + name?: string | null; } /** * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history @@ -930,11 +943,11 @@ export namespace serviceusage_v1beta1 { /** * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ - logs?: string[]; + logs?: string[] | null; /** * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * Method represents a method of an API interface. @@ -943,7 +956,7 @@ export namespace serviceusage_v1beta1 { /** * The simple name of this method. */ - name?: string; + name?: string | null; /** * Any metadata attached to the method. */ @@ -951,23 +964,23 @@ export namespace serviceusage_v1beta1 { /** * If true, the request is streamed. */ - requestStreaming?: boolean; + requestStreaming?: boolean | null; /** * A URL of the input message type. */ - requestTypeUrl?: string; + requestTypeUrl?: string | null; /** * If true, the response is streamed. */ - responseStreaming?: boolean; + responseStreaming?: boolean | null; /** * The URL of the output message type. */ - responseTypeUrl?: string; + responseTypeUrl?: string | null; /** * The source syntax of this method. */ - syntax?: string; + syntax?: string | null; } /** * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. @@ -976,11 +989,11 @@ export namespace serviceusage_v1beta1 { /** * A detailed description of the metric, which can be used in documentation. */ - description?: string; + description?: string | null; /** * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ - displayName?: string; + displayName?: string | null; /** * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ @@ -988,7 +1001,7 @@ export namespace serviceusage_v1beta1 { /** * Optional. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -996,23 +1009,23 @@ export namespace serviceusage_v1beta1 { /** * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - metricKind?: string; + metricKind?: string | null; /** * The resource name of the metric descriptor. */ - name?: string; + name?: string | null; /** * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ - type?: string; + 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. */ - unit?: string; + unit?: string | null; /** * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ - valueType?: string; + valueType?: string | null; } /** * Additional annotations that can be used to guide the usage of a metric. @@ -1021,15 +1034,15 @@ export namespace serviceusage_v1beta1 { /** * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ - ingestDelay?: string; + ingestDelay?: string | null; /** * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ - launchStage?: string; + launchStage?: string | null; /** * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ - samplePeriod?: string; + samplePeriod?: string | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -1038,11 +1051,11 @@ export namespace serviceusage_v1beta1 { /** * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ - metricCosts?: {[key: string]: string}; + metricCosts?: {[key: string]: string} | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } @@ -1051,11 +1064,11 @@ export namespace serviceusage_v1beta1 { /** * The fully qualified name of the interface which is included. */ - name?: string; + name?: string | null; /** * If non-empty specifies a path under which inherited HTTP paths are rooted. */ - root?: string; + root?: string | null; } /** * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. @@ -1064,11 +1077,11 @@ export namespace serviceusage_v1beta1 { /** * Optional. A detailed description of the monitored resource type that might be used in documentation. */ - description?: string; + description?: string | null; /** * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ - displayName?: string; + displayName?: string | null; /** * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ @@ -1076,15 +1089,15 @@ export namespace serviceusage_v1beta1 { /** * Optional. The launch stage of the monitored resource definition. */ - launchStage?: string; + launchStage?: string | null; /** * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ - name?: string; + name?: string | null; /** * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ - type?: string; + type?: string | null; } /** * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count @@ -1106,11 +1119,11 @@ export namespace serviceusage_v1beta1 { /** * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ - metrics?: string[]; + metrics?: string[] | null; /** * The monitored resource type. The type must be defined in Service.monitored_resources section. */ - monitoredResource?: string; + monitoredResource?: string | null; } /** * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. @@ -1119,7 +1132,7 @@ export namespace serviceusage_v1beta1 { /** * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ - canonicalScopes?: string; + canonicalScopes?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1128,7 +1141,7 @@ export namespace serviceusage_v1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -1136,15 +1149,15 @@ export namespace serviceusage_v1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * The operation metadata returned for the batchend services operation. @@ -1153,7 +1166,7 @@ export namespace serviceusage_v1beta1 { /** * The full name of the resources that this operation is directly associated with. */ - resourceNames?: string[]; + resourceNames?: string[] | null; } /** * A protocol buffer option, which can be attached to a message, field, enumeration, etc. @@ -1162,11 +1175,11 @@ export namespace serviceusage_v1beta1 { /** * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ - name?: string; + name?: string | null; /** * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ - value?: {[key: string]: any}; + value?: {[key: string]: any} | null; } /** * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. @@ -1175,11 +1188,11 @@ export namespace serviceusage_v1beta1 { /** * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ - content?: string; + content?: string | null; /** * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ - name?: string; + name?: string | null; /** * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ @@ -1205,43 +1218,43 @@ export namespace serviceusage_v1beta1 { /** * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ - defaultLimit?: string; + defaultLimit?: string | null; /** * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ - description?: string; + description?: string | null; /** * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ - displayName?: string; + displayName?: string | null; /** - * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. + * Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */ - duration?: string; + duration?: string | null; /** * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ - freeTier?: string; + freeTier?: string | null; /** * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ - maxLimit?: string; + maxLimit?: string | null; /** * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ - metric?: string; + metric?: string | null; /** * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ - name?: string; + name?: string | null; /** * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ - unit?: string; + unit?: string | null; /** * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ - values?: {[key: string]: string}; + values?: {[key: string]: string} | null; } /** * A quota override @@ -1250,15 +1263,15 @@ export namespace serviceusage_v1beta1 { /** * If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: - Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. - "project" is not a valid key; the project is already specified in the parent resource name. - "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. - If "region" appears as a key, its value must be a valid Cloud region. - If "zone" appears as a key, its value must be a valid Cloud zone. - If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. */ - dimensions?: {[key: string]: string}; + dimensions?: {[key: string]: string} | null; /** * The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. */ - name?: string; + name?: string | null; /** * The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */ - overrideValue?: string; + overrideValue?: string | null; } /** * A service that is available for use by the consumer. @@ -1271,15 +1284,15 @@ export namespace serviceusage_v1beta1 { /** * The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */ - name?: string; + name?: string | null; /** * The resource name of the consumer. A valid name would be: - projects/123 */ - parent?: string; + parent?: string | null; /** * Whether or not the service has been enabled for use by the consumer. */ - state?: string; + state?: string | null; } /** * The configuration of the service. @@ -1304,7 +1317,7 @@ export namespace serviceusage_v1beta1 { /** * The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */ - name?: string; + name?: string | null; /** * Quota configuration. */ @@ -1312,7 +1325,7 @@ export namespace serviceusage_v1beta1 { /** * The product title for this service. */ - title?: string; + title?: string | null; /** * Configuration controlling usage of this service. */ @@ -1325,11 +1338,11 @@ export namespace serviceusage_v1beta1 { /** * The email address of the service account that a service producer would use to access consumer resources. */ - email?: string; + email?: string | null; /** * The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */ - uniqueId?: string; + uniqueId?: string | null; } /** * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. @@ -1338,7 +1351,7 @@ export namespace serviceusage_v1beta1 { /** * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ - fileName?: string; + fileName?: string | null; } /** * Source information used to create a Service Config @@ -1347,7 +1360,7 @@ export namespace serviceusage_v1beta1 { /** * All files used during config generation. */ - sourceFiles?: Array<{[key: string]: any}>; + sourceFiles?: Array<{[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). @@ -1356,15 +1369,15 @@ export namespace serviceusage_v1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. @@ -1373,15 +1386,15 @@ export namespace serviceusage_v1beta1 { /** * Define the HTTP header name to use for the parameter. It is case insensitive. */ - httpHeader?: string; + httpHeader?: string | null; /** * Define the name of the parameter, such as "api_key" . It is case sensitive. */ - name?: string; + name?: string | null; /** * Define the URL query parameter name to use for the parameter. It is case sensitive. */ - urlQueryParameter?: string; + urlQueryParameter?: string | null; } /** * Define a system parameter rule mapping system parameter definitions to methods. @@ -1394,7 +1407,7 @@ export namespace serviceusage_v1beta1 { /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; } /** * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. @@ -1416,11 +1429,11 @@ export namespace serviceusage_v1beta1 { /** * The fully qualified message name. */ - name?: string; + name?: string | null; /** * The list of types appearing in `oneof` definitions in this type. */ - oneofs?: string[]; + oneofs?: string[] | null; /** * The protocol buffer options. */ @@ -1432,7 +1445,7 @@ export namespace serviceusage_v1beta1 { /** * The source syntax. */ - syntax?: string; + syntax?: string | null; } /** * Configuration controlling usage of a service. @@ -1441,11 +1454,11 @@ export namespace serviceusage_v1beta1 { /** * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ - producerNotificationChannel?: string; + producerNotificationChannel?: string | null; /** * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ - requirements?: string[]; + requirements?: string[] | null; /** * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ @@ -1458,15 +1471,15 @@ export namespace serviceusage_v1beta1 { /** * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ - allowUnregisteredCalls?: boolean; + allowUnregisteredCalls?: boolean | null; /** * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ - selector?: string; + selector?: string | null; /** * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ - skipServiceControl?: boolean; + skipServiceControl?: boolean | null; } export class Resource$Operations { diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index b1dc1386a0c..61d5dfe13ec 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -160,7 +160,7 @@ export namespace sheets_v4 { /** * The zero-based index where the rule should be inserted. */ - index?: number; + index?: number | null; /** * The rule to add. */ @@ -263,7 +263,7 @@ export namespace sheets_v4 { /** * The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The data to append. */ @@ -271,7 +271,7 @@ export namespace sheets_v4 { /** * The sheet ID to append the data to. */ - sheetId?: number; + sheetId?: number | null; } /** * Appends rows or columns to the end of a sheet. @@ -280,15 +280,15 @@ export namespace sheets_v4 { /** * Whether rows or columns should be appended. */ - dimension?: string; + dimension?: string | null; /** * The number of rows or columns to append. */ - length?: number; + length?: number | null; /** * The sheet to append rows or columns to. */ - sheetId?: number; + sheetId?: number | null; } /** * The response when updating a range of values in a spreadsheet. @@ -297,11 +297,11 @@ export namespace sheets_v4 { /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The range (in A1 notation) of the table that values are being appended to (before the values were appended). Empty if no table was found. */ - tableRange?: string; + tableRange?: string | null; /** * Information about the updates that were applied. */ @@ -322,7 +322,7 @@ export namespace sheets_v4 { /** * True if we should generate data with the "alternate" series. This differs based on the type and amount of source data. */ - useAlternateSeries?: boolean; + useAlternateSeries?: boolean | null; } /** * Automatically resizes one or more dimensions based on the contents of the cells in that dimension. @@ -340,7 +340,7 @@ export namespace sheets_v4 { /** * The id of the banded range. */ - bandedRangeId?: number; + bandedRangeId?: number | null; /** * Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified. */ @@ -386,11 +386,11 @@ export namespace sheets_v4 { /** * The position of this axis. */ - position?: string; + position?: string | null; /** * The title of this axis. If set, this overrides any title inferred from headers of the data. */ - title?: string; + title?: string | null; /** * The axis title text position. */ @@ -411,7 +411,7 @@ export namespace sheets_v4 { /** * True to reverse the order of the domain values (horizontal axis). */ - reversed?: boolean; + reversed?: boolean | null; } /** * A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". @@ -432,11 +432,11 @@ export namespace sheets_v4 { /** * The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. */ - targetAxis?: string; + targetAxis?: string | null; /** * The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. */ - type?: string; + type?: string | null; } /** * The specification for a basic chart. See BasicChartType for the list of charts this supports. @@ -449,11 +449,11 @@ export namespace sheets_v4 { /** * The type of the chart. */ - chartType?: string; + chartType?: string | null; /** * The behavior of tooltips and data highlighting when hovering on data and chart area. */ - compareMode?: string; + compareMode?: string | null; /** * The domain of data this is charting. Only a single domain is supported. */ @@ -461,19 +461,19 @@ export namespace sheets_v4 { /** * The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) */ - headerCount?: number; + headerCount?: number | null; /** * If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. */ - interpolateNulls?: boolean; + interpolateNulls?: boolean | null; /** * The position of the chart legend. */ - legendPosition?: string; + legendPosition?: string | null; /** * Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. */ - lineSmoothing?: boolean; + lineSmoothing?: boolean | null; /** * The data this chart is visualizing. */ @@ -481,11 +481,11 @@ export namespace sheets_v4 { /** * The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. */ - stackedType?: string; + stackedType?: string | null; /** * True to make the chart 3D. Applies to Bar and Column charts. */ - threeDimensional?: boolean; + threeDimensional?: boolean | null; } /** * The default filter associated with a sheet. @@ -494,7 +494,7 @@ export namespace sheets_v4 { /** * The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. */ - criteria?: {[key: string]: Schema$FilterCriteria}; + criteria?: {[key: string]: Schema$FilterCriteria} | null; /** * The range the filter covers. */ @@ -520,11 +520,11 @@ export namespace sheets_v4 { /** * The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.) */ - clearedRanges?: string[]; + clearedRanges?: string[] | null; /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; } /** * The request for clearing more than one range of values in a spreadsheet. @@ -533,7 +533,7 @@ export namespace sheets_v4 { /** * The ranges to clear, in A1 notation. */ - ranges?: string[]; + ranges?: string[] | null; } /** * The response when clearing a range of values in a spreadsheet. @@ -542,11 +542,11 @@ export namespace sheets_v4 { /** * The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.) */ - clearedRanges?: string[]; + clearedRanges?: string[] | null; /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; } /** * The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters. @@ -559,15 +559,15 @@ export namespace sheets_v4 { /** * How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. */ - dateTimeRenderOption?: string; + dateTimeRenderOption?: string | null; /** * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. */ - majorDimension?: string; + majorDimension?: string | null; /** * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */ - valueRenderOption?: string; + valueRenderOption?: string | null; } /** * The response when retrieving more than one range of values in a spreadsheet selected by DataFilters. @@ -576,7 +576,7 @@ export namespace sheets_v4 { /** * The ID of the spreadsheet the data was retrieved from. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The requested values with the list of data filters that matched them. */ @@ -589,7 +589,7 @@ export namespace sheets_v4 { /** * The ID of the spreadsheet the data was retrieved from. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The requested values. The order of the ValueRanges is the same as the order of the requested ranges. */ @@ -602,7 +602,7 @@ export namespace sheets_v4 { /** * Determines if the update response should include the spreadsheet resource. */ - includeSpreadsheetInResponse?: boolean; + includeSpreadsheetInResponse?: boolean | null; /** * A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied. */ @@ -610,11 +610,11 @@ export namespace sheets_v4 { /** * True if grid data should be returned. Meaningful only if if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request. */ - responseIncludeGridData?: boolean; + responseIncludeGridData?: boolean | null; /** * Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_response is 'true'. */ - responseRanges?: string[]; + responseRanges?: string[] | null; } /** * The reply for batch updating a spreadsheet. @@ -627,7 +627,7 @@ export namespace sheets_v4 { /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The spreadsheet after updates were applied. This is only set if [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`. */ @@ -644,19 +644,19 @@ export namespace sheets_v4 { /** * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). */ - includeValuesInResponse?: boolean; + includeValuesInResponse?: boolean | null; /** * Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. */ - responseDateTimeRenderOption?: string; + responseDateTimeRenderOption?: string | null; /** * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. */ - responseValueRenderOption?: string; + responseValueRenderOption?: string | null; /** * How the input data should be interpreted. */ - valueInputOption?: string; + valueInputOption?: string | null; } /** * The response when updating a range of values in a spreadsheet. @@ -669,23 +669,23 @@ export namespace sheets_v4 { /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The total number of cells updated. */ - totalUpdatedCells?: number; + totalUpdatedCells?: number | null; /** * The total number of columns where at least one cell in the column was updated. */ - totalUpdatedColumns?: number; + totalUpdatedColumns?: number | null; /** * The total number of rows where at least one cell in the row was updated. */ - totalUpdatedRows?: number; + totalUpdatedRows?: number | null; /** * The total number of sheets where at least one cell in the sheet was updated. */ - totalUpdatedSheets?: number; + totalUpdatedSheets?: number | null; } /** * The request for updating more than one range of values in a spreadsheet. @@ -698,19 +698,19 @@ export namespace sheets_v4 { /** * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). */ - includeValuesInResponse?: boolean; + includeValuesInResponse?: boolean | null; /** * Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. */ - responseDateTimeRenderOption?: string; + responseDateTimeRenderOption?: string | null; /** * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. */ - responseValueRenderOption?: string; + responseValueRenderOption?: string | null; /** * How the input data should be interpreted. */ - valueInputOption?: string; + valueInputOption?: string | null; } /** * The response when updating a range of values in a spreadsheet. @@ -723,23 +723,23 @@ export namespace sheets_v4 { /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The total number of cells updated. */ - totalUpdatedCells?: number; + totalUpdatedCells?: number | null; /** * The total number of columns where at least one cell in the column was updated. */ - totalUpdatedColumns?: number; + totalUpdatedColumns?: number | null; /** * The total number of rows where at least one cell in the row was updated. */ - totalUpdatedRows?: number; + totalUpdatedRows?: number | null; /** * The total number of sheets where at least one cell in the sheet was updated. */ - totalUpdatedSheets?: number; + totalUpdatedSheets?: number | null; } /** * A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters. @@ -748,7 +748,7 @@ export namespace sheets_v4 { /** * The type of condition. */ - type?: string; + type?: string | null; /** * The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values. */ @@ -778,11 +778,11 @@ export namespace sheets_v4 { /** * The style of the border. */ - style?: string; + style?: string | null; /** * The width of the border, in pixels. Deprecated; the width is determined by the "style" field. */ - width?: number; + width?: number | null; } /** * The borders of the cell. @@ -820,15 +820,15 @@ export namespace sheets_v4 { /** * The max radius size of the bubbles, in pixels. If specified, the field must be a positive value. */ - bubbleMaxRadiusSize?: number; + bubbleMaxRadiusSize?: number | null; /** * The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value. */ - bubbleMinRadiusSize?: number; + bubbleMinRadiusSize?: number | null; /** * The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque. */ - bubbleOpacity?: number; + bubbleOpacity?: number | null; /** * The data contianing the bubble sizes. Bubble sizes are used to draw the bubbles at different sizes relative to each other. If specified, group_ids must also be specified. This field is optional. */ @@ -848,7 +848,7 @@ export namespace sheets_v4 { /** * Where the legend of the chart should be drawn. */ - legendPosition?: string; + legendPosition?: string | null; /** * The data contianing the bubble y-values. These values locate the bubbles in the chart vertically. */ @@ -899,7 +899,7 @@ export namespace sheets_v4 { /** * True to reverse the order of the domain values (horizontal axis). */ - reversed?: boolean; + reversed?: boolean | null; } /** * The series of a CandlestickData. @@ -929,15 +929,15 @@ export namespace sheets_v4 { /** * The formatted value of the cell. This is the value as it's shown to the user. This field is read-only. */ - formattedValue?: string; + formattedValue?: string | null; /** * A hyperlink this cell points to, if any. This field is read-only. (To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field.) */ - hyperlink?: string; + hyperlink?: string | null; /** * Any note on the cell. */ - note?: string; + note?: string | null; /** * A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effective_value fields. */ @@ -970,11 +970,11 @@ export namespace sheets_v4 { /** * The horizontal alignment of the value in the cell. */ - horizontalAlignment?: string; + horizontalAlignment?: string | null; /** * How a hyperlink, if it exists, should be displayed in the cell. */ - hyperlinkDisplayType?: string; + hyperlinkDisplayType?: string | null; /** * A format describing how number values should be represented to the user. */ @@ -986,7 +986,7 @@ export namespace sheets_v4 { /** * The direction of the text in the cell. */ - textDirection?: string; + textDirection?: string | null; /** * The format of the text in the cell (unless overridden by a format run). */ @@ -998,11 +998,11 @@ export namespace sheets_v4 { /** * The vertical alignment of the value in the cell. */ - verticalAlignment?: string; + verticalAlignment?: string | null; /** * The wrap strategy for the value in the cell. */ - wrapStrategy?: string; + wrapStrategy?: string | null; } /** * The options that define a "view window" for a chart (such as the visible values in an axis). @@ -1011,15 +1011,15 @@ export namespace sheets_v4 { /** * The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data. */ - viewWindowMax?: number; + viewWindowMax?: number | null; /** * The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data. */ - viewWindowMin?: number; + viewWindowMin?: number | null; /** * The view window's mode. */ - viewWindowMode?: string; + viewWindowMode?: string | null; } /** * The data included in a domain or series. @@ -1046,7 +1046,7 @@ export namespace sheets_v4 { /** * The alternative text that describes the chart. This is often used for accessibility. */ - altText?: string; + altText?: string | null; /** * The background color of the entire chart. Not applicable to Org charts. */ @@ -1066,11 +1066,11 @@ export namespace sheets_v4 { /** * The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name. */ - fontName?: string; + fontName?: string | null; /** * Determines how the charts will use hidden rows or columns. */ - hiddenDimensionStrategy?: string; + hiddenDimensionStrategy?: string | null; /** * A histogram chart specification. */ @@ -1078,7 +1078,7 @@ export namespace sheets_v4 { /** * True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.) */ - maximized?: boolean; + maximized?: boolean | null; /** * An org chart specification. */ @@ -1090,7 +1090,7 @@ export namespace sheets_v4 { /** * The subtitle of the chart. */ - subtitle?: string; + subtitle?: string | null; /** * The subtitle text format. Strikethrough and underline are not supported. */ @@ -1102,7 +1102,7 @@ export namespace sheets_v4 { /** * The title of the chart. */ - title?: string; + title?: string | null; /** * The title text format. Strikethrough and underline are not supported. */ @@ -1127,7 +1127,7 @@ export namespace sheets_v4 { /** * The sheet ID on which the basic filter should be cleared. */ - sheetId?: number; + sheetId?: number | null; } /** * The request for clearing a range of values in a spreadsheet. @@ -1140,11 +1140,11 @@ export namespace sheets_v4 { /** * The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet's limits.) */ - clearedRange?: string; + clearedRange?: string | null; /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; } /** * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... @@ -1153,19 +1153,19 @@ export namespace sheets_v4 { /** * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ - alpha?: number; + alpha?: number | null; /** * The amount of blue in the color as a value in the interval [0, 1]. */ - blue?: number; + blue?: number | null; /** * The amount of green in the color as a value in the interval [0, 1]. */ - green?: number; + green?: number | null; /** * The amount of red in the color as a value in the interval [0, 1]. */ - red?: number; + red?: number | null; } /** * A rule describing a conditional format. @@ -1191,11 +1191,11 @@ export namespace sheets_v4 { /** * A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters. */ - relativeDate?: string; + relativeDate?: string | null; /** * A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+'). */ - userEnteredValue?: string; + userEnteredValue?: string | null; } /** * Copies data from the source to the destination. @@ -1208,11 +1208,11 @@ export namespace sheets_v4 { /** * How that data should be oriented when pasting. */ - pasteOrientation?: string; + pasteOrientation?: string | null; /** * What kind of data to paste. */ - pasteType?: string; + pasteType?: string | null; /** * The source range to copy. */ @@ -1225,7 +1225,7 @@ export namespace sheets_v4 { /** * The ID of the spreadsheet to copy the sheet to. */ - destinationSpreadsheetId?: string; + destinationSpreadsheetId?: string | null; } /** * A request to create developer metadata. @@ -1256,7 +1256,7 @@ export namespace sheets_v4 { /** * What kind of data to paste. All the source data will be cut, regardless of what is pasted. */ - pasteType?: string; + pasteType?: string | null; /** * The source data to cut. */ @@ -1269,7 +1269,7 @@ export namespace sheets_v4 { /** * Selects data that matches the specified A1 range. */ - a1Range?: string; + a1Range?: string | null; /** * Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */ @@ -1290,11 +1290,11 @@ export namespace sheets_v4 { /** * The major dimension of the values. */ - majorDimension?: string; + majorDimension?: string | null; /** * The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request will fail. If the provided values are less than the matched ranges only the specified values will be written, existing values in the matched ranges will remain unaffected. */ - values?: any[][]; + values?: any[][] | null; } /** * A data validation rule. @@ -1307,15 +1307,15 @@ export namespace sheets_v4 { /** * A message to show the user when adding data to the cell. */ - inputMessage?: string; + inputMessage?: string | null; /** * True if the UI should be customized based on the kind of condition. If true, "List" conditions will show a dropdown. */ - showCustomUi?: boolean; + showCustomUi?: boolean | null; /** * True if invalid data should be rejected. */ - strict?: boolean; + strict?: boolean | null; } /** * Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+--------------+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +--------------+--------------+ | Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +--------------+--------------+ @@ -1324,7 +1324,7 @@ export namespace sheets_v4 { /** * The type of date-time grouping to apply. */ - type?: string; + type?: string | null; } /** * Removes the banded range with the given ID from the spreadsheet. @@ -1333,7 +1333,7 @@ export namespace sheets_v4 { /** * The ID of the banded range to delete. */ - bandedRangeId?: number; + bandedRangeId?: number | null; } /** * Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented. @@ -1342,11 +1342,11 @@ export namespace sheets_v4 { /** * The zero-based index of the rule to be deleted. */ - index?: number; + index?: number | null; /** * The sheet the rule is being deleted from. */ - sheetId?: number; + sheetId?: number | null; } /** * The result of deleting a conditional format rule. @@ -1422,7 +1422,7 @@ export namespace sheets_v4 { /** * The number of duplicate rows removed. */ - duplicatesRemovedCount?: number; + duplicatesRemovedCount?: number | null; } /** * Deletes the embedded object with the given ID. @@ -1431,7 +1431,7 @@ export namespace sheets_v4 { /** * The ID of the embedded object to delete. */ - objectId?: number; + objectId?: number | null; } /** * Deletes a particular filter view. @@ -1440,7 +1440,7 @@ export namespace sheets_v4 { /** * The ID of the filter to delete. */ - filterId?: number; + filterId?: number | null; } /** * Removes the named range with the given ID from the spreadsheet. @@ -1449,7 +1449,7 @@ export namespace sheets_v4 { /** * The ID of the named range to delete. */ - namedRangeId?: string; + namedRangeId?: string | null; } /** * Deletes the protected range with the given ID. @@ -1458,7 +1458,7 @@ export namespace sheets_v4 { /** * The ID of the protected range to delete. */ - protectedRangeId?: number; + protectedRangeId?: number | null; } /** * Deletes a range of cells, shifting other cells into the deleted area. @@ -1471,7 +1471,7 @@ export namespace sheets_v4 { /** * The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells. */ - shiftDimension?: string; + shiftDimension?: string | null; } /** * Deletes the requested sheet. @@ -1480,7 +1480,7 @@ export namespace sheets_v4 { /** * The ID of the sheet to delete. */ - sheetId?: number; + sheetId?: number | null; } /** * Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too. @@ -1493,19 +1493,19 @@ export namespace sheets_v4 { /** * The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive. */ - metadataId?: number; + metadataId?: number | null; /** * The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified. */ - metadataKey?: string; + metadataKey?: string | null; /** * Data associated with the metadata's key. */ - metadataValue?: string; + metadataValue?: string | null; /** * The metadata visibility. Developer metadata must always have a visibility specified. */ - visibility?: string; + visibility?: string | null; } /** * A location where metadata may be associated in a spreadsheet. @@ -1518,15 +1518,15 @@ export namespace sheets_v4 { /** * The type of location this object represents. This field is read-only. */ - locationType?: string; + locationType?: string | null; /** * The ID of the sheet when metadata is associated with an entire sheet. */ - sheetId?: number; + sheetId?: number | null; /** * True when metadata is associated with an entire spreadsheet. */ - spreadsheet?: boolean; + spreadsheet?: boolean | null; } /** * Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified. @@ -1535,19 +1535,19 @@ export namespace sheets_v4 { /** * Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */ - locationMatchingStrategy?: string; + locationMatchingStrategy?: string | null; /** * Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */ - locationType?: string; + locationType?: string | null; /** * Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */ - metadataId?: number; + metadataId?: number | null; /** * Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */ - metadataKey?: string; + metadataKey?: string | null; /** * Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */ @@ -1555,11 +1555,11 @@ export namespace sheets_v4 { /** * Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */ - metadataValue?: string; + metadataValue?: string | null; /** * Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */ - visibility?: string; + visibility?: string | null; } /** * A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet. @@ -1568,11 +1568,11 @@ export namespace sheets_v4 { /** * This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false. */ - collapsed?: boolean; + collapsed?: boolean | null; /** * The depth of the group, representing how many groups have a range that wholly contains the range of this group. */ - depth?: number; + depth?: number | null; /** * The range over which this group exists. */ @@ -1589,15 +1589,15 @@ export namespace sheets_v4 { /** * True if this dimension is being filtered. This field is read-only. */ - hiddenByFilter?: boolean; + hiddenByFilter?: boolean | null; /** * True if this dimension is explicitly hidden. */ - hiddenByUser?: boolean; + hiddenByUser?: boolean | null; /** * The height (if a row) or width (if a column) of the dimension in pixels. */ - pixelSize?: number; + pixelSize?: number | null; } /** * A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side. @@ -1606,19 +1606,19 @@ export namespace sheets_v4 { /** * The dimension of the span. */ - dimension?: string; + dimension?: string | null; /** * The end (exclusive) of the span, or not set if unbounded. */ - endIndex?: number; + endIndex?: number | null; /** * The sheet this span is on. */ - sheetId?: number; + sheetId?: number | null; /** * The start (inclusive) of the span, or not set if unbounded. */ - startIndex?: number; + startIndex?: number | null; } /** * Duplicates a particular filter view. @@ -1627,7 +1627,7 @@ export namespace sheets_v4 { /** * The ID of the filter being duplicated. */ - filterId?: number; + filterId?: number | null; } /** * The result of a filter view being duplicated. @@ -1645,19 +1645,19 @@ export namespace sheets_v4 { /** * The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented. */ - insertSheetIndex?: number; + insertSheetIndex?: number | null; /** * If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative. */ - newSheetId?: number; + newSheetId?: number | null; /** * The name of the new sheet. If empty, a new name is chosen for you. */ - newSheetName?: string; + newSheetName?: string | null; /** * The sheet to duplicate. */ - sourceSheetId?: number; + sourceSheetId?: number | null; } /** * The result of duplicating a sheet. @@ -1675,15 +1675,15 @@ export namespace sheets_v4 { /** * True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain. */ - domainUsersCanEdit?: boolean; + domainUsersCanEdit?: boolean | null; /** * The email addresses of groups with edit access to the protected range. */ - groups?: string[]; + groups?: string[] | null; /** * The email addresses of users with edit access to the protected range. */ - users?: string[]; + users?: string[] | null; } /** * A chart embedded in a sheet. @@ -1692,7 +1692,7 @@ export namespace sheets_v4 { /** * The ID of the chart. */ - chartId?: number; + chartId?: number | null; /** * The position of the chart. */ @@ -1709,7 +1709,7 @@ export namespace sheets_v4 { /** * If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing. */ - newSheet?: boolean; + newSheet?: boolean | null; /** * The position at which the object is overlaid on top of a grid. */ @@ -1717,7 +1717,7 @@ export namespace sheets_v4 { /** * The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative. */ - sheetId?: number; + sheetId?: number | null; } /** * An error in a cell. @@ -1726,11 +1726,11 @@ export namespace sheets_v4 { /** * A message with more information about the error (in the spreadsheet's locale). */ - message?: string; + message?: string | null; /** * The type of error. */ - type?: string; + type?: string | null; } /** * The kinds of value that a cell in a spreadsheet can have. @@ -1739,7 +1739,7 @@ export namespace sheets_v4 { /** * Represents a boolean value. */ - boolValue?: boolean; + boolValue?: boolean | null; /** * Represents an error. This field is read-only. */ @@ -1747,15 +1747,15 @@ export namespace sheets_v4 { /** * Represents a formula. */ - formulaValue?: string; + formulaValue?: string | null; /** * Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in "serial number" format. */ - numberValue?: number; + numberValue?: number | null; /** * Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`. */ - stringValue?: string; + stringValue?: string | null; } /** * Criteria for showing/hiding rows in a filter or filter view. @@ -1768,7 +1768,7 @@ export namespace sheets_v4 { /** * Values that should be hidden. */ - hiddenValues?: string[]; + hiddenValues?: string[] | null; } /** * A filter view. @@ -1777,15 +1777,15 @@ export namespace sheets_v4 { /** * The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. */ - criteria?: {[key: string]: Schema$FilterCriteria}; + criteria?: {[key: string]: Schema$FilterCriteria} | null; /** * The ID of the filter view. */ - filterViewId?: number; + filterViewId?: number | null; /** * The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set. */ - namedRangeId?: string; + namedRangeId?: string | null; /** * The range this filter view covers. When writing, only one of range or named_range_id may be set. */ @@ -1797,7 +1797,7 @@ export namespace sheets_v4 { /** * The name of the filter view. */ - title?: string; + title?: string | null; } /** * Finds and replaces data in cells over a range, sheet, or all sheets. @@ -1806,23 +1806,23 @@ export namespace sheets_v4 { /** * True to find/replace over all sheets. */ - allSheets?: boolean; + allSheets?: boolean | null; /** * The value to search. */ - find?: string; + find?: string | null; /** * True if the search should include cells with formulas. False to skip cells with formulas. */ - includeFormulas?: boolean; + includeFormulas?: boolean | null; /** * True if the search is case sensitive. */ - matchCase?: boolean; + matchCase?: boolean | null; /** * True if the find value should match the entire cell. */ - matchEntireCell?: boolean; + matchEntireCell?: boolean | null; /** * The range to find/replace over. */ @@ -1830,15 +1830,15 @@ export namespace sheets_v4 { /** * The value to use as the replacement. */ - replacement?: string; + replacement?: string | null; /** * True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents `"Google Sheets"` and another has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of `"$1 Rocks"` would change the contents of the cells to `"GSheets Rocks"` and `"GDocs Rocks"` respectively. */ - searchByRegex?: boolean; + searchByRegex?: boolean | null; /** * The sheet to find/replace over. */ - sheetId?: number; + sheetId?: number | null; } /** * The result of the find/replace. @@ -1847,23 +1847,23 @@ export namespace sheets_v4 { /** * The number of formula cells changed. */ - formulasChanged?: number; + formulasChanged?: number | null; /** * The number of occurrences (possibly multiple within a cell) changed. For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`. */ - occurrencesChanged?: number; + occurrencesChanged?: number | null; /** * The number of rows changed. */ - rowsChanged?: number; + rowsChanged?: number | null; /** * The number of sheets changed. */ - sheetsChanged?: number; + sheetsChanged?: number | null; /** * The number of non-formula cells changed. */ - valuesChanged?: number; + valuesChanged?: number | null; } /** * The request for retrieving a Spreadsheet. @@ -1876,7 +1876,7 @@ export namespace sheets_v4 { /** * True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */ - includeGridData?: boolean; + includeGridData?: boolean | null; } /** * A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points. @@ -1902,15 +1902,15 @@ export namespace sheets_v4 { /** * The column index of the coordinate. */ - columnIndex?: number; + columnIndex?: number | null; /** * The row index of the coordinate. */ - rowIndex?: number; + rowIndex?: number | null; /** * The sheet this coordinate is on. */ - sheetId?: number; + sheetId?: number | null; } /** * Data in the grid, as well as metadata about the dimensions. @@ -1931,11 +1931,11 @@ export namespace sheets_v4 { /** * The first column this GridData refers to, zero-based. */ - startColumn?: number; + startColumn?: number | null; /** * The first row this GridData refers to, zero-based. */ - startRow?: number; + startRow?: number | null; } /** * Properties of a grid. @@ -1944,31 +1944,31 @@ export namespace sheets_v4 { /** * The number of columns in the grid. */ - columnCount?: number; + columnCount?: number | null; /** * True if the column grouping control toggle is shown after the group. */ - columnGroupControlAfter?: boolean; + columnGroupControlAfter?: boolean | null; /** * The number of columns that are frozen in the grid. */ - frozenColumnCount?: number; + frozenColumnCount?: number | null; /** * The number of rows that are frozen in the grid. */ - frozenRowCount?: number; + frozenRowCount?: number | null; /** * True if the grid isn't showing gridlines in the UI. */ - hideGridlines?: boolean; + hideGridlines?: boolean | null; /** * The number of rows in the grid. */ - rowCount?: number; + rowCount?: number | null; /** * True if the row grouping control toggle is shown after the group. */ - rowGroupControlAfter?: boolean; + rowGroupControlAfter?: boolean | null; } /** * A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`. @@ -1977,23 +1977,23 @@ export namespace sheets_v4 { /** * The end column (exclusive) of the range, or not set if unbounded. */ - endColumnIndex?: number; + endColumnIndex?: number | null; /** * The end row (exclusive) of the range, or not set if unbounded. */ - endRowIndex?: number; + endRowIndex?: number | null; /** * The sheet this range is on. */ - sheetId?: number; + sheetId?: number | null; /** * The start column (inclusive) of the range, or not set if unbounded. */ - startColumnIndex?: number; + startColumnIndex?: number | null; /** * The start row (inclusive) of the range, or not set if unbounded. */ - startRowIndex?: number; + startRowIndex?: number | null; } /** * A <a href="/chart/interactive/docs/gallery/histogram">histogram chart</a>. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly. @@ -2002,15 +2002,15 @@ export namespace sheets_v4 { /** * By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional. */ - bucketSize?: number; + bucketSize?: number | null; /** * The position of the chart legend. */ - legendPosition?: string; + legendPosition?: string | null; /** * The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5. */ - outlierPercentile?: number; + outlierPercentile?: number | null; /** * The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series. */ @@ -2018,7 +2018,7 @@ export namespace sheets_v4 { /** * Whether horizontal divider lines should be displayed between items in each column. */ - showItemDividers?: boolean; + showItemDividers?: boolean | null; } /** * Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+ @@ -2027,15 +2027,15 @@ export namespace sheets_v4 { /** * The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional. */ - end?: number; + end?: number | null; /** * The size of the buckets that are created. Must be positive. */ - interval?: number; + interval?: number | null; /** * The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional. */ - start?: number; + start?: number | null; } /** * A histogram series containing the series color and data. @@ -2057,7 +2057,7 @@ export namespace sheets_v4 { /** * Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green). */ - inheritFromBefore?: boolean; + inheritFromBefore?: boolean | null; /** * The dimensions to insert. Both the start and end indexes must be bounded. */ @@ -2074,7 +2074,7 @@ export namespace sheets_v4 { /** * The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right. */ - shiftDimension?: string; + shiftDimension?: string | null; } /** * A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen. @@ -2087,11 +2087,11 @@ export namespace sheets_v4 { /** * How the value should be interpreted. */ - type?: string; + type?: string | null; /** * The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX. */ - value?: string; + value?: string | null; } /** * Settings to control how circular dependencies are resolved with iterative calculation. @@ -2100,11 +2100,11 @@ export namespace sheets_v4 { /** * When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop. */ - convergenceThreshold?: number; + convergenceThreshold?: number | null; /** * When iterative calculation is enabled, the maximum number of calculation rounds to perform. */ - maxIterations?: number; + maxIterations?: number | null; } /** * Properties that describe the style of a line. @@ -2113,11 +2113,11 @@ export namespace sheets_v4 { /** * The dash type of the line. */ - type?: string; + type?: string | null; /** * The thickness of the line, in px. */ - width?: number; + width?: number | null; } /** * Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+ @@ -2174,7 +2174,7 @@ export namespace sheets_v4 { /** * How the cells should be merged. */ - mergeType?: string; + mergeType?: string | null; /** * The range of cells to merge. */ @@ -2187,7 +2187,7 @@ export namespace sheets_v4 { /** * The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move `"1"` and `"2"` to between `"3"` and `"4"`, the source would be `ROWS [1..3)`,and the destination index would be `"4"` (the zero-based index of row 5). The end result would be `A1..A5` of `0, 3, 1, 2, 4`. */ - destinationIndex?: number; + destinationIndex?: number | null; /** * The source dimensions to move. */ @@ -2200,11 +2200,11 @@ export namespace sheets_v4 { /** * The name of the named range. */ - name?: string; + name?: string | null; /** * The ID of the named range. */ - namedRangeId?: string; + namedRangeId?: string | null; /** * The range this represents. */ @@ -2217,11 +2217,11 @@ export namespace sheets_v4 { /** * Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the [Date and Number Formats guide](/sheets/api/guides/formats) for more information about the supported patterns. */ - pattern?: string; + pattern?: string | null; /** * The type of the number format. When writing, this field must be set. */ - type?: string; + type?: string | null; } /** * An <a href="/chart/interactive/docs/gallery/orgchart">org chart</a>. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain "Alice", "Bob", "Cathy", parent_labels contain "", "Alice", "Alice" and tooltips contain "CEO", "President", "VP Sales". @@ -2238,7 +2238,7 @@ export namespace sheets_v4 { /** * The size of the org chart nodes. */ - nodeSize?: string; + nodeSize?: string | null; /** * The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional. */ @@ -2263,19 +2263,19 @@ export namespace sheets_v4 { /** * The height of the object, in pixels. Defaults to 371. */ - heightPixels?: number; + heightPixels?: number | null; /** * The horizontal offset, in pixels, that the object is offset from the anchor cell. */ - offsetXPixels?: number; + offsetXPixels?: number | null; /** * The vertical offset, in pixels, that the object is offset from the anchor cell. */ - offsetYPixels?: number; + offsetYPixels?: number | null; /** * The width of the object, in pixels. Defaults to 600. */ - widthPixels?: number; + widthPixels?: number | null; } /** * The amount of padding around the cell, in pixels. When updating padding, every field must be specified. @@ -2284,19 +2284,19 @@ export namespace sheets_v4 { /** * The bottom padding of the cell. */ - bottom?: number; + bottom?: number | null; /** * The left padding of the cell. */ - left?: number; + left?: number | null; /** * The right padding of the cell. */ - right?: number; + right?: number | null; /** * The top padding of the cell. */ - top?: number; + top?: number | null; } /** * Inserts data into the spreadsheet starting at the specified coordinate. @@ -2309,19 +2309,19 @@ export namespace sheets_v4 { /** * The data to insert. */ - data?: string; + data?: string | null; /** * The delimiter in the data. */ - delimiter?: string; + delimiter?: string | null; /** * True if the data is HTML. */ - html?: boolean; + html?: boolean | null; /** * How the data should be pasted. */ - type?: string; + type?: string | null; } /** * A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. @@ -2334,11 +2334,11 @@ export namespace sheets_v4 { /** * Where the legend of the pie chart should be drawn. */ - legendPosition?: string; + legendPosition?: string | null; /** * The size of the hole in the pie chart. */ - pieHole?: number; + pieHole?: number | null; /** * The data that covers the one and only series of the pie chart. */ @@ -2346,7 +2346,7 @@ export namespace sheets_v4 { /** * True if the pie is three dimensional. */ - threeDimensional?: boolean; + threeDimensional?: boolean | null; } /** * Criteria for showing/hiding rows in a pivot table. @@ -2355,7 +2355,7 @@ export namespace sheets_v4 { /** * Values that should be included. Values not listed here are excluded. */ - visibleValues?: string[]; + visibleValues?: string[] | null; } /** * A single grouping (either row or column) in a pivot table. @@ -2368,23 +2368,23 @@ export namespace sheets_v4 { /** * The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables created before December 2017 do not have header labels. If you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then create a new pivot table with same parameters. +--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+ */ - label?: string; + label?: string | null; /** * True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repitition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to "Q1 Mar", "Q1" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause "Q1" to be repeated for "Feb" and "Mar". +--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+ */ - repeatHeadings?: boolean; + repeatHeadings?: boolean | null; /** * True if the pivot table should include the totals for this grouping. */ - showTotals?: boolean; + showTotals?: boolean | null; /** * The order the values in this group should be sorted. */ - sortOrder?: string; + sortOrder?: string | null; /** * The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`. */ - sourceColumnOffset?: number; + sourceColumnOffset?: number | null; /** * The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values. */ @@ -2422,7 +2422,7 @@ export namespace sheets_v4 { /** * The offset in the PivotTable.values list which the values in this grouping should be sorted by. */ - valuesIndex?: number; + valuesIndex?: number | null; } /** * Metadata about a value in a pivot grouping. @@ -2431,7 +2431,7 @@ export namespace sheets_v4 { /** * True if the data corresponding to the value is collapsed. */ - collapsed?: boolean; + collapsed?: boolean | null; /** * The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.) */ @@ -2448,7 +2448,7 @@ export namespace sheets_v4 { /** * An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. */ - criteria?: {[key: string]: Schema$PivotFilterCriteria}; + criteria?: {[key: string]: Schema$PivotFilterCriteria} | null; /** * Each row grouping in the pivot table. */ @@ -2460,7 +2460,7 @@ export namespace sheets_v4 { /** * Whether values should be listed horizontally (as columns) or vertically (as rows). */ - valueLayout?: string; + valueLayout?: string | null; /** * A list of values to include in the pivot table. */ @@ -2473,23 +2473,23 @@ export namespace sheets_v4 { /** * If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets UI, this is referred to as "Show As" in the value section of a pivot table. */ - calculatedDisplayType?: string; + calculatedDisplayType?: string | null; /** * A custom formula to calculate the value. The formula must start with an `=` character. */ - formula?: string; + formula?: string | null; /** * A name to use for the value. */ - name?: string; + name?: string | null; /** * The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`. */ - sourceColumnOffset?: number; + sourceColumnOffset?: number | null; /** * A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported. */ - summarizeFunction?: string; + summarizeFunction?: string | null; } /** * A protected range. @@ -2498,7 +2498,7 @@ export namespace sheets_v4 { /** * The description of this protected range. */ - description?: string; + description?: string | null; /** * The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection. */ @@ -2506,11 +2506,11 @@ export namespace sheets_v4 { /** * The named range this protected range is backed by, if any. When writing, only one of range or named_range_id may be set. */ - namedRangeId?: string; + namedRangeId?: string | null; /** * The ID of the protected range. This field is read-only. */ - protectedRangeId?: number; + protectedRangeId?: number | null; /** * The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id may be set. */ @@ -2518,7 +2518,7 @@ export namespace sheets_v4 { /** * True if the user who requested this protected range can edit the protected area. This field is read-only. */ - requestingUserCanEdit?: boolean; + requestingUserCanEdit?: boolean | null; /** * The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets. */ @@ -2526,7 +2526,7 @@ export namespace sheets_v4 { /** * True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors is ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document. */ - warningOnly?: boolean; + warningOnly?: boolean | null; } /** * Randomizes the order of the rows in a range. @@ -2548,7 +2548,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `cell` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The range to repeat the cell in. */ @@ -2985,23 +2985,23 @@ export namespace sheets_v4 { /** * True if the sheet is hidden in the UI, false if it's visible. */ - hidden?: boolean; + hidden?: boolean | null; /** * The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1. */ - index?: number; + index?: number | null; /** * True if the sheet is an RTL sheet instead of an LTR sheet. */ - rightToLeft?: boolean; + rightToLeft?: boolean | null; /** * The ID of the sheet. Must be non-negative. This field cannot be changed once set. */ - sheetId?: number; + sheetId?: number | null; /** * The type of sheet. Defaults to GRID. This field cannot be changed once set. */ - sheetType?: string; + sheetType?: string | null; /** * The color of the tab in the UI. */ @@ -3009,7 +3009,7 @@ export namespace sheets_v4 { /** * The name of the sheet. */ - title?: string; + title?: string | null; } /** * Sorts data in rows based on a sort order per column. @@ -3031,11 +3031,11 @@ export namespace sheets_v4 { /** * The dimension the sort should be applied to. */ - dimensionIndex?: number; + dimensionIndex?: number | null; /** * The order data should be sorted. */ - sortOrder?: string; + sortOrder?: string | null; } /** * A combination of a source range and how to extend that source. @@ -3044,11 +3044,11 @@ export namespace sheets_v4 { /** * The dimension that data should be filled into. */ - dimension?: string; + dimension?: string | null; /** * The number of rows or columns that data should be filled into. Positive numbers expand beyond the last row or last column of the source. Negative numbers expand before the first row or first column of the source. */ - fillLength?: number; + fillLength?: number | null; /** * The location of the data to use as the source of the autofill. */ @@ -3077,11 +3077,11 @@ export namespace sheets_v4 { /** * The ID of the spreadsheet. This field is read-only. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The url of the spreadsheet. This field is read-only. */ - spreadsheetUrl?: string; + spreadsheetUrl?: string | null; } /** * Properties of a spreadsheet. @@ -3090,7 +3090,7 @@ export namespace sheets_v4 { /** * The amount of time to wait before volatile functions are recalculated. */ - autoRecalc?: string; + autoRecalc?: string | null; /** * The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only. */ @@ -3102,15 +3102,15 @@ 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; + locale?: string | null; /** * 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`. */ - timeZone?: string; + timeZone?: string | null; /** * The title of the spreadsheet. */ - title?: string; + title?: string | null; } /** * The format of a run of text in a cell. Absent values indicate that the field isn't specified. @@ -3119,15 +3119,15 @@ export namespace sheets_v4 { /** * True if the text is bold. */ - bold?: boolean; + bold?: boolean | null; /** * The font family. */ - fontFamily?: string; + fontFamily?: string | null; /** * The size of the font. */ - fontSize?: number; + fontSize?: number | null; /** * The foreground color of the text. */ @@ -3135,15 +3135,15 @@ export namespace sheets_v4 { /** * True if the text is italicized. */ - italic?: boolean; + italic?: boolean | null; /** * True if the text has a strikethrough. */ - strikethrough?: boolean; + strikethrough?: boolean | null; /** * True if the text is underlined. */ - underline?: boolean; + underline?: boolean | null; } /** * A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set. @@ -3156,7 +3156,7 @@ export namespace sheets_v4 { /** * The character index where this run starts. */ - startIndex?: number; + startIndex?: number | null; } /** * Position settings for text. @@ -3165,7 +3165,7 @@ export namespace sheets_v4 { /** * Horizontal alignment setting for the piece of text. */ - horizontalAlignment?: string; + horizontalAlignment?: string | null; } /** * The rotation applied to text in a cell. @@ -3174,11 +3174,11 @@ export namespace sheets_v4 { /** * The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counterclockwise direction, whereas for RTL they are in the clockwise direction */ - angle?: number; + angle?: number | null; /** * If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: | V | | e | | r | | t | | i | | c | | a | | l | */ - vertical?: boolean; + vertical?: boolean | null; } /** * Splits a column of text into multiple columns, based on a delimiter in each cell. @@ -3187,11 +3187,11 @@ export namespace sheets_v4 { /** * The delimiter to use. Used only if delimiterType is CUSTOM. */ - delimiter?: string; + delimiter?: string | null; /** * The delimiter type to use. */ - delimiterType?: string; + delimiterType?: string | null; /** * The source data range. This must span exactly one column. */ @@ -3237,11 +3237,11 @@ export namespace sheets_v4 { /** * True to hide tooltips. */ - hideTooltips?: boolean; + hideTooltips?: boolean | null; /** * The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified. */ - hintedLevels?: number; + hintedLevels?: number | null; /** * The data that contains the treemap cell labels. */ @@ -3249,15 +3249,15 @@ export namespace sheets_v4 { /** * The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified. */ - levels?: number; + levels?: number | null; /** * The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified. */ - maxValue?: number; + maxValue?: number | null; /** * The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified. */ - minValue?: number; + minValue?: number | null; /** * The data the contains the treemap cells' parent labels. */ @@ -3287,7 +3287,7 @@ export namespace sheets_v4 { /** * The number of cells that were trimmed of whitespace. */ - cellsChangedCount?: number; + cellsChangedCount?: number | null; } /** * Unmerges cells in the given range. @@ -3309,7 +3309,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `bandedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; } /** * Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a border, explicitly set the style to NONE. @@ -3351,7 +3351,7 @@ export namespace sheets_v4 { /** * The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The range to write data to. If the data in rows does not cover the entire requested range, the fields matching those set in fields will be cleared. */ @@ -3372,7 +3372,7 @@ export namespace sheets_v4 { /** * The ID of the chart to update. */ - chartId?: number; + chartId?: number | null; /** * The specification to apply to the chart. */ @@ -3385,11 +3385,11 @@ export namespace sheets_v4 { /** * The zero-based index of the rule that should be replaced or moved. */ - index?: number; + index?: number | null; /** * The zero-based new index the rule should end up at. */ - newIndex?: number; + newIndex?: number | null; /** * The rule that should replace the rule at the given index. */ @@ -3397,7 +3397,7 @@ export namespace sheets_v4 { /** * The sheet of the rule to move. Required if new_index is set, unused otherwise. */ - sheetId?: number; + sheetId?: number | null; } /** * The result of updating a conditional format rule. @@ -3406,7 +3406,7 @@ export namespace sheets_v4 { /** * The index of the new rule. */ - newIndex?: number; + newIndex?: number | null; /** * The new rule that replaced the old rule (if replacing), or the rule that was moved (if moved) */ @@ -3414,7 +3414,7 @@ export namespace sheets_v4 { /** * The old index of the rule. Not set if a rule was replaced (because it is the same as new_index). */ - oldIndex?: number; + oldIndex?: number | null; /** * The old (deleted) rule. Not set if a rule was moved (because it is the same as new_rule). */ @@ -3435,7 +3435,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `developerMetadata` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; } /** * The response from updating developer metadata. @@ -3457,7 +3457,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `dimensionGroup` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; } /** * Updates properties of dimensions within the specified range. @@ -3466,7 +3466,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * Properties to update. */ @@ -3483,7 +3483,7 @@ export namespace sheets_v4 { /** * The fields of OverlayPosition that should be updated when setting a new position. Used only if newPosition.overlayPosition is set, in which case at least one field must be specified. The root `newPosition.overlayPosition` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * An explicit position to move the embedded object to. If newPosition.sheetId is set, a new sheet with that ID will be created. If newPosition.newSheet is set to true, a new sheet will be created with an ID that will be chosen for you. */ @@ -3491,7 +3491,7 @@ export namespace sheets_v4 { /** * The ID of the object to moved. */ - objectId?: number; + objectId?: number | null; } /** * The result of updating an embedded object's position. @@ -3509,7 +3509,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `filter` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The new properties of the filter view. */ @@ -3522,7 +3522,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `namedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The named range to update with the new properties. */ @@ -3535,7 +3535,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `protectedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The protected range to update with the new properties. */ @@ -3548,7 +3548,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The properties to update. */ @@ -3561,7 +3561,7 @@ export namespace sheets_v4 { /** * The fields that should be updated. At least one field must be specified. The root 'properties' is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ - fields?: string; + fields?: string | null; /** * The properties to update. */ @@ -3578,11 +3578,11 @@ export namespace sheets_v4 { /** * The number of cells updated. */ - updatedCells?: number; + updatedCells?: number | null; /** * The number of columns where at least one cell in the column was updated. */ - updatedColumns?: number; + updatedColumns?: number | null; /** * The values of the cells in the range matched by the dataFilter after all updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */ @@ -3590,11 +3590,11 @@ export namespace sheets_v4 { /** * The range (in A1 notation) that updates were applied to. */ - updatedRange?: string; + updatedRange?: string | null; /** * The number of rows where at least one cell in the row was updated. */ - updatedRows?: number; + updatedRows?: number | null; } /** * The response when updating a range of values in a spreadsheet. @@ -3603,15 +3603,15 @@ export namespace sheets_v4 { /** * The spreadsheet the updates were applied to. */ - spreadsheetId?: string; + spreadsheetId?: string | null; /** * The number of cells updated. */ - updatedCells?: number; + updatedCells?: number | null; /** * The number of columns where at least one cell in the column was updated. */ - updatedColumns?: number; + updatedColumns?: number | null; /** * The values of the cells after updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */ @@ -3619,11 +3619,11 @@ export namespace sheets_v4 { /** * The range (in A1 notation) that updates were applied to. */ - updatedRange?: string; + updatedRange?: string | null; /** * The number of rows where at least one cell in the row was updated. */ - updatedRows?: number; + updatedRows?: number | null; } /** * Data within a range of the spreadsheet. @@ -3632,15 +3632,15 @@ export namespace sheets_v4 { /** * The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */ - majorDimension?: string; + majorDimension?: string | null; /** * The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */ - range?: string; + range?: string | null; /** * The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */ - values?: any[][]; + values?: any[][] | null; } /** * Styles for a waterfall chart column. @@ -3653,7 +3653,7 @@ export namespace sheets_v4 { /** * The label of the column's legend. */ - label?: string; + label?: string | null; } /** * A custom subtotal column for a waterfall chart series. @@ -3662,15 +3662,15 @@ export namespace sheets_v4 { /** * True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point. */ - dataIsSubtotal?: boolean; + dataIsSubtotal?: boolean | null; /** * A label for the subtotal column. */ - label?: string; + label?: string | null; /** * The 0-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has three data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with. */ - subtotalIndex?: number; + subtotalIndex?: number | null; } /** * The domain of a waterfall chart. @@ -3683,7 +3683,7 @@ export namespace sheets_v4 { /** * True to reverse the order of the domain values (horizontal axis). */ - reversed?: boolean; + reversed?: boolean | null; } /** * A single series of data for a waterfall chart. @@ -3700,7 +3700,7 @@ export namespace sheets_v4 { /** * True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series. */ - hideTrailingSubtotal?: boolean; + hideTrailingSubtotal?: boolean | null; /** * Styles for all columns in this series with negative values. */ @@ -3729,11 +3729,11 @@ export namespace sheets_v4 { /** * True to interpret the first value as a total. */ - firstValueIsTotal?: boolean; + firstValueIsTotal?: boolean | null; /** * True to hide connector lines between columns. */ - hideConnectorLines?: boolean; + hideConnectorLines?: boolean | null; /** * The data this waterfall chart is visualizing. */ @@ -3741,7 +3741,7 @@ export namespace sheets_v4 { /** * The stacked type. */ - stackedType?: string; + stackedType?: string | null; } export class Resource$Spreadsheets { diff --git a/src/apis/siteVerification/v1.ts b/src/apis/siteVerification/v1.ts index 713ecf5537b..c7f44128cf5 100644 --- a/src/apis/siteVerification/v1.ts +++ b/src/apis/siteVerification/v1.ts @@ -105,21 +105,21 @@ export namespace siteVerification_v1 { /** * The site for which a verification token will be generated. */ - site?: {identifier?: string; type?: string}; + site?: {identifier?: string; type?: string} | null; /** * The verification method that will be used to verify this site. For sites, 'FILE' or 'META' methods may be used. For domains, only 'DNS' may be used. */ - verificationMethod?: string; + verificationMethod?: string | null; } export interface Schema$SiteVerificationWebResourceGettokenResponse { /** * The verification method to use in conjunction with this token. For FILE, the token should be placed in the top-level directory of the site, stored inside a file of the same name. For META, the token should be placed in the HEAD tag of the default page that is loaded for the site. For DNS, the token should be placed in a TXT record of the domain. */ - method?: string; + method?: string | null; /** * The verification token. The token must be placed appropriately in order for verification to succeed. */ - token?: string; + token?: string | null; } export interface Schema$SiteVerificationWebResourceListResponse { /** @@ -131,15 +131,15 @@ export namespace siteVerification_v1 { /** * The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations. */ - id?: string; + id?: string | null; /** * The email addresses of all verified owners. */ - owners?: string[]; + owners?: string[] | null; /** * The address and type of a site that is verified or will be verified. */ - site?: {identifier?: string; type?: string}; + site?: {identifier?: string; type?: string} | null; } export class Resource$Webresource { diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index f5c2906720e..f2ef1da1c5c 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -124,31 +124,31 @@ export namespace slides_v1 { /** * The X coordinate scaling element. */ - scaleX?: number; + scaleX?: number | null; /** * The Y coordinate scaling element. */ - scaleY?: number; + scaleY?: number | null; /** * The X coordinate shearing element. */ - shearX?: number; + shearX?: number | null; /** * The Y coordinate shearing element. */ - shearY?: number; + shearY?: number | null; /** * The X coordinate translation element. */ - translateX?: number; + translateX?: number | null; /** * The Y coordinate translation element. */ - translateY?: number; + translateY?: number | null; /** * The units for translate elements. */ - unit?: string; + unit?: string | null; } /** * A TextElement kind that represents auto text. @@ -157,7 +157,7 @@ export namespace slides_v1 { /** * The rendered content of this auto text, if available. */ - content?: string; + content?: string | null; /** * The styling applied to this auto text. */ @@ -165,7 +165,7 @@ export namespace slides_v1 { /** * The type of this auto text. */ - type?: string; + type?: string | null; } /** * Request message for PresentationsService.BatchUpdatePresentation. @@ -187,7 +187,7 @@ export namespace slides_v1 { /** * The presentation the updates were applied to. */ - presentationId?: string; + presentationId?: string | null; /** * The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */ @@ -208,15 +208,15 @@ export namespace slides_v1 { /** * The rendered bullet glyph for this paragraph. */ - glyph?: string; + glyph?: string | null; /** * The ID of the list this paragraph belongs to. */ - listId?: string; + listId?: string | null; /** * The nesting level of this paragraph in the list. */ - nestingLevel?: number; + nestingLevel?: number | null; } /** * The palette of predefined colors for a page. @@ -234,7 +234,7 @@ export namespace slides_v1 { /** * The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. */ - alpha?: number; + alpha?: number | null; /** * The color of the gradient stop. */ @@ -242,7 +242,7 @@ export namespace slides_v1 { /** * The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. */ - position?: number; + position?: number | null; } /** * Creates an image. @@ -255,11 +255,11 @@ export namespace slides_v1 { /** * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ - objectId?: string; + objectId?: string | null; /** * The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field. */ - url?: string; + url?: string | null; } /** * The result of creating an image. @@ -268,7 +268,7 @@ export namespace slides_v1 { /** * The object ID of the created image. */ - objectId?: string; + objectId?: string | null; } /** * Creates a line. @@ -277,7 +277,7 @@ export namespace slides_v1 { /** * The category of the line to be created. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence. If you do not specify a value for `category`, but specify a value for `line_category`, then the specified `line_category` value is used. If you do not specify either, then STRAIGHT is used. */ - category?: string; + category?: string | null; /** * The element properties for the line. */ @@ -285,11 +285,11 @@ export namespace slides_v1 { /** * The category of the line to be created. <b>Deprecated</b>: use `category` instead. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence. */ - lineCategory?: string; + lineCategory?: string | null; /** * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ - objectId?: string; + objectId?: string | null; } /** * The result of creating a line. @@ -298,7 +298,7 @@ export namespace slides_v1 { /** * The object ID of the created line. */ - objectId?: string; + objectId?: string | null; } /** * Creates bullets for all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. @@ -307,7 +307,7 @@ export namespace slides_v1 { /** * The kinds of bullet glyphs to be used. Defaults to the `BULLET_DISC_CIRCLE_SQUARE` preset. */ - bulletPreset?: string; + bulletPreset?: string | null; /** * The optional table cell location if the text to be modified is in a table cell. If present, the object_id must refer to a table. */ @@ -315,7 +315,7 @@ export namespace slides_v1 { /** * The object ID of the shape or table containing the text to add bullets to. */ - objectId?: string; + objectId?: string | null; /** * The range of text to apply the bullet presets to, based on TextElement indexes. */ @@ -332,11 +332,11 @@ export namespace slides_v1 { /** * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If empty, a unique identifier will be generated. */ - objectId?: string; + objectId?: string | null; /** * The shape type. */ - shapeType?: string; + shapeType?: string | null; } /** * The result of creating a shape. @@ -345,7 +345,7 @@ export namespace slides_v1 { /** * The object ID of the created shape. */ - objectId?: string; + objectId?: string | null; } /** * Creates an embedded Google Sheets chart. NOTE: Chart creation requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive.file, or drive OAuth scopes. @@ -354,7 +354,7 @@ export namespace slides_v1 { /** * The ID of the specific chart in the Google Sheets spreadsheet. */ - chartId?: number; + chartId?: number | null; /** * The element properties for the chart. When the aspect ratio of the provided size does not match the chart aspect ratio, the chart is scaled and centered with respect to the size in order to maintain aspect ratio. The provided transform is applied after this operation. */ @@ -362,15 +362,15 @@ export namespace slides_v1 { /** * The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked. */ - linkingMode?: string; + linkingMode?: string | null; /** * A user-supplied object ID. If specified, the ID must be unique among all pages and page elements in the presentation. The ID should start with a word character [a-zA-Z0-9_] and then followed by any number of the following characters [a-zA-Z0-9_-:]. The length of the ID should not be less than 5 or greater than 50. If empty, a unique identifier will be generated. */ - objectId?: string; + objectId?: string | null; /** * The ID of the Google Sheets spreadsheet that contains the chart. */ - spreadsheetId?: string; + spreadsheetId?: string | null; } /** * The result of creating an embedded Google Sheets chart. @@ -379,7 +379,7 @@ export namespace slides_v1 { /** * The object ID of the created chart. */ - objectId?: string; + objectId?: string | null; } /** * Creates a new slide. @@ -388,11 +388,11 @@ export namespace slides_v1 { /** * The optional zero-based index indicating where to insert the slides. If you don't specify an index, the new slide is created at the end. */ - insertionIndex?: number; + insertionIndex?: number | null; /** * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ - objectId?: string; + objectId?: string | null; /** * An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s) that will be created on the new slide from that specified layout. Can only be used when `slide_layout_reference` is specified. */ @@ -409,7 +409,7 @@ export namespace slides_v1 { /** * The object ID of the created slide. */ - objectId?: string; + objectId?: string | null; } /** * Creates a new table. @@ -418,7 +418,7 @@ export namespace slides_v1 { /** * Number of columns in the table. */ - columns?: number; + columns?: number | null; /** * The element properties for the table. The table will be created at the provided size, subject to a minimum size. If no size is provided, the table will be automatically sized. Table transforms must have a scale of 1 and no shear components. If no transform is provided, the table will be centered on the page. */ @@ -426,11 +426,11 @@ export namespace slides_v1 { /** * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ - objectId?: string; + objectId?: string | null; /** * Number of rows in the table. */ - rows?: number; + rows?: number | null; } /** * The result of creating a table. @@ -439,7 +439,7 @@ export namespace slides_v1 { /** * The object ID of the created table. */ - objectId?: string; + objectId?: string | null; } /** * Creates a video. NOTE: Creating a video from Google Drive requires that the requesting app have at least one of the drive, drive.readonly, or drive.file OAuth scopes. @@ -452,15 +452,15 @@ export namespace slides_v1 { /** * The video source's unique identifier for this video. e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is 7U3axjORYZ0. For a Google Drive video https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. */ - id?: string; + id?: string | null; /** * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ - objectId?: string; + objectId?: string | null; /** * The video source. */ - source?: string; + source?: string | null; } /** * The result of creating a video. @@ -469,7 +469,7 @@ export namespace slides_v1 { /** * The object ID of the created video. */ - objectId?: string; + objectId?: string | null; } /** * The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. @@ -478,23 +478,23 @@ export namespace slides_v1 { /** * The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. */ - angle?: number; + angle?: number | null; /** * The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. */ - bottomOffset?: number; + bottomOffset?: number | null; /** * The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. */ - leftOffset?: number; + leftOffset?: number | null; /** * The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. */ - rightOffset?: number; + rightOffset?: number | null; /** * The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. */ - topOffset?: number; + topOffset?: number | null; } /** * Deletes an object, either pages or page elements, from the presentation. @@ -503,7 +503,7 @@ export namespace slides_v1 { /** * The object ID of the page or page element to delete. If after a delete operation a group contains only 1 or no page elements, the group is also deleted. If a placeholder is deleted on a layout, any empty inheriting shapes are also deleted. */ - objectId?: string; + objectId?: string | null; } /** * Deletes bullets from all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. @@ -516,7 +516,7 @@ export namespace slides_v1 { /** * The object ID of the shape or table containing the text to delete bullets from. */ - objectId?: string; + objectId?: string | null; /** * The range of text to delete bullets from, based on TextElement indexes. */ @@ -533,7 +533,7 @@ export namespace slides_v1 { /** * The table to delete columns from. */ - tableObjectId?: string; + tableObjectId?: string | null; } /** * Deletes a row from a table. @@ -546,7 +546,7 @@ export namespace slides_v1 { /** * The table to delete rows from. */ - tableObjectId?: string; + tableObjectId?: string | null; } /** * Deletes text from a shape or a table cell. @@ -559,7 +559,7 @@ export namespace slides_v1 { /** * The object ID of the shape or table from which the text will be deleted. */ - objectId?: string; + objectId?: string | null; /** * The range of text to delete, based on TextElement indexes. There is always an implicit newline character at the end of a shape's or table cell's text that cannot be deleted. `Range.Type.ALL` will use the correct bounds, but care must be taken when specifying explicit bounds for range types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text is "ABC", followed by an implicit newline, then the maximum value is 2 for `text_range.start_index` and 3 for `text_range.end_index`. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles and lists as the two paragraphs are merged. Ranges that include only one code unit of a surrogate pair are expanded to include both code units. */ @@ -572,11 +572,11 @@ export namespace slides_v1 { /** * The magnitude. */ - magnitude?: number; + magnitude?: number | null; /** * The units for magnitude. */ - unit?: string; + unit?: string | null; } /** * Duplicates a slide or page element. When duplicating a slide, the duplicate slide will be created immediately following the specified slide. When duplicating a page element, the duplicate will be placed on the same page at the same position as the original. @@ -585,11 +585,11 @@ export namespace slides_v1 { /** * The ID of the object to duplicate. */ - objectId?: string; + objectId?: string | null; /** * The object being duplicated may contain other objects, for example when duplicating a slide or a group page element. This map defines how the IDs of duplicated objects are generated: the keys are the IDs of the original objects and its values are the IDs that will be assigned to the corresponding duplicate object. The ID of the source object's duplicate may be specified in this map as well, using the same value of the `object_id` field as a key and the newly desired ID as the value. All keys must correspond to existing IDs in the presentation. All values must be unique in the presentation and must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or greater than 50. If any IDs of source objects are omitted from the map, a new random ID will be assigned. If the map is empty or unset, all duplicate objects will receive a new random ID. */ - objectIds?: {[key: string]: string}; + objectIds?: {[key: string]: string} | null; } /** * The response of duplicating an object. @@ -598,7 +598,7 @@ export namespace slides_v1 { /** * The ID of the new duplicate object. */ - objectId?: string; + objectId?: string | null; } /** * A PageElement kind representing a joined collection of PageElements. @@ -616,11 +616,11 @@ export namespace slides_v1 { /** * The object IDs of the objects to group. Only page elements can be grouped. There should be at least two page elements on the same page that are not already in another group. Some page elements, such as videos, tables and placeholder shapes cannot be grouped. */ - childrenObjectIds?: string[]; + childrenObjectIds?: string[] | null; /** * A user-supplied object ID for the group to be created. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ - groupObjectId?: string; + groupObjectId?: string | null; } /** * The result of grouping objects. @@ -629,7 +629,7 @@ export namespace slides_v1 { /** * The object ID of the created group. */ - objectId?: string; + objectId?: string | null; } /** * A PageElement kind representing an image. @@ -638,7 +638,7 @@ export namespace slides_v1 { /** * An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. */ - contentUrl?: string; + contentUrl?: string | null; /** * The properties of the image. */ @@ -646,7 +646,7 @@ export namespace slides_v1 { /** * The source URL is the URL used to insert the image. The source URL can be empty. */ - sourceUrl?: string; + sourceUrl?: string | null; } /** * The properties of the Image. @@ -655,11 +655,11 @@ export namespace slides_v1 { /** * The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. */ - brightness?: number; + brightness?: number | null; /** * The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. */ - contrast?: number; + contrast?: number | null; /** * The crop properties of the image. If not set, the image is not cropped. This property is read-only. */ @@ -683,7 +683,7 @@ export namespace slides_v1 { /** * The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. */ - transparency?: number; + transparency?: number | null; } /** * Inserts columns into a table. Other columns in the table will be resized to fit the new column. @@ -696,15 +696,15 @@ export namespace slides_v1 { /** * Whether to insert new columns to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left. */ - insertRight?: boolean; + insertRight?: boolean | null; /** * The number of columns to be inserted. Maximum 20 per request. */ - number?: number; + number?: number | null; /** * The table to insert columns into. */ - tableObjectId?: string; + tableObjectId?: string | null; } /** * Inserts rows into a table. @@ -717,15 +717,15 @@ export namespace slides_v1 { /** * Whether to insert new rows below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell. */ - insertBelow?: boolean; + insertBelow?: boolean | null; /** * The number of rows to be inserted. Maximum 20 per request. */ - number?: number; + number?: number | null; /** * The table to insert rows into. */ - tableObjectId?: string; + tableObjectId?: string | null; } /** * Inserts text into a shape or a table cell. @@ -738,15 +738,15 @@ export namespace slides_v1 { /** * The index where the text will be inserted, in Unicode code units, based on TextElement indexes. The index is zero-based and is computed from the start of the string. The index may be adjusted to prevent insertions inside Unicode grapheme clusters. In these cases, the text will be inserted immediately after the grapheme cluster. */ - insertionIndex?: number; + insertionIndex?: number | null; /** * The object ID of the shape or table where the text will be inserted. */ - objectId?: string; + objectId?: string | null; /** * The text to be inserted. Inserting a newline character will implicitly create a new ParagraphMarker at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text will be added to the TextRun that exists at the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. */ - text?: string; + text?: string | null; } /** * The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout. @@ -759,11 +759,11 @@ export namespace slides_v1 { /** * The object ID of the placeholder on a layout that will be applied to a slide. */ - layoutPlaceholderObjectId?: string; + layoutPlaceholderObjectId?: string | null; /** * A user-supplied object ID for the placeholder identified above that to be created onto a slide. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ - objectId?: string; + objectId?: string | null; } /** * The properties of Page are only relevant for pages with page_type LAYOUT. @@ -772,15 +772,15 @@ export namespace slides_v1 { /** * The human-readable name of the layout. */ - displayName?: string; + displayName?: string | null; /** * The object ID of the master that this layout is based on. */ - masterObjectId?: string; + masterObjectId?: string | null; /** * The name of the layout. */ - name?: string; + name?: string | null; } /** * Slide layout reference. This may reference either: - A predefined layout - One of the layouts in the presentation. @@ -789,11 +789,11 @@ export namespace slides_v1 { /** * Layout ID: the object ID of one of the layouts in the presentation. */ - layoutId?: string; + layoutId?: string | null; /** * Predefined layout. */ - predefinedLayout?: string; + predefinedLayout?: string | null; } /** * A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector. @@ -802,7 +802,7 @@ export namespace slides_v1 { /** * The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest. */ - lineCategory?: string; + lineCategory?: string | null; /** * The properties of the line. */ @@ -810,7 +810,7 @@ export namespace slides_v1 { /** * The type of the line. */ - lineType?: string; + lineType?: string | null; } /** * The properties for one end of a Line connection. @@ -819,11 +819,11 @@ export namespace slides_v1 { /** * The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. */ - connectedObjectId?: string; + connectedObjectId?: string | null; /** * The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. */ - connectionSiteIndex?: number; + connectionSiteIndex?: number | null; } /** * The fill of the line. @@ -841,11 +841,11 @@ export namespace slides_v1 { /** * The dash style of the line. */ - dashStyle?: string; + dashStyle?: string | null; /** * The style of the arrow at the end of the line. */ - endArrow?: string; + endArrow?: string | null; /** * The connection at the end of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have an `end_connection`. */ @@ -861,7 +861,7 @@ export namespace slides_v1 { /** * The style of the arrow at the beginning of the line. */ - startArrow?: string; + startArrow?: string | null; /** * The connection at the beginning of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have a `start_connection`. */ @@ -878,19 +878,19 @@ export namespace slides_v1 { /** * If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. */ - pageObjectId?: string; + pageObjectId?: string | null; /** * If set, indicates this is a link to a slide in this presentation, addressed by its position. */ - relativeLink?: string; + relativeLink?: string | null; /** * If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. */ - slideIndex?: number; + slideIndex?: number | null; /** * If set, indicates this is a link to the external web page at this URL. */ - url?: string; + url?: string | null; } /** * A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. @@ -899,11 +899,11 @@ export namespace slides_v1 { /** * The ID of the list. */ - listId?: string; + listId?: string | null; /** * A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. */ - nestingLevel?: {[key: string]: Schema$NestingLevel}; + nestingLevel?: {[key: string]: Schema$NestingLevel} | null; } /** * The properties of Page that are only relevant for pages with page_type MASTER. @@ -912,7 +912,7 @@ export namespace slides_v1 { /** * The human-readable name of the master. */ - displayName?: string; + displayName?: string | null; } /** * Merges cells in a Table. @@ -921,7 +921,7 @@ export namespace slides_v1 { /** * The object ID of the table. */ - objectId?: string; + objectId?: string | null; /** * The table range specifying which cells of the table to merge. Any text in the cells being merged will be concatenated and stored in the upper-left ("head") cell of the range. If the range is non-rectangular (which can occur in some cases where the range covers cells that are already merged), a 400 bad request error is returned. */ @@ -943,7 +943,7 @@ export namespace slides_v1 { /** * The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID. */ - speakerNotesObjectId?: string; + speakerNotesObjectId?: string | null; } /** * A themeable solid color value. @@ -956,7 +956,7 @@ export namespace slides_v1 { /** * An opaque theme color. */ - themeColor?: string; + themeColor?: string | null; } /** * A color that can either be fully opaque or fully transparent. @@ -974,7 +974,7 @@ export namespace slides_v1 { /** * The dash style of the outline. */ - dashStyle?: string; + dashStyle?: string | null; /** * The fill of the outline. */ @@ -982,7 +982,7 @@ export namespace slides_v1 { /** * The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. */ - propertyState?: string; + propertyState?: string | null; /** * The thickness of the outline. */ @@ -1016,7 +1016,7 @@ export namespace slides_v1 { /** * The object ID for this page. Object IDs used by Page and PageElement share the same namespace. */ - objectId?: string; + objectId?: string | null; /** * The page elements rendered on the page. */ @@ -1028,11 +1028,11 @@ export namespace slides_v1 { /** * The type of the page. */ - pageType?: string; + pageType?: string | null; /** * The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */ - revisionId?: string; + revisionId?: string | null; /** * Slide specific properties. Only set if page_type = SLIDE. */ @@ -1045,7 +1045,7 @@ export namespace slides_v1 { /** * The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. */ - propertyState?: string; + propertyState?: string | null; /** * Solid color fill. */ @@ -1062,7 +1062,7 @@ export namespace slides_v1 { /** * The description of the page element. Combined with title to display alt text. */ - description?: string; + description?: string | null; /** * A collection of page elements joined as a single unit. */ @@ -1078,7 +1078,7 @@ export namespace slides_v1 { /** * The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace. */ - objectId?: string; + objectId?: string | null; /** * A generic shape. */ @@ -1098,7 +1098,7 @@ export namespace slides_v1 { /** * The title of the page element. Combined with description to display alt text. */ - title?: string; + title?: string | null; /** * The transform of the page element. The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field. The initial transform for the newly created Group is always the identity transform. */ @@ -1119,7 +1119,7 @@ export namespace slides_v1 { /** * The object ID of the page where the element is located. */ - pageObjectId?: string; + pageObjectId?: string | null; /** * The size of the element. */ @@ -1162,11 +1162,11 @@ export namespace slides_v1 { /** * The text alignment for this paragraph. */ - alignment?: string; + alignment?: string | null; /** * The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. */ - direction?: string; + direction?: string | null; /** * The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. */ @@ -1182,7 +1182,7 @@ export namespace slides_v1 { /** * The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. */ - lineSpacing?: number; + lineSpacing?: number | null; /** * The amount of extra space above the paragraph. If unset, the value is inherited from the parent. */ @@ -1194,7 +1194,7 @@ export namespace slides_v1 { /** * The spacing mode for the paragraph. */ - spacingMode?: string; + spacingMode?: string | null; } /** * The placeholder information that uniquely identifies a placeholder shape. @@ -1203,15 +1203,15 @@ export namespace slides_v1 { /** * The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. */ - index?: number; + index?: number | null; /** * The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. */ - parentObjectId?: string; + parentObjectId?: string | null; /** * The type of the placeholder. */ - type?: string; + type?: string | null; } /** * A Google Slides presentation. @@ -1224,7 +1224,7 @@ export namespace slides_v1 { /** * The locale of the presentation, as an IETF BCP 47 language tag. */ - locale?: string; + locale?: string | null; /** * The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts. They serve three purposes: - Placeholder shapes on a master contain the default text styles and shape properties of all placeholder shapes on pages that use that master. - The master page properties define the common page properties inherited by its layouts. - Any other shapes on the master slide will appear on all slides using that master, regardless of their layout. */ @@ -1240,11 +1240,11 @@ export namespace slides_v1 { /** * The ID of the presentation. */ - presentationId?: string; + presentationId?: string | null; /** * The revision ID of the presentation. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */ - revisionId?: string; + revisionId?: string | null; /** * The slides in the presentation. A slide inherits properties from a slide layout. */ @@ -1252,7 +1252,7 @@ export namespace slides_v1 { /** * The title of the presentation. */ - title?: string; + title?: string | null; } /** * Specifies a contiguous range of an indexed collection, such as characters in text. @@ -1261,15 +1261,15 @@ export namespace slides_v1 { /** * The optional zero-based index of the end of the collection. Required for `FIXED_RANGE` ranges. */ - endIndex?: number; + endIndex?: number | null; /** * The optional zero-based index of the beginning of the collection. Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges. */ - startIndex?: number; + startIndex?: number | null; /** * The type of range. */ - type?: string; + type?: string | null; } /** * A recolor effect applied on an image. @@ -1278,7 +1278,7 @@ export namespace slides_v1 { /** * The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. */ - name?: string; + name?: string | null; /** * The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. */ @@ -1291,7 +1291,7 @@ export namespace slides_v1 { /** * The object ID of the chart to refresh. */ - objectId?: string; + objectId?: string | null; } /** * Replaces all shapes that match the given criteria with the provided image. The images replacing the shapes are rectangular after being inserted into the presentation and do not take on the forms of the shapes. @@ -1304,19 +1304,19 @@ export namespace slides_v1 { /** * The image replace method. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence. If you do not specify a value for `image_replace_method`, but specify a value for `replace_method`, then the specified `replace_method` value is used. If you do not specify either, then CENTER_INSIDE is used. */ - imageReplaceMethod?: string; + imageReplaceMethod?: string | null; /** * The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field. */ - imageUrl?: string; + imageUrl?: string | null; /** * If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation. */ - pageObjectIds?: string[]; + pageObjectIds?: string[] | null; /** * The replace method. <b>Deprecated</b>: use `image_replace_method` instead. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence. */ - replaceMethod?: string; + replaceMethod?: string | null; } /** * The result of replacing shapes with an image. @@ -1325,7 +1325,7 @@ export namespace slides_v1 { /** * The number of shapes replaced with images. */ - occurrencesChanged?: number; + occurrencesChanged?: number | null; } /** * Replaces all shapes that match the given criteria with the provided Google Sheets chart. The chart will be scaled and centered to fit within the bounds of the original shape. NOTE: Replacing shapes with a chart requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes. @@ -1334,7 +1334,7 @@ export namespace slides_v1 { /** * The ID of the specific chart in the Google Sheets spreadsheet. */ - chartId?: number; + chartId?: number | null; /** * The criteria that the shapes must match in order to be replaced. The request will replace all of the shapes that contain the given text. */ @@ -1342,15 +1342,15 @@ export namespace slides_v1 { /** * The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked. */ - linkingMode?: string; + linkingMode?: string | null; /** * If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation. */ - pageObjectIds?: string[]; + pageObjectIds?: string[] | null; /** * The ID of the Google Sheets spreadsheet that contains the chart. */ - spreadsheetId?: string; + spreadsheetId?: string | null; } /** * The result of replacing shapes with a Google Sheets chart. @@ -1359,7 +1359,7 @@ export namespace slides_v1 { /** * The number of shapes replaced with charts. */ - occurrencesChanged?: number; + occurrencesChanged?: number | null; } /** * Replaces all instances of text matching a criteria with replace text. @@ -1372,11 +1372,11 @@ export namespace slides_v1 { /** * If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes master, or if a page with that object ID doesn't exist in the presentation. */ - pageObjectIds?: string[]; + pageObjectIds?: string[] | null; /** * The text that will replace the matched text. */ - replaceText?: string; + replaceText?: string | null; } /** * The result of replacing text. @@ -1385,7 +1385,7 @@ export namespace slides_v1 { /** * The number of occurrences changed by replacing all text. */ - occurrencesChanged?: number; + occurrencesChanged?: number | null; } /** * Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image. @@ -1394,15 +1394,15 @@ export namespace slides_v1 { /** * The ID of the existing image that will be replaced. */ - imageObjectId?: string; + imageObjectId?: string | null; /** * The replacement method. */ - imageReplaceMethod?: string; + imageReplaceMethod?: string | null; /** * The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field. */ - url?: string; + url?: string | null; } /** * A single kind of update to apply to a presentation. @@ -1588,7 +1588,7 @@ export namespace slides_v1 { /** * The object ID of the line to reroute. Only a line with a category indicating it is a "connector" can be rerouted. The start and end connections of the line must be on different page elements. */ - objectId?: string; + objectId?: string | null; } /** * A single response from an update. @@ -1650,15 +1650,15 @@ export namespace slides_v1 { /** * The blue component of the color, from 0.0 to 1.0. */ - blue?: number; + blue?: number | null; /** * The green component of the color, from 0.0 to 1.0. */ - green?: number; + green?: number | null; /** * The red component of the color, from 0.0 to 1.0. */ - red?: number; + red?: number | null; } /** * The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. @@ -1667,11 +1667,11 @@ export namespace slides_v1 { /** * The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. */ - alignment?: string; + alignment?: string | null; /** * The alpha of the shadow's color, from 0.0 to 1.0. */ - alpha?: number; + alpha?: number | null; /** * The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. */ @@ -1683,11 +1683,11 @@ export namespace slides_v1 { /** * The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. */ - propertyState?: string; + propertyState?: string | null; /** * Whether the shadow should rotate with the shape. This property is read-only. */ - rotateWithShape?: boolean; + rotateWithShape?: boolean | null; /** * Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. */ @@ -1695,7 +1695,7 @@ export namespace slides_v1 { /** * The type of the shadow. This property is read-only. */ - type?: string; + type?: string | null; } /** * A PageElement kind representing a generic shape that does not have a more specific classification. @@ -1712,7 +1712,7 @@ export namespace slides_v1 { /** * The type of the shape. */ - shapeType?: string; + shapeType?: string | null; /** * The text content of the shape. */ @@ -1725,7 +1725,7 @@ export namespace slides_v1 { /** * The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. */ - propertyState?: string; + propertyState?: string | null; /** * Solid color fill. */ @@ -1738,7 +1738,7 @@ export namespace slides_v1 { /** * The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor. */ - contentAlignment?: string; + contentAlignment?: string | null; /** * The hyperlink destination of the shape. If unset, there is no link. Links are not inherited from parent placeholders. */ @@ -1763,11 +1763,11 @@ export namespace slides_v1 { /** * The ID of the specific chart in the Google Sheets spreadsheet that is embedded. */ - chartId?: number; + chartId?: number | null; /** * The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. */ - contentUrl?: string; + contentUrl?: string | null; /** * The properties of the Sheets chart. */ @@ -1775,7 +1775,7 @@ export namespace slides_v1 { /** * The ID of the Google Sheets spreadsheet that contains the source chart. */ - spreadsheetId?: string; + spreadsheetId?: string | null; } /** * The properties of the SheetsChart. @@ -1806,11 +1806,11 @@ export namespace slides_v1 { /** * The object ID of the layout that this slide is based on. This property is read-only. */ - layoutObjectId?: string; + layoutObjectId?: string | null; /** * The object ID of the master that this slide is based on. This property is read-only. */ - masterObjectId?: string; + masterObjectId?: string | null; /** * The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. */ @@ -1823,7 +1823,7 @@ export namespace slides_v1 { /** * The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. */ - alpha?: number; + alpha?: number | null; /** * The color value of the solid fill. */ @@ -1836,7 +1836,7 @@ export namespace slides_v1 { /** * Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. */ - contentUrl?: string; + contentUrl?: string | null; /** * The original size of the picture fill. This field is read-only. */ @@ -1849,11 +1849,11 @@ export namespace slides_v1 { /** * Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive. */ - matchCase?: boolean; + matchCase?: boolean | null; /** * The text to search for in the shape or table. */ - text?: string; + text?: string | null; } /** * A PageElement kind representing a table. @@ -1862,7 +1862,7 @@ export namespace slides_v1 { /** * Number of columns in the table. */ - columns?: number; + columns?: number | null; /** * Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns. */ @@ -1870,7 +1870,7 @@ export namespace slides_v1 { /** * Number of rows in the table. */ - rows?: number; + rows?: number | null; /** * Properties of each column. */ @@ -1913,7 +1913,7 @@ export namespace slides_v1 { /** * The dash style of the border. */ - dashStyle?: string; + dashStyle?: string | null; /** * The fill of the table border. */ @@ -1939,7 +1939,7 @@ export namespace slides_v1 { /** * Column span of the cell. */ - columnSpan?: number; + columnSpan?: number | null; /** * The location of the cell within the table. */ @@ -1947,7 +1947,7 @@ export namespace slides_v1 { /** * Row span of the cell. */ - rowSpan?: number; + rowSpan?: number | null; /** * The properties of the table cell. */ @@ -1964,7 +1964,7 @@ export namespace slides_v1 { /** * The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. */ - propertyState?: string; + propertyState?: string | null; /** * Solid color fill. */ @@ -1977,11 +1977,11 @@ export namespace slides_v1 { /** * The 0-based column index. */ - columnIndex?: number; + columnIndex?: number | null; /** * The 0-based row index. */ - rowIndex?: number; + rowIndex?: number | null; } /** * The properties of the TableCell. @@ -1990,7 +1990,7 @@ export namespace slides_v1 { /** * The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor. */ - contentAlignment?: string; + contentAlignment?: string | null; /** * The background fill of the table cell. The default fill matches the fill for newly created table cells in the Slides editor. */ @@ -2012,7 +2012,7 @@ export namespace slides_v1 { /** * The column span of the table range. */ - columnSpan?: number; + columnSpan?: number | null; /** * The starting location of the table range. */ @@ -2020,7 +2020,7 @@ export namespace slides_v1 { /** * The row span of the table range. */ - rowSpan?: number; + rowSpan?: number | null; } /** * Properties and contents of each row in a table. @@ -2055,7 +2055,7 @@ export namespace slides_v1 { /** * The bulleted lists contained in this text, keyed by list ID. */ - lists?: {[key: string]: Schema$List}; + lists?: {[key: string]: Schema$List} | null; /** * The text contents broken down into its component parts, including styling information. This property is read-only. */ @@ -2072,7 +2072,7 @@ export namespace slides_v1 { /** * The zero-based end index of this text element, exclusive, in Unicode code units. */ - endIndex?: number; + endIndex?: number | null; /** * A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. */ @@ -2080,7 +2080,7 @@ export namespace slides_v1 { /** * The zero-based start index of this text element, in Unicode code units. */ - startIndex?: number; + startIndex?: number | null; /** * A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. */ @@ -2093,7 +2093,7 @@ export namespace slides_v1 { /** * The text of this run. */ - content?: string; + content?: string | null; /** * The styling applied to this run. */ @@ -2110,15 +2110,15 @@ export namespace slides_v1 { /** * The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. */ - baselineOffset?: string; + baselineOffset?: string | null; /** * Whether or not the text is rendered as bold. */ - bold?: boolean; + bold?: boolean | null; /** * The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. */ - fontFamily?: string; + fontFamily?: string | null; /** * The size of the text's font. When read, the `font_size` will specified in points. */ @@ -2130,7 +2130,7 @@ export namespace slides_v1 { /** * Whether or not the text is italicized. */ - italic?: boolean; + italic?: boolean | null; /** * The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABCx/123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. */ @@ -2138,15 +2138,15 @@ export namespace slides_v1 { /** * Whether or not the text is in small capital letters. */ - smallCaps?: boolean; + smallCaps?: boolean | null; /** * Whether or not the text is struck through. */ - strikethrough?: boolean; + strikethrough?: boolean | null; /** * Whether or not the text is underlined. */ - underline?: boolean; + underline?: boolean | null; /** * The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. */ @@ -2163,7 +2163,7 @@ export namespace slides_v1 { /** * The type of the theme color. */ - type?: string; + type?: string | null; } /** * The thumbnail of a page. @@ -2172,15 +2172,15 @@ export namespace slides_v1 { /** * The content URL of the thumbnail image. The URL to the image has a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. The mime type of the thumbnail image is the same as specified in the `GetPageThumbnailRequest`. */ - contentUrl?: string; + contentUrl?: string | null; /** * The positive height in pixels of the thumbnail image. */ - height?: number; + height?: number | null; /** * The positive width in pixels of the thumbnail image. */ - width?: number; + width?: number | null; } /** * Ungroups objects, such as groups. @@ -2189,7 +2189,7 @@ export namespace slides_v1 { /** * The object IDs of the objects to ungroup. Only groups that are not inside other groups can be ungrouped. All the groups should be on the same page. The group itself is deleted. The visual sizes and positions of all the children are preserved. */ - objectIds?: string[]; + objectIds?: string[] | null; } /** * Unmerges cells in a Table. @@ -2198,7 +2198,7 @@ export namespace slides_v1 { /** * The object ID of the table. */ - objectId?: string; + objectId?: string | null; /** * The table range specifying which cells of the table to unmerge. All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing. If there is text in any of the merged cells, the text will remain in the upper-left ("head") cell of the resulting block of unmerged cells. */ @@ -2211,7 +2211,7 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `imageProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the image outline color, set `fields` to `"outline.outlineFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The image properties to update. */ @@ -2219,7 +2219,7 @@ export namespace slides_v1 { /** * The object ID of the image the updates are applied to. */ - objectId?: string; + objectId?: string | null; } /** * Updates the category of a line. @@ -2228,11 +2228,11 @@ export namespace slides_v1 { /** * The line category to update to. The exact line type is determined based on the category to update to and how it's routed to connect to other page elements. */ - lineCategory?: string; + lineCategory?: string | null; /** * The object ID of the line the update is applied to. Only a line with a category indicating it is a "connector" can be updated. The line may be rerouted after updating its category. */ - objectId?: string; + objectId?: string | null; } /** * Updates the properties of a Line. @@ -2241,7 +2241,7 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `lineProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the line solid fill color, set `fields` to `"lineFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The line properties to update. */ @@ -2249,7 +2249,7 @@ export namespace slides_v1 { /** * The object ID of the line the update is applied to. */ - objectId?: string; + objectId?: string | null; } /** * Updates the alt text title and/or description of a page element. @@ -2258,15 +2258,15 @@ export namespace slides_v1 { /** * The updated alt text description of the page element. If unset the existing value will be maintained. The description is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element. */ - description?: string; + description?: string | null; /** * The object ID of the page element the updates are applied to. */ - objectId?: string; + objectId?: string | null; /** * The updated alt text title of the page element. If unset the existing value will be maintained. The title is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element. */ - title?: string; + title?: string | null; } /** * Updates the Z-order of page elements. Z-order is an ordering of the elements on the page from back to front. The page element in the front may cover the elements that are behind it. @@ -2275,11 +2275,11 @@ export namespace slides_v1 { /** * The Z-order operation to apply on the page elements. When applying the operation on multiple page elements, the relative Z-orders within these page elements before the operation is maintained. */ - operation?: string; + operation?: string | null; /** * The object IDs of the page elements to update. All the page elements must be on the same page and must not be grouped. */ - pageElementObjectIds?: string[]; + pageElementObjectIds?: string[] | null; } /** * Updates the transform of a page element. Updating the transform of a group will change the absolute transform of the page elements in that group, which can change their visual appearance. See the documentation for PageElement.transform for more details. @@ -2288,11 +2288,11 @@ export namespace slides_v1 { /** * The apply mode of the transform update. */ - applyMode?: string; + applyMode?: string | null; /** * The object ID of the page element to update. */ - objectId?: string; + objectId?: string | null; /** * The input transform matrix used to update the page element. */ @@ -2305,11 +2305,11 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `pageProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the page background solid fill color, set `fields` to `"pageBackgroundFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The object ID of the page the update is applied to. */ - objectId?: string; + objectId?: string | null; /** * The page properties to update. */ @@ -2326,11 +2326,11 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the paragraph alignment, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The object ID of the shape or table with the text to be styled. */ - objectId?: string; + objectId?: string | null; /** * The paragraph's style. */ @@ -2347,11 +2347,11 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `shapeProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the shape background solid fill color, set `fields` to `"shapeBackgroundFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The object ID of the shape the updates are applied to. */ - objectId?: string; + objectId?: string | null; /** * The shape properties to update. */ @@ -2364,11 +2364,11 @@ export namespace slides_v1 { /** * The index where the slides should be inserted, based on the slide arrangement before the move takes place. Must be between zero and the number of slides in the presentation, inclusive. */ - insertionIndex?: number; + insertionIndex?: number | null; /** * The IDs of the slides in the presentation that should be moved. The slides in this list must be in existing presentation order, without duplicates. */ - slideObjectIds?: string[]; + slideObjectIds?: string[] | null; } /** * Updates the properties of the table borders in a Table. @@ -2377,15 +2377,15 @@ export namespace slides_v1 { /** * The border position in the table range the updates should apply to. If a border position is not specified, the updates will apply to all borders in the table range. */ - borderPosition?: string; + borderPosition?: string | null; /** * The fields that should be updated. At least one field must be specified. The root `tableBorderProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the table border solid fill color, set `fields` to `"tableBorderFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The object ID of the table. */ - objectId?: string; + objectId?: string | null; /** * The table border properties to update. */ @@ -2402,11 +2402,11 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `tableCellProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the table cell background solid fill color, set `fields` to `"tableCellBackgroundFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The object ID of the table. */ - objectId?: string; + objectId?: string | null; /** * The table cell properties to update. */ @@ -2423,15 +2423,15 @@ export namespace slides_v1 { /** * The list of zero-based indices specifying which columns to update. If no indices are provided, all columns in the table will be updated. */ - columnIndices?: number[]; + columnIndices?: number[] | null; /** * The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `"column_width"`. If '"column_width"' is included in the field mask but the property is left unset, the column width will default to 406,400 EMU (32 points). */ - fields?: string; + fields?: string | null; /** * The object ID of the table. */ - objectId?: string; + objectId?: string | null; /** * The table column properties to update. If the value of `table_column_properties#column_width` in the request is less than 406,400 EMU (32 points), a 400 bad request error is returned. */ @@ -2444,15 +2444,15 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `tableRowProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `"min_row_height"`. If '"min_row_height"' is included in the field mask but the property is left unset, the minimum row height will default to 0. */ - fields?: string; + fields?: string | null; /** * The object ID of the table. */ - objectId?: string; + objectId?: string | null; /** * The list of zero-based indices specifying which rows to update. If no indices are provided, all rows in the table will be updated. */ - rowIndices?: number[]; + rowIndices?: number[] | null; /** * The table row properties to update. */ @@ -2469,11 +2469,11 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `"bold"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The object ID of the shape or table with the text to be styled. */ - objectId?: string; + objectId?: string | null; /** * The style(s) to set on the text. If the value for a particular style matches that of the parent, that style will be set to inherit. Certain text style changes may cause other changes meant to mirror the behavior of the Slides editor. See the documentation of TextStyle for more information. */ @@ -2490,11 +2490,11 @@ export namespace slides_v1 { /** * The fields that should be updated. At least one field must be specified. The root `videoProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the video outline color, set `fields` to `"outline.outlineFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ - fields?: string; + fields?: string | null; /** * The object ID of the video the updates are applied to. */ - objectId?: string; + objectId?: string | null; /** * The video properties to update. */ @@ -2507,15 +2507,15 @@ export namespace slides_v1 { /** * The video source's unique identifier for this video. */ - id?: string; + id?: string | null; /** * The video source. */ - source?: string; + source?: string | null; /** * An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change. */ - url?: string; + url?: string | null; /** * The properties of the video. */ @@ -2528,15 +2528,15 @@ export namespace slides_v1 { /** * Whether to enable video autoplay when the page is displayed in present mode. Defaults to false. */ - autoPlay?: boolean; + autoPlay?: boolean | null; /** * The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end. */ - end?: number; + end?: number | null; /** * Whether to mute the audio during video playback. Defaults to false. */ - mute?: boolean; + mute?: boolean | null; /** * The outline of the video. The default outline matches the defaults for new videos created in the Slides editor. */ @@ -2544,7 +2544,7 @@ export namespace slides_v1 { /** * The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning. */ - start?: number; + start?: number | null; } /** * Represents a font family and weight used to style a TextRun. @@ -2553,11 +2553,11 @@ export namespace slides_v1 { /** * The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. */ - fontFamily?: string; + fontFamily?: string | null; /** * The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). */ - weight?: number; + weight?: number | null; } /** * A PageElement kind representing word art. @@ -2566,7 +2566,7 @@ export namespace slides_v1 { /** * The text rendered as word art. */ - renderedText?: string; + renderedText?: string | null; } /** * Provides control over how write requests are executed. @@ -2575,7 +2575,7 @@ export namespace slides_v1 { /** * The revision ID of the presentation required for the write request. If specified and the `required_revision_id` doesn't exactly match the presentation's current `revision_id`, the request will not be processed and will return a 400 bad request error. */ - requiredRevisionId?: string; + requiredRevisionId?: string | null; } export class Resource$Presentations { diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index fb142ab87f7..8c2992eca31 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -128,7 +128,7 @@ export namespace sourcerepo_v1 { /** * 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; + 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. @@ -137,11 +137,11 @@ export namespace sourcerepo_v1 { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - exemptedMembers?: string[]; + exemptedMembers?: string[] | null; /** * The log type that this config enables. */ - logType?: string; + logType?: string | null; } /** * Associates `members` with a `role`. @@ -154,11 +154,11 @@ export namespace sourcerepo_v1 { /** * 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`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -171,19 +171,19 @@ export namespace sourcerepo_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Response for ListRepos. The size is not set in the returned repositories. @@ -192,7 +192,7 @@ export namespace sourcerepo_v1 { /** * If non-empty, additional repositories exist within the project. These can be retrieved by including this value in the next ListReposRequest's page_token field. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The listed repos. */ @@ -205,15 +205,15 @@ export namespace sourcerepo_v1 { /** * ID of the SSH deploy key at the other hosting service. Removing this key from the other service would deauthorize Google Cloud Source Repositories from mirroring. */ - deployKeyId?: string; + deployKeyId?: string | null; /** * URL of the main repository at the other hosting service. */ - url?: string; + url?: string | null; /** * ID of the webhook listening to updates to trigger mirroring. Removing this webhook from the other hosting service will stop Google Cloud Source Repositories from receiving notifications, and thereby disabling mirroring. */ - webhookId?: string; + webhookId?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -222,7 +222,7 @@ export namespace sourcerepo_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -230,15 +230,15 @@ export namespace sourcerepo_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -255,11 +255,11 @@ export namespace sourcerepo_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Cloud Source Repositories configuration of a project. @@ -268,15 +268,15 @@ export namespace sourcerepo_v1 { /** * Reject a Git push that contains a private key. */ - enablePrivateKeyCheck?: boolean; + enablePrivateKeyCheck?: boolean | null; /** * The name of the project. Values are of the form `projects/<project>`. */ - name?: string; + name?: string | null; /** * How this project publishes a change in the repositories through Cloud Pub/Sub. Keyed by the topic names. */ - pubsubConfigs?: {[key: string]: Schema$PubsubConfig}; + pubsubConfigs?: {[key: string]: Schema$PubsubConfig} | null; } /** * Configuration to publish a Cloud Pub/Sub message. @@ -285,15 +285,15 @@ export namespace sourcerepo_v1 { /** * The format of the Cloud Pub/Sub messages. */ - messageFormat?: string; + messageFormat?: string | null; /** * Email address of the service account used for publishing Cloud Pub/Sub messages. This service account needs to be in the same project as the PubsubConfig. When added, the caller needs to have iam.serviceAccounts.actAs permission on this service account. If unspecified, it defaults to the compute engine default service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; /** * A topic of Cloud Pub/Sub. Values are of the form `projects/<project>/topics/<topic>`. The project needs to be the same project as this config is in. */ - topic?: string; + topic?: string | null; } /** * A repository (or repo) is a Git repository storing versioned source content. @@ -306,19 +306,19 @@ export namespace sourcerepo_v1 { /** * Resource name of the repository, of the form `projects/<project>/repos/<repo>`. The repo name may contain slashes. eg, `projects/myproject/repos/name/with/slash` */ - name?: string; + name?: string | null; /** * How this repository publishes a change in the repository through Cloud Pub/Sub. Keyed by the topic names. */ - pubsubConfigs?: {[key: string]: Schema$PubsubConfig}; + pubsubConfigs?: {[key: string]: Schema$PubsubConfig} | null; /** * The disk usage of the repo, in bytes. Read-only field. Size is only returned by GetRepo. */ - size?: string; + size?: string | null; /** * URL to clone the repository from Google Cloud Source Repositories. Read-only field. */ - url?: string; + url?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -331,7 +331,7 @@ export namespace sourcerepo_v1 { /** * 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; + updateMask?: 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). @@ -340,15 +340,15 @@ export namespace sourcerepo_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Metadata of SyncRepo. This message is in the metadata field of Operation. @@ -357,19 +357,19 @@ export namespace sourcerepo_v1 { /** * The name of the repo being synchronized. Values are of the form `projects/<project>/repos/<repo>`. */ - name?: string; + name?: string | null; /** * The time this operation is started. */ - startTime?: string; + startTime?: string | null; /** * The latest status message on syncing the repository. */ - statusMessage?: string; + statusMessage?: string | null; /** * The time this operation's status message is updated. */ - updateTime?: string; + updateTime?: string | null; } /** * Request for SyncRepo. @@ -382,7 +382,7 @@ export namespace sourcerepo_v1 { /** * 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[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -391,7 +391,7 @@ export namespace sourcerepo_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Request for UpdateProjectConfig. @@ -404,7 +404,7 @@ export namespace sourcerepo_v1 { /** * A FieldMask specifying which fields of the project_config to modify. Only the fields in the mask will be modified. If no mask is provided, this request is no-op. */ - updateMask?: string; + updateMask?: string | null; } /** * Request for UpdateRepo. @@ -417,7 +417,7 @@ export namespace sourcerepo_v1 { /** * A FieldMask specifying which fields of the repo to modify. Only the fields in the mask will be modified. If no mask is provided, this request is no-op. */ - updateMask?: string; + updateMask?: string | null; } export class Resource$Projects { diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 1ebab465eff..07cc4a19a78 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -124,7 +124,7 @@ export namespace spanner_v1 { /** * Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary). The maximum allowed sessions are documented at https://goo.gl/hBUQED. */ - sessionCount?: number; + sessionCount?: number | null; /** * Parameters to be applied to each created session. */ @@ -159,11 +159,11 @@ export namespace spanner_v1 { /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ - members?: string[]; + members?: string[] | null; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ - role?: string; + role?: string | null; } /** * Metadata associated with a parent-child relationship appearing in a PlanNode. @@ -172,15 +172,15 @@ export namespace spanner_v1 { /** * The node to which the link points. */ - childIndex?: number; + childIndex?: number | null; /** * The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable. */ - type?: string; + type?: string | null; /** * Only present if the child node is SCALAR and corresponds to an output variable of the parent node. The field carries the name of the output variable. For example, a `TableScan` operator that reads rows from a table will have child links to the `SCALAR` nodes representing the output variables created for each column that is read by the operator. The corresponding `variable` fields will be set to the variable names assigned to the columns. */ - variable?: string; + variable?: string | null; } /** * The request for Commit. @@ -197,7 +197,7 @@ export namespace spanner_v1 { /** * Commit a previously-started transaction. */ - transactionId?: string; + transactionId?: string | null; } /** * The response for Commit. @@ -206,7 +206,7 @@ export namespace spanner_v1 { /** * The Cloud Spanner timestamp at which the transaction committed. */ - commitTimestamp?: string; + commitTimestamp?: string | null; } /** * Metadata type for the operation returned by CreateDatabase. @@ -215,7 +215,7 @@ export namespace spanner_v1 { /** * The database being created. */ - database?: string; + database?: string | null; } /** * The request for CreateDatabase. @@ -224,11 +224,11 @@ export namespace spanner_v1 { /** * Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `a-z*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``). */ - createStatement?: string; + createStatement?: string | null; /** * An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created. */ - extraStatements?: string[]; + extraStatements?: string[] | null; } /** * Metadata type for the operation returned by CreateInstance. @@ -237,11 +237,11 @@ export namespace spanner_v1 { /** * The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. */ - cancelTime?: string; + cancelTime?: string | null; /** * The time at which this operation failed or was completed successfully. */ - endTime?: string; + endTime?: string | null; /** * The instance being created. */ @@ -249,7 +249,7 @@ export namespace spanner_v1 { /** * The time at which the CreateInstance request was received. */ - startTime?: string; + startTime?: string | null; } /** * The request for CreateInstance. @@ -262,7 +262,7 @@ export namespace spanner_v1 { /** * Required. The ID of the instance to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. */ - instanceId?: string; + instanceId?: string | null; } /** * The request for CreateSession. @@ -280,11 +280,11 @@ export namespace spanner_v1 { /** * Required. The name of the database. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`, where `<database>` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. */ - name?: string; + name?: string | null; /** * Output only. The current database state. */ - state?: string; + state?: string | null; } /** * Arguments to delete operations. @@ -297,7 +297,7 @@ export namespace spanner_v1 { /** * Required. The table whose rows will be deleted. */ - table?: string; + table?: 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 `{}`. @@ -310,7 +310,7 @@ export namespace spanner_v1 { /** * 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; + 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. */ @@ -340,31 +340,31 @@ export namespace spanner_v1 { /** * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. */ - params?: {[key: string]: any}; + params?: {[key: string]: any} | null; /** * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */ - paramTypes?: {[key: string]: Schema$Type}; + paramTypes?: {[key: string]: Schema$Type} | null; /** * If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token. */ - partitionToken?: string; + partitionToken?: string | null; /** * Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. */ - queryMode?: string; + queryMode?: string | null; /** * If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. */ - resumeToken?: string; + resumeToken?: string | null; /** * 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 for DML statements. Ignored for queries. */ - seqno?: string; + seqno?: string | null; /** * Required. The SQL string. */ - sql?: string; + sql?: string | null; /** * The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require 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. Partitioned DML requires an existing Partitioned DML transaction ID. */ @@ -377,19 +377,19 @@ export namespace spanner_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * Message representing a single field of a struct. @@ -398,7 +398,7 @@ export namespace spanner_v1 { /** * The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. */ - name?: string; + name?: string | null; /** * The type of the field. */ @@ -411,7 +411,7 @@ export namespace spanner_v1 { /** * A list of formatted DDL statements defining the schema of the database specified in the request. */ - statements?: string[]; + statements?: string[] | null; } /** * Request message for `GetIamPolicy` method. @@ -429,7 +429,7 @@ export namespace spanner_v1 { /** * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. */ - requestedPolicyVersion?: number; + requestedPolicyVersion?: number | null; } /** * An isolated set of Cloud Spanner resources on which databases can be hosted. @@ -438,27 +438,27 @@ export namespace spanner_v1 { /** * Required. The name of the instance's configuration. Values are of the form `projects/<project>/instanceConfigs/<configuration>`. See also InstanceConfig and ListInstanceConfigs. */ - config?: string; + config?: string | null; /** * 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; + displayName?: 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. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects/<project>/instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. */ - name?: string; + 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. */ - nodeCount?: number; + nodeCount?: number | null; /** * Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. */ - state?: string; + state?: string | null; } /** * A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. @@ -467,11 +467,11 @@ export namespace spanner_v1 { /** * The name of this instance configuration as it appears in UIs. */ - displayName?: string; + displayName?: string | null; /** * A unique identifier for the instance configuration. Values are of the form `projects/<project>/instanceConfigs/a-z*` */ - name?: string; + name?: string | null; /** * The geographic placement of nodes in this instance configuration and their replication properties. */ @@ -484,19 +484,19 @@ export namespace spanner_v1 { /** * If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`. */ - endClosed?: any[]; + endClosed?: any[] | null; /** * If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`. */ - endOpen?: any[]; + endOpen?: any[] | null; /** * If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`. */ - startClosed?: any[]; + startClosed?: any[] | null; /** * If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`. */ - startOpen?: any[]; + startOpen?: any[] | null; } /** * `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way. If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once. @@ -505,11 +505,11 @@ export namespace spanner_v1 { /** * For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index. Note that any keys specified in `keys` or `ranges` are only yielded once. */ - all?: boolean; + all?: boolean | null; /** * A list of specific keys. Entries in `keys` should have exactly as many elements as there are columns in the primary or index key with which this `KeySet` is used. Individual key values are encoded as described here. */ - keys?: any[][]; + keys?: any[][] | null; /** * A list of key ranges. See KeyRange for more information about key range specifications. */ @@ -526,7 +526,7 @@ export namespace spanner_v1 { /** * `next_page_token` can be sent in a subsequent ListDatabases call to fetch more of the matching databases. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for ListInstanceConfigs. @@ -539,7 +539,7 @@ export namespace spanner_v1 { /** * `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response for ListInstances. @@ -552,7 +552,7 @@ export namespace spanner_v1 { /** * `next_page_token` can be sent in a subsequent ListInstances call to fetch more of the matching instances. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -561,7 +561,7 @@ export namespace spanner_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -574,7 +574,7 @@ export namespace spanner_v1 { /** * `next_page_token` can be sent in a subsequent ListSessions call to fetch more of the matching sessions. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of requested sessions. */ @@ -612,7 +612,7 @@ export namespace spanner_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -620,15 +620,15 @@ export namespace spanner_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume. @@ -637,7 +637,7 @@ export namespace spanner_v1 { /** * If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value. */ - chunkedValue?: boolean; + chunkedValue?: boolean | null; /** * Metadata about the result set, such as row type information. Only present in the first response. */ @@ -645,7 +645,7 @@ export namespace spanner_v1 { /** * Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token. */ - resumeToken?: string; + resumeToken?: string | null; /** * Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements. */ @@ -653,7 +653,7 @@ export namespace spanner_v1 { /** * A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: cannot be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: # Strings are concatenated. "foo", "bar" => "foobar" # Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are concatenated, but the last and first elements are merged # because they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] # Lists are concatenated, but the last and first elements are merged # because they are lists. Recursively, the last and first elements # of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] # Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} # Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} # Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. */ - values?: any[]; + values?: any[] | null; } /** * Information returned for each partition returned in a PartitionResponse. @@ -662,7 +662,7 @@ export namespace spanner_v1 { /** * This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token. */ - partitionToken?: string; + partitionToken?: string | null; } /** * Message type to initiate a Partitioned DML transaction. @@ -675,11 +675,11 @@ export namespace spanner_v1 { /** * **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request. */ - maxPartitions?: string; + maxPartitions?: string | null; /** * **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request. */ - partitionSizeBytes?: string; + partitionSizeBytes?: string | null; } /** * The request for PartitionQuery @@ -688,11 +688,11 @@ export namespace spanner_v1 { /** * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. */ - params?: {[key: string]: any}; + params?: {[key: string]: any} | null; /** * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. */ - paramTypes?: {[key: string]: Schema$Type}; + paramTypes?: {[key: string]: Schema$Type} | null; /** * Additional options that affect how many partitions are created. */ @@ -700,7 +700,7 @@ export namespace spanner_v1 { /** * 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; + sql?: string | null; /** * Read only snapshot transactions are supported, read/write and single use transactions are not. */ @@ -713,11 +713,11 @@ export namespace spanner_v1 { /** * The columns of table to be returned for each row matching this request. */ - columns?: string[]; + columns?: string[] | null; /** * If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. */ - index?: string; + index?: string | null; /** * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. */ @@ -729,7 +729,7 @@ export namespace spanner_v1 { /** * Required. The name of the table in the database to be read. */ - table?: string; + table?: string | null; /** * Read only snapshot transactions are supported, read/write and single use transactions are not. */ @@ -759,23 +759,23 @@ export namespace spanner_v1 { /** * The display name for the node. */ - displayName?: string; + displayName?: string | null; /** * The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc. */ - executionStats?: {[key: string]: any}; + executionStats?: {[key: string]: any} | null; /** * The `PlanNode`'s index in node list. */ - index?: number; + index?: number | null; /** * Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent. */ - kind?: string; + kind?: string | null; /** * Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" } */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * Condensed representation for SCALAR nodes. */ @@ -792,11 +792,11 @@ export namespace spanner_v1 { /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ - etag?: string; + etag?: string | null; /** * Deprecated. */ - version?: number; + version?: number | null; } /** * Contains an ordered list of nodes appearing in the query plan. @@ -814,27 +814,27 @@ export namespace spanner_v1 { /** * Executes all reads at a timestamp that is `exact_staleness` old. The timestamp is chosen soon after the read is started. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of `max_staleness`. */ - exactStaleness?: string; + exactStaleness?: string | null; /** * Read data at a timestamp >= `NOW - max_staleness` seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind. Note that this option can only be used in single-use transactions. */ - maxStaleness?: string; + maxStaleness?: string | null; /** * Executes all reads at a timestamp >= `min_read_timestamp`. This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known. Note that this option can only be used in single-use transactions. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */ - minReadTimestamp?: string; + minReadTimestamp?: string | null; /** * Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */ - readTimestamp?: string; + readTimestamp?: string | null; /** * If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction. */ - returnReadTimestamp?: boolean; + returnReadTimestamp?: boolean | null; /** * Read at a timestamp where all previously committed transactions are visible. */ - strong?: boolean; + strong?: boolean | null; } /** * The request for Read and StreamingRead. @@ -843,11 +843,11 @@ export namespace spanner_v1 { /** * The columns of table to be returned for each row matching this request. */ - columns?: string[]; + columns?: string[] | null; /** * If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. */ - index?: string; + index?: string | null; /** * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. */ @@ -855,19 +855,19 @@ export namespace spanner_v1 { /** * If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit cannot be specified if `partition_token` is set. */ - limit?: string; + limit?: string | null; /** * If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. */ - partitionToken?: string; + partitionToken?: string | null; /** * If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. */ - resumeToken?: string; + resumeToken?: string | null; /** * Required. The name of the table in the database to be read. */ - table?: string; + table?: string | null; /** * The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. */ @@ -881,15 +881,15 @@ export namespace spanner_v1 { /** * If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. */ - defaultLeaderLocation?: boolean; + defaultLeaderLocation?: boolean | null; /** * The location of the serving resources, e.g. "us-central1". */ - location?: string; + location?: string | null; /** * The type of replica. */ - type?: string; + type?: string | null; } /** * Results from Read or ExecuteSql. @@ -902,7 +902,7 @@ export namespace spanner_v1 { /** * Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here. */ - rows?: any[][]; + rows?: any[][] | null; /** * Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode. */ @@ -932,15 +932,15 @@ export namespace spanner_v1 { /** * Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" } */ - queryStats?: {[key: string]: any}; + queryStats?: {[key: string]: any} | null; /** * Standard DML returns an exact count of rows that were modified. */ - rowCountExact?: string; + rowCountExact?: string | null; /** * Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified. */ - rowCountLowerBound?: string; + rowCountLowerBound?: string | null; } /** * The request for Rollback. @@ -949,7 +949,7 @@ export namespace spanner_v1 { /** * Required. The transaction to roll back. */ - transactionId?: string; + transactionId?: string | null; } /** * A session in the Cloud Spanner API. @@ -958,19 +958,19 @@ export namespace spanner_v1 { /** * Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. */ - approximateLastUseTime?: string; + approximateLastUseTime?: string | null; /** * Output only. The timestamp when the session is created. */ - createTime?: string; + createTime?: string | null; /** * The labels for the session. * 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 session. See https://goo.gl/xmQnxf for more information on and examples of labels. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The name of the session. This is always system-assigned; values provided when creating a session are ignored. */ - name?: string; + name?: string | null; } /** * Request message for `SetIamPolicy` method. @@ -988,11 +988,11 @@ export namespace spanner_v1 { /** * A string representation of the expression subtree rooted at this node. */ - description?: string; + description?: string | null; /** * A mapping of (subquery variable name) -> (subquery node id) for cases where the `description` string of this node references a `SCALAR` subquery contained in the expression subtree rooted at this node. The referenced `SCALAR` subquery may not necessarily be a direct child of this node. */ - subqueries?: {[key: string]: number}; + subqueries?: {[key: string]: number} | null; } /** * A single DML statement. @@ -1001,15 +1001,15 @@ export namespace spanner_v1 { /** * Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. */ - params?: {[key: string]: any}; + params?: {[key: string]: any} | null; /** * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */ - paramTypes?: {[key: string]: Schema$Type}; + paramTypes?: {[key: string]: Schema$Type} | null; /** * Required. The DML string. */ - sql?: string; + sql?: 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). @@ -1018,15 +1018,15 @@ export namespace spanner_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * `StructType` defines the fields of a STRUCT type. @@ -1044,7 +1044,7 @@ export namespace spanner_v1 { /** * REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. @@ -1053,7 +1053,7 @@ export namespace spanner_v1 { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ - permissions?: string[]; + permissions?: string[] | null; } /** * A transaction. @@ -1062,11 +1062,11 @@ export namespace spanner_v1 { /** * `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests. */ - id?: string; + id?: string | null; /** * For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */ - readTimestamp?: string; + readTimestamp?: string | null; } /** * # Transactions Each session can have at most one active transaction at a time. After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. # Transaction Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. This transaction type provides guaranteed consistency across several reads, but does not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past. Snapshot read-only transactions do not need to be committed. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read/write data in a single database. They may, however, read/write data in different tables within that database. ## Locking Read-Write Transactions Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. ### Semantics Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. ### Retrying Aborted Transactions When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (e.g., many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of wall time spent retrying. ### Idle Transactions A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. In that case, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transaction, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. ### Strong Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. See TransactionOptions.ReadOnly.strong. ### Exact Staleness These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp <= the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded Staleness Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## Partitioned DML Transactions Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table. @@ -1096,7 +1096,7 @@ export namespace spanner_v1 { /** * Execute the read or SQL query in a previously-started transaction. */ - id?: string; + id?: string | null; /** * Execute the read or SQL query in a temporary transaction. This is the most efficient way to execute a transaction that consists of a single SQL query. */ @@ -1113,7 +1113,7 @@ export namespace spanner_v1 { /** * Required. The TypeCode for this type. */ - code?: string; + code?: string | null; /** * If code == STRUCT, then `struct_type` provides type information for the struct's fields. */ @@ -1126,15 +1126,15 @@ export namespace spanner_v1 { /** * Reports the commit timestamps of all statements that have succeeded so far, where `commit_timestamps[i]` is the commit timestamp for the statement `statements[i]`. */ - commitTimestamps?: string[]; + commitTimestamps?: string[] | null; /** * The database being modified. */ - database?: string; + database?: string | null; /** * For an update this list contains all the statements. For an individual statement, this list contains only that statement. */ - statements?: string[]; + statements?: string[] | null; } /** * Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details. @@ -1143,11 +1143,11 @@ export namespace spanner_v1 { /** * If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the name of the resulting longrunning.Operation: `<database>/operations/<operation_id>`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`. */ - operationId?: string; + operationId?: string | null; /** * DDL statements to be applied to the database. */ - statements?: string[]; + statements?: string[] | null; } /** * Metadata type for the operation returned by UpdateInstance. @@ -1156,11 +1156,11 @@ export namespace spanner_v1 { /** * The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. */ - cancelTime?: string; + cancelTime?: string | null; /** * The time at which this operation failed or was completed successfully. */ - endTime?: string; + endTime?: string | null; /** * The desired end state of the update. */ @@ -1168,7 +1168,7 @@ export namespace spanner_v1 { /** * The time at which UpdateInstance request was received. */ - startTime?: string; + startTime?: string | null; } /** * The request for UpdateInstance. @@ -1177,7 +1177,7 @@ export namespace spanner_v1 { /** * 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. */ - fieldMask?: string; + 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. */ @@ -1190,15 +1190,15 @@ export namespace spanner_v1 { /** * The names of the columns in table to be written. The list of columns must contain enough columns to allow Cloud Spanner to derive values for all primary key columns in the row(s) to be modified. */ - columns?: string[]; + columns?: string[] | null; /** * Required. The table whose rows will be written. */ - table?: string; + table?: string | null; /** * The values to be written. `values` can contain more than one list of values. If it does, then multiple rows are written, one for each entry in `values`. Each list in `values` must have exactly as many entries as there are entries in columns above. Sending multiple lists is equivalent to sending multiple `Mutation`s, each containing one `values` entry and repeating table and columns. Individual values in each list are encoded as described here. */ - values?: any[][]; + values?: any[][] | null; } export class Resource$Projects { diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index 3dbb0f10fd4..221697688d0 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -128,7 +128,7 @@ export namespace speech_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -141,15 +141,15 @@ export namespace speech_v1 { /** * Time of the most recent processing update. */ - lastUpdateTime?: string; + lastUpdateTime?: string | null; /** * Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available. */ - progressPercent?: number; + progressPercent?: number | null; /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; } /** * The top-level message sent by the client for the `LongRunningRecognize` method. @@ -180,7 +180,7 @@ export namespace speech_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -188,15 +188,15 @@ export namespace speech_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Contains audio data in the encoding specified in the `RecognitionConfig`. Either `content` or `uri` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. See [content limits](https://cloud.google.com/speech-to-text/quotas#content). @@ -205,11 +205,11 @@ export namespace speech_v1 { /** * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. */ - content?: string; + content?: string | null; /** * URI that points to a file that contains audio data bytes as specified in `RecognitionConfig`. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: `gs://bucket_name/object_name` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris). */ - uri?: string; + uri?: string | null; } /** * Provides information to the recognizer that specifies how to process the request. @@ -218,31 +218,31 @@ export namespace speech_v1 { /** * *Optional* The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. */ - audioChannelCount?: number; + audioChannelCount?: number | null; /** * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. */ - enableAutomaticPunctuation?: boolean; + enableAutomaticPunctuation?: boolean | null; /** * This needs to be set to `true` explicitly and `audio_channel_count` > 1 to get each channel recognized separately. The recognition result will contain a `channel_tag` field to state which channel that result belongs to. If this is not true, we will only recognize the first channel. The request is billed cumulatively for all channels recognized: `audio_channel_count` multiplied by the length of the audio. */ - enableSeparateRecognitionPerChannel?: boolean; + enableSeparateRecognitionPerChannel?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. */ - enableWordTimeOffsets?: boolean; + enableWordTimeOffsets?: boolean | null; /** * Encoding of audio data sent in all `RecognitionAudio` messages. This field is optional for `FLAC` and `WAV` audio files and required for all other audio formats. For details, see AudioEncoding. */ - encoding?: string; + encoding?: string | null; /** * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ - maxAlternatives?: number; + maxAlternatives?: number | null; /** * *Optional* Metadata regarding this request. */ @@ -250,15 +250,15 @@ export namespace speech_v1 { /** * *Optional* Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> */ - model?: string; + model?: string | null; /** * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ - profanityFilter?: boolean; + profanityFilter?: boolean | null; /** * Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. */ - sampleRateHertz?: number; + sampleRateHertz?: number | null; /** * *Optional* array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/context-strength). */ @@ -266,7 +266,7 @@ export namespace speech_v1 { /** * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. */ - useEnhanced?: boolean; + useEnhanced?: boolean | null; } /** * Description of audio data to be recognized. @@ -275,39 +275,39 @@ export namespace speech_v1 { /** * Description of the content. Eg. "Recordings of federal supreme court hearings from 2012". */ - audioTopic?: string; + audioTopic?: string | null; /** * The industry vertical to which this speech recognition request most closely applies. This is most indicative of the topics contained in the audio. Use the 6-digit NAICS code to identify the industry vertical - see https://www.naics.com/search/. */ - industryNaicsCodeOfAudio?: number; + industryNaicsCodeOfAudio?: number | null; /** * The use case most closely describing the audio content to be recognized. */ - interactionType?: string; + interactionType?: string | null; /** * The audio type that most closely describes the audio being recognized. */ - microphoneDistance?: string; + microphoneDistance?: string | null; /** * Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service. */ - obfuscatedId?: string; + obfuscatedId?: string | null; /** * The original media the speech was recorded on. */ - originalMediaType?: string; + originalMediaType?: string | null; /** * Mime type of the original audio file. For example `audio/m4a`, `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list of possible audio mime types is maintained at http://www.iana.org/assignments/media-types/media-types.xhtml#audio */ - originalMimeType?: string; + originalMimeType?: string | null; /** * The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. */ - recordingDeviceName?: string; + recordingDeviceName?: string | null; /** * The type of device the speech was recorded with. */ - recordingDeviceType?: string; + recordingDeviceType?: string | null; } /** * The top-level message sent by the client for the `Recognize` method. @@ -338,7 +338,7 @@ export namespace speech_v1 { /** * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. */ - phrases?: string[]; + phrases?: string[] | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -347,11 +347,11 @@ export namespace speech_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Output only. Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -368,7 +368,7 @@ export namespace speech_v1 { /** * For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N, its output values can range from '1' to 'N'. */ - channelTag?: number; + channelTag?: number | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -377,15 +377,15 @@ export namespace speech_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Word-specific information for recognized words. @@ -394,15 +394,15 @@ export namespace speech_v1 { /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * Output only. The word corresponding to this set of information. */ - word?: string; + word?: string | null; } export class Resource$Operations { diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index 29dfe5c5d0b..370bdb94642 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -128,7 +128,7 @@ export namespace speech_v1p1beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -141,15 +141,15 @@ export namespace speech_v1p1beta1 { /** * Time of the most recent processing update. */ - lastUpdateTime?: string; + lastUpdateTime?: string | null; /** * Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available. */ - progressPercent?: number; + progressPercent?: number | null; /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; } /** * The top-level message sent by the client for the `LongRunningRecognize` method. @@ -180,7 +180,7 @@ export namespace speech_v1p1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -188,15 +188,15 @@ export namespace speech_v1p1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Contains audio data in the encoding specified in the `RecognitionConfig`. Either `content` or `uri` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. See [content limits](https://cloud.google.com/speech-to-text/quotas#content). @@ -205,11 +205,11 @@ export namespace speech_v1p1beta1 { /** * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. */ - content?: string; + content?: string | null; /** * URI that points to a file that contains audio data bytes as specified in `RecognitionConfig`. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: `gs://bucket_name/object_name` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris). */ - uri?: string; + uri?: string | null; } /** * Provides information to the recognizer that specifies how to process the request. @@ -218,11 +218,11 @@ export namespace speech_v1p1beta1 { /** * *Optional* A list of up to 3 additional [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, listing possible alternative languages of the supplied audio. See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. If alternative languages are listed, recognition result will contain recognition in the most likely language detected including the main language_code. The recognition result will include the language tag of the language detected in the audio. Note: This feature is only supported for Voice Command and Voice Search use cases and performance may vary for other use cases (e.g., phone call transcription). */ - alternativeLanguageCodes?: string[]; + alternativeLanguageCodes?: string[] | null; /** * *Optional* The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. */ - audioChannelCount?: number; + audioChannelCount?: number | null; /** * *Optional* Config to enable speaker diarization and set additional parameters to make diarization better suited for your application. Note: When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult. */ @@ -230,39 +230,39 @@ export namespace speech_v1p1beta1 { /** * *Optional* If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Note: Use diarization_config instead. */ - diarizationSpeakerCount?: number; + diarizationSpeakerCount?: number | null; /** * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. */ - enableAutomaticPunctuation?: boolean; + enableAutomaticPunctuation?: boolean | null; /** * This needs to be set to `true` explicitly and `audio_channel_count` > 1 to get each channel recognized separately. The recognition result will contain a `channel_tag` field to state which channel that result belongs to. If this is not true, we will only recognize the first channel. The request is billed cumulatively for all channels recognized: `audio_channel_count` multiplied by the length of the audio. */ - enableSeparateRecognitionPerChannel?: boolean; + enableSeparateRecognitionPerChannel?: boolean | null; /** * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: Use diarization_config instead. */ - enableSpeakerDiarization?: boolean; + enableSpeakerDiarization?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ - enableWordConfidence?: boolean; + enableWordConfidence?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. */ - enableWordTimeOffsets?: boolean; + enableWordTimeOffsets?: boolean | null; /** * Encoding of audio data sent in all `RecognitionAudio` messages. This field is optional for `FLAC` and `WAV` audio files and required for all other audio formats. For details, see AudioEncoding. */ - encoding?: string; + encoding?: string | null; /** * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ - maxAlternatives?: number; + maxAlternatives?: number | null; /** * *Optional* Metadata regarding this request. */ @@ -270,15 +270,15 @@ export namespace speech_v1p1beta1 { /** * *Optional* Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> */ - model?: string; + model?: string | null; /** * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ - profanityFilter?: boolean; + profanityFilter?: boolean | null; /** * Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. */ - sampleRateHertz?: number; + sampleRateHertz?: number | null; /** * *Optional* array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/context-strength). */ @@ -286,7 +286,7 @@ export namespace speech_v1p1beta1 { /** * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. */ - useEnhanced?: boolean; + useEnhanced?: boolean | null; } /** * Description of audio data to be recognized. @@ -295,39 +295,39 @@ export namespace speech_v1p1beta1 { /** * Description of the content. Eg. "Recordings of federal supreme court hearings from 2012". */ - audioTopic?: string; + audioTopic?: string | null; /** * The industry vertical to which this speech recognition request most closely applies. This is most indicative of the topics contained in the audio. Use the 6-digit NAICS code to identify the industry vertical - see https://www.naics.com/search/. */ - industryNaicsCodeOfAudio?: number; + industryNaicsCodeOfAudio?: number | null; /** * The use case most closely describing the audio content to be recognized. */ - interactionType?: string; + interactionType?: string | null; /** * The audio type that most closely describes the audio being recognized. */ - microphoneDistance?: string; + microphoneDistance?: string | null; /** * Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service. */ - obfuscatedId?: string; + obfuscatedId?: string | null; /** * The original media the speech was recorded on. */ - originalMediaType?: string; + originalMediaType?: string | null; /** * Mime type of the original audio file. For example `audio/m4a`, `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list of possible audio mime types is maintained at http://www.iana.org/assignments/media-types/media-types.xhtml#audio */ - originalMimeType?: string; + originalMimeType?: string | null; /** * The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. */ - recordingDeviceName?: string; + recordingDeviceName?: string | null; /** * The type of device the speech was recorded with. */ - recordingDeviceType?: string; + recordingDeviceType?: string | null; } /** * The top-level message sent by the client for the `Recognize` method. @@ -344,7 +344,7 @@ export namespace speech_v1p1beta1 { /** * *Optional* The name of the model to use for recognition. */ - name?: string; + 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. @@ -362,15 +362,15 @@ export namespace speech_v1p1beta1 { /** * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. */ - enableSpeakerDiarization?: boolean; + enableSpeakerDiarization?: boolean | null; /** * *Optional* Maximum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 6. */ - maxSpeakerCount?: number; + maxSpeakerCount?: number | null; /** * *Optional* Minimum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 2. */ - minSpeakerCount?: number; + minSpeakerCount?: number | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -379,11 +379,11 @@ export namespace speech_v1p1beta1 { /** * Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. */ - boost?: number; + boost?: number | null; /** * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. */ - phrases?: string[]; + phrases?: string[] | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -392,11 +392,11 @@ export namespace speech_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Output only. Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -413,11 +413,11 @@ export namespace speech_v1p1beta1 { /** * For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N, its output values can range from '1' to 'N'. */ - channelTag?: number; + channelTag?: number | null; /** * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ - languageCode?: string; + languageCode?: 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). @@ -426,15 +426,15 @@ export namespace speech_v1p1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Word-specific information for recognized words. @@ -443,23 +443,23 @@ export namespace speech_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. */ - speakerTag?: number; + speakerTag?: number | null; /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * Output only. The word corresponding to this set of information. */ - word?: string; + word?: string | null; } export class Resource$Operations { diff --git a/src/apis/speech/v2beta.ts b/src/apis/speech/v2beta.ts index 3c2f6256af1..48862098541 100644 --- a/src/apis/speech/v2beta.ts +++ b/src/apis/speech/v2beta.ts @@ -124,7 +124,7 @@ export namespace speech_v2beta { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -137,18 +137,18 @@ export namespace speech_v2beta { /** * Output only. Time of the most recent processing update. */ - lastUpdateTime?: string; + lastUpdateTime?: string | null; /** * Output only. Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available. */ - progressPercent?: number; + progressPercent?: number | null; /** * Output only. Time when the request was received. */ - startTime?: string; + startTime?: string | null; } /** - * The only message returned to the client by the `LongRunningRecognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages. It is included in the `result.response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * The only message returned to the client by the `LongRunningRecognize` method. It contains the result as zero or more sequential SpeechRecognitionResult messages. It is included in the `result.response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$LongRunningRecognizeResponse { /** @@ -163,7 +163,7 @@ export namespace speech_v2beta { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -171,15 +171,15 @@ export namespace speech_v2beta { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -188,11 +188,11 @@ export namespace speech_v2beta { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Output only. Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -207,13 +207,13 @@ export namespace speech_v2beta { */ alternatives?: Schema$SpeechRecognitionAlternative[]; /** - * Output only. For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N, its output values can range from '1' to 'N'. + * Output only. For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For `audio_channel_count` = N, its output values can range from `1` to `N`. */ - channelTag?: number; + channelTag?: number | null; /** * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ - languageCode?: string; + languageCode?: 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). @@ -222,15 +222,15 @@ export namespace speech_v2beta { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Word-specific information for recognized words. @@ -239,23 +239,23 @@ export namespace speech_v2beta { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** - * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to `diarization_speaker_count`. speaker_tag is set if `enable_speaker_diarization` = `true` and only in the top alternative. + * 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; + speakerTag?: number | null; /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * Output only. The word corresponding to this set of information. */ - word?: string; + word?: string | null; } export class Resource$Projects { diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 40249b88a06..e3363c4e074 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -122,19 +122,19 @@ export namespace sqladmin_v1beta4 { /** * The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - expirationTime?: string; + expirationTime?: string | null; /** * This is always sql#aclEntry. */ - kind?: string; + kind?: string | null; /** * An optional label to identify this entry. */ - name?: string; + name?: string | null; /** * The whitelisted value for the access control list. */ - value?: string; + value?: string | null; } /** * An Admin API warning message. @@ -143,11 +143,11 @@ export namespace sqladmin_v1beta4 { /** * Code to uniquely identify the warning type. */ - code?: string; + code?: string | null; /** * The warning message. */ - message?: string; + message?: string | null; } /** * Database instance backup configuration. @@ -156,27 +156,27 @@ export namespace sqladmin_v1beta4 { /** * Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well. */ - binaryLogEnabled?: boolean; + binaryLogEnabled?: boolean | null; /** * Whether this configuration is enabled. */ - enabled?: boolean; + enabled?: boolean | null; /** * This is always sql#backupConfiguration. */ - kind?: string; + kind?: string | null; /** * The location of the backup. */ - location?: string; + location?: string | null; /** * Reserved for future use. */ - replicationLogArchivingEnabled?: boolean; + replicationLogArchivingEnabled?: boolean | null; /** * Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM. */ - startTime?: string; + startTime?: string | null; } /** * A BackupRun resource. @@ -185,7 +185,7 @@ export namespace sqladmin_v1beta4 { /** * The description of this run, only applicable to on-demand backups. */ - description?: string; + description?: string | null; /** * Disk encryption configuration specific to a backup. Applies only to Second Generation instances. */ @@ -197,11 +197,11 @@ export namespace sqladmin_v1beta4 { /** * The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - endTime?: string; + endTime?: string | null; /** * The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - enqueuedTime?: string; + enqueuedTime?: string | null; /** * Information about why the backup operation failed. This is only present if the run has the FAILED status. */ @@ -209,39 +209,39 @@ export namespace sqladmin_v1beta4 { /** * The identifier for this backup run. Unique only for a specific Cloud SQL instance. */ - id?: string; + id?: string | null; /** * Name of the database instance. */ - instance?: string; + instance?: string | null; /** * This is always sql#backupRun. */ - kind?: string; + kind?: string | null; /** * The location of the backup. */ - location?: string; + location?: string | null; /** * The URI of this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - startTime?: string; + startTime?: string | null; /** * The status of this run. */ - status?: string; + status?: string | null; /** * The type of this run; can be either "AUTOMATED" or "ON_DEMAND". */ - type?: string; + type?: string | null; /** * The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - windowStartTime?: string; + windowStartTime?: string | null; } /** * Backup run list results. @@ -254,11 +254,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#backupRunsList. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Binary log coordinates. @@ -267,15 +267,15 @@ export namespace sqladmin_v1beta4 { /** * Name of the binary log file for a Cloud SQL instance. */ - binLogFileName?: string; + binLogFileName?: string | null; /** * Position (offset) within the binary log file. */ - binLogPosition?: string; + binLogPosition?: string | null; /** * This is always sql#binLogCoordinates. */ - kind?: string; + kind?: string | null; } /** * Database instance clone context. @@ -288,15 +288,15 @@ export namespace sqladmin_v1beta4 { /** * Name of the Cloud SQL instance to be created as a clone. */ - destinationInstanceName?: string; + destinationInstanceName?: string | null; /** * This is always sql#cloneContext. */ - kind?: string; + kind?: string | null; /** * Reserved for future use. */ - pitrTimestampMs?: string; + pitrTimestampMs?: string | null; } /** * Represents a SQL database on the Cloud SQL instance. @@ -305,35 +305,35 @@ export namespace sqladmin_v1beta4 { /** * The MySQL charset value. */ - charset?: string; + charset?: string | null; /** * The MySQL collation value. */ - collation?: string; + collation?: string | null; /** * This field is deprecated and will be removed from a future version of the API. */ - etag?: string; + etag?: string | null; /** * The name of the Cloud SQL instance. This does not include the project ID. */ - instance?: string; + instance?: string | null; /** * This is always sql#database. */ - kind?: string; + kind?: string | null; /** * The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. */ - name?: string; + name?: string | null; /** * The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. */ - project?: string; + project?: string | null; /** * The URI of this resource. */ - selfLink?: string; + selfLink?: string | null; } /** * Database flags for Cloud SQL instances. @@ -342,11 +342,11 @@ export namespace sqladmin_v1beta4 { /** * The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags should be specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation. */ - name?: string; + name?: string | null; /** * The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value. */ - value?: string; + value?: string | null; } /** * A Cloud SQL instance resource. @@ -355,19 +355,19 @@ export namespace sqladmin_v1beta4 { /** * FIRST_GEN: First Generation instance. MySQL only. SECOND_GEN: Second Generation instance or PostgreSQL instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type and Second or First Generation. */ - backendType?: string; + backendType?: string | null; /** * Connection name of the Cloud SQL instance used in connection strings. */ - connectionName?: string; + connectionName?: string | null; /** * The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details. */ - currentDiskSize?: string; + currentDiskSize?: string | null; /** * The database engine type and version. The databaseVersion field can not be changed after instance creation. MySQL Second Generation instances: MYSQL_5_7 (default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 (default) or POSTGRES_11 Beta. MySQL First Generation instances: MYSQL_5_6 (default) or MYSQL_5_5 */ - databaseVersion?: string; + databaseVersion?: string | null; /** * Disk encryption configuration specific to an instance. Applies only to Second Generation instances. */ @@ -379,19 +379,19 @@ export namespace sqladmin_v1beta4 { /** * This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead. */ - etag?: string; + etag?: string | null; /** * The name and status of the failover replica. This property is applicable only to Second Generation instances. */ - failoverReplica?: {available?: boolean; name?: string}; + failoverReplica?: {available?: boolean; name?: string} | null; /** * The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. */ - gceZone?: string; + gceZone?: string | null; /** * The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. */ - instanceType?: string; + instanceType?: string | null; /** * The assigned IP addresses for the instance. */ @@ -399,23 +399,23 @@ export namespace sqladmin_v1beta4 { /** * The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. */ - ipv6Address?: string; + ipv6Address?: string | null; /** * This is always sql#instance. */ - kind?: string; + kind?: string | null; /** * The name of the instance which will act as master in the replication setup. */ - masterInstanceName?: string; + masterInstanceName?: string | null; /** * The maximum disk size of the instance in bytes. */ - maxDiskSize?: string; + maxDiskSize?: string | null; /** * Name of the Cloud SQL instance. This does not include the project ID. */ - name?: string; + name?: string | null; /** * Configuration specific to on-premises instances. */ @@ -423,11 +423,11 @@ export namespace sqladmin_v1beta4 { /** * The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. */ - project?: string; + project?: string | null; /** * The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. */ - region?: string; + region?: string | null; /** * Configuration specific to failover replicas and read replicas. */ @@ -435,15 +435,15 @@ export namespace sqladmin_v1beta4 { /** * The replicas of the instance. */ - replicaNames?: string[]; + replicaNames?: string[] | null; /** * Initial root password. Use only on creation. */ - rootPassword?: string; + rootPassword?: string | null; /** * The URI of this resource. */ - selfLink?: string; + selfLink?: string | null; /** * SSL configuration. */ @@ -451,7 +451,7 @@ export namespace sqladmin_v1beta4 { /** * The service account email address assigned to the instance. This property is applicable only to Second Generation instances. */ - serviceAccountEmailAddress?: string; + serviceAccountEmailAddress?: string | null; /** * The user settings. */ @@ -459,11 +459,11 @@ export namespace sqladmin_v1beta4 { /** * The current serving state of the Cloud SQL instance. This can be one of the following. RUNNABLE: The instance is running, or is ready to run when accessed. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed. UNKNOWN_STATE: The state of the instance is unknown. */ - state?: string; + state?: string | null; /** * If the instance state is SUSPENDED, the reason for the suspension. */ - suspensionReason?: string[]; + suspensionReason?: string[] | null; } /** * Database list response. @@ -476,7 +476,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#databasesList. */ - kind?: string; + kind?: string | null; } /** * Read-replica configuration for connecting to the on-premises master. @@ -485,7 +485,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#demoteMasterConfiguration. */ - kind?: string; + kind?: string | null; /** * MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. */ @@ -498,11 +498,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#demoteMasterContext. */ - kind?: string; + kind?: string | null; /** * The name of the instance which will act as on-premises master in the replication setup. */ - masterInstanceName?: string; + masterInstanceName?: string | null; /** * Configuration specific to read-replicas replicating from the on-premises master. */ @@ -510,7 +510,7 @@ export namespace sqladmin_v1beta4 { /** * Verify GTID consistency for demote operation. Default value: True. Second Generation instances only. Setting this flag to false enables you to bypass GTID consistency check between on-premises master and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues. */ - verifyGtidConsistency?: boolean; + verifyGtidConsistency?: boolean | null; } /** * Read-replica configuration specific to MySQL databases. @@ -519,27 +519,27 @@ export namespace sqladmin_v1beta4 { /** * PEM representation of the trusted CA's x509 certificate. */ - caCertificate?: string; + caCertificate?: string | null; /** * PEM representation of the slave's x509 certificate. */ - clientCertificate?: string; + clientCertificate?: string | null; /** * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. The format of the slave's private key can be either PKCS #1 or PKCS #8. */ - clientKey?: string; + clientKey?: string | null; /** * This is always sql#demoteMasterMysqlReplicaConfiguration. */ - kind?: string; + kind?: string | null; /** * The password for the replication connection. */ - password?: string; + password?: string | null; /** * The username for the replication connection. */ - username?: string; + username?: string | null; } /** * Disk encryption configuration. @@ -548,11 +548,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#diskEncryptionConfiguration. */ - kind?: string; + kind?: string | null; /** * KMS key resource name */ - kmsKeyName?: string; + kmsKeyName?: string | null; } /** * Disk encryption status. @@ -561,11 +561,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#diskEncryptionStatus. */ - kind?: string; + kind?: string | null; /** * KMS key version used to encrypt the Cloud SQL instance disk */ - kmsKeyVersionName?: string; + kmsKeyVersionName?: string | null; } /** * Database instance export context. @@ -574,19 +574,19 @@ export namespace sqladmin_v1beta4 { /** * Options for exporting data as CSV. */ - csvExportOptions?: {selectQuery?: string}; + csvExportOptions?: {selectQuery?: string} | null; /** * Databases to be exported. MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. PostgreSQL instances: Specify exactly one database to be exported. If fileType is CSV, this database must match the database used in the csvExportOptions.selectQuery property. */ - databases?: string[]; + databases?: string[] | null; /** * The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data. */ - fileType?: string; + fileType?: string | null; /** * This is always sql#exportContext. */ - kind?: string; + kind?: string | null; /** * Options for exporting data as SQL statements. */ @@ -594,11 +594,11 @@ export namespace sqladmin_v1beta4 { mysqlExportOptions?: {masterData?: number}; schemaOnly?: boolean; tables?: string[]; - }; + } | null; /** * The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the requests succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed. */ - uri?: string; + uri?: string | null; } /** * Database instance failover context. @@ -607,11 +607,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#failoverContext. */ - kind?: string; + kind?: string | null; /** * The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. */ - settingsVersion?: string; + settingsVersion?: string | null; } /** * A flag resource. @@ -620,39 +620,39 @@ export namespace sqladmin_v1beta4 { /** * For STRING flags, a list of strings that the value can be set to. */ - allowedStringValues?: string[]; + allowedStringValues?: string[] | null; /** * The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation instances. */ - appliesTo?: string[]; + appliesTo?: string[] | null; /** * True if the flag is only released in Beta. */ - inBeta?: boolean; + inBeta?: boolean | null; /** * This is always sql#flag. */ - kind?: string; + kind?: string | null; /** * For INTEGER flags, the maximum allowed value. */ - maxValue?: string; + maxValue?: string | null; /** * For INTEGER flags, the minimum allowed value. */ - minValue?: string; + minValue?: string | null; /** * This is the name of the flag. Flag names always use underscores, not hyphens, e.g. max_allowed_packet */ - name?: string; + name?: string | null; /** * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. */ - requiresRestart?: boolean; + requiresRestart?: boolean | null; /** * The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables. */ - type?: string; + type?: string | null; } /** * Flags list response. @@ -665,7 +665,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#flagsList. */ - kind?: string; + kind?: string | null; } /** * Database instance import context. @@ -680,31 +680,31 @@ export namespace sqladmin_v1beta4 { pvkPassword?: string; pvkPath?: string; }; - }; + } | null; /** * Options for importing data as CSV. */ - csvImportOptions?: {columns?: string[]; table?: string}; + csvImportOptions?: {columns?: string[]; table?: string} | null; /** * The target database for the import. If fileType is SQL, 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 fileType is CSV, one database must be specified. */ - database?: string; + database?: string | null; /** * The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data. */ - fileType?: string; + fileType?: string | null; /** * The PostgreSQL user for this import operation. PostgreSQL instances only. */ - importUser?: string; + importUser?: string | null; /** * This is always sql#importContext. */ - kind?: string; + kind?: string | null; /** * Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file. */ - uri?: string; + uri?: string | null; } /** * Database instance clone request. @@ -762,11 +762,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#instancesList. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of warnings that ocurred while handling the request. */ @@ -776,7 +776,7 @@ export namespace sqladmin_v1beta4 { * Instances ListServerCas response. */ export interface Schema$InstancesListServerCasResponse { - activeVersion?: string; + activeVersion?: string | null; /** * List of server CA certificates for the instance. */ @@ -784,7 +784,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#instancesListServerCas. */ - kind?: string; + kind?: string | null; } /** * Database instance restore backup request. @@ -824,15 +824,15 @@ export namespace sqladmin_v1beta4 { /** * Whether the instance should be assigned an IP address or not. */ - ipv4Enabled?: boolean; + ipv4Enabled?: boolean | null; /** * The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set. */ - privateNetwork?: string; + privateNetwork?: string | null; /** * Whether SSL connections over IP should be enforced or not. */ - requireSsl?: boolean; + requireSsl?: boolean | null; } /** * Database instance IP Mapping. @@ -841,15 +841,15 @@ export namespace sqladmin_v1beta4 { /** * The IP address assigned. */ - ipAddress?: string; + ipAddress?: string | null; /** * The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired. */ - timeToRetire?: string; + timeToRetire?: string | null; /** * The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported. */ - type?: string; + type?: string | null; } /** * Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. @@ -858,15 +858,15 @@ export namespace sqladmin_v1beta4 { /** * The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. */ - followGaeApplication?: string; + followGaeApplication?: string | null; /** * This is always sql#locationPreference. */ - kind?: string; + kind?: string | null; /** * The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). */ - zone?: string; + zone?: string | null; } /** * Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance purposes. @@ -875,19 +875,19 @@ export namespace sqladmin_v1beta4 { /** * day of week (1-7), starting on Monday. */ - day?: number; + day?: number | null; /** * hour of day - 0 to 23. */ - hour?: number; + hour?: number | null; /** * This is always sql#maintenanceWindow. */ - kind?: string; + kind?: string | null; /** * Maintenance timing setting: canary (Earlier) or stable (Later). Learn more. */ - updateTrack?: string; + updateTrack?: string | null; } /** * Read-replica configuration specific to MySQL databases. @@ -896,47 +896,47 @@ export namespace sqladmin_v1beta4 { /** * PEM representation of the trusted CA's x509 certificate. */ - caCertificate?: string; + caCertificate?: string | null; /** * PEM representation of the slave's x509 certificate. */ - clientCertificate?: string; + clientCertificate?: string | null; /** * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. */ - clientKey?: string; + clientKey?: string | null; /** * Seconds to wait between connect retries. MySQL's default is 60 seconds. */ - connectRetryInterval?: number; + connectRetryInterval?: number | null; /** * Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump. */ - dumpFilePath?: string; + dumpFilePath?: string | null; /** * This is always sql#mysqlReplicaConfiguration. */ - kind?: string; + kind?: string | null; /** * Interval in milliseconds between replication heartbeats. */ - masterHeartbeatPeriod?: string; + masterHeartbeatPeriod?: string | null; /** * The password for the replication connection. */ - password?: string; + password?: string | null; /** * A list of permissible ciphers to use for SSL encryption. */ - sslCipher?: string; + sslCipher?: string | null; /** * The username for the replication connection. */ - username?: string; + username?: string | null; /** * Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. */ - verifyServerCertificate?: boolean; + verifyServerCertificate?: boolean | null; } /** * On-premises instance configuration. @@ -945,11 +945,11 @@ export namespace sqladmin_v1beta4 { /** * The host and port of the on-premises instance in host:port format */ - hostPort?: string; + hostPort?: string | null; /** * This is always sql#onPremisesConfiguration. */ - kind?: string; + kind?: string | null; } /** * An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. @@ -958,7 +958,7 @@ export namespace sqladmin_v1beta4 { /** * The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - endTime?: string; + endTime?: string | null; /** * If errors occurred during processing of this operation, this field will be populated. */ @@ -974,44 +974,44 @@ export namespace sqladmin_v1beta4 { /** * The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - insertTime?: string; + insertTime?: string | null; /** * This is always sql#operation. */ - kind?: string; + kind?: string | null; /** * An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. */ - name?: string; + name?: string | null; /** * The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE . */ - operationType?: string; + operationType?: string | null; /** * The URI of this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - startTime?: string; + startTime?: string | null; /** * The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN. */ - status?: string; + status?: string | null; /** * Name of the database instance related to this operation. */ - targetId?: string; - targetLink?: string; + targetId?: string | null; + targetLink?: string | null; /** * The project ID of the target instance related to this operation. */ - targetProject?: string; + targetProject?: string | null; /** * The email address of the user who initiated this operation. */ - user?: string; + user?: string | null; } /** * Database instance operation error. @@ -1020,15 +1020,15 @@ export namespace sqladmin_v1beta4 { /** * Identifies the specific error that occurred. */ - code?: string; + code?: string | null; /** * This is always sql#operationError. */ - kind?: string; + kind?: string | null; /** * Additional information about the error encountered. */ - message?: string; + message?: string | null; } /** * Database instance operation errors list wrapper. @@ -1041,7 +1041,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#operationErrors. */ - kind?: string; + kind?: string | null; } /** * Database instance list operations response. @@ -1054,11 +1054,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#operationsList. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Read-replica configuration for connecting to the master. @@ -1067,11 +1067,11 @@ export namespace sqladmin_v1beta4 { /** * Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. */ - failoverTarget?: boolean; + failoverTarget?: boolean | null; /** * This is always sql#replicaConfiguration. */ - kind?: string; + kind?: string | null; /** * MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. */ @@ -1084,19 +1084,19 @@ export namespace sqladmin_v1beta4 { /** * The ID of the backup run to restore from. */ - backupRunId?: string; + backupRunId?: string | null; /** * The ID of the instance that the backup was taken from. */ - instanceId?: string; + instanceId?: string | null; /** * This is always sql#restoreBackupContext. */ - kind?: string; + kind?: string | null; /** * The full project ID of the source instance. */ - project?: string; + project?: string | null; } /** * Instance rotate server CA context. @@ -1105,11 +1105,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#rotateServerCaContext. */ - kind?: string; + kind?: string | null; /** * The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version. */ - nextVersion?: string; + nextVersion?: string | null; } /** * Database instance settings. @@ -1118,15 +1118,15 @@ export namespace sqladmin_v1beta4 { /** * The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: ALWAYS: The instance is on, and remains so even in the absence of connection requests. NEVER: The instance is off; it is not activated, even if a connection request arrives. ON_DEMAND: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity. */ - activationPolicy?: string; + activationPolicy?: string | null; /** * The App Engine app IDs that can access this instance. First Generation instances only. */ - authorizedGaeApplications?: string[]; + authorizedGaeApplications?: string[] | null; /** * Availability type (PostgreSQL instances only). Potential values: ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. REGIONAL: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration. */ - availabilityType?: string; + availabilityType?: string | null; /** * The daily backup configuration for the instance. */ @@ -1134,7 +1134,7 @@ export namespace sqladmin_v1beta4 { /** * Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. */ - crashSafeReplicationEnabled?: boolean; + crashSafeReplicationEnabled?: boolean | null; /** * The database flags passed to the instance at startup. */ @@ -1142,15 +1142,15 @@ export namespace sqladmin_v1beta4 { /** * Configuration specific to read replica instances. Indicates whether replication is enabled or not. */ - databaseReplicationEnabled?: boolean; + databaseReplicationEnabled?: boolean | null; /** * The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. */ - dataDiskSizeGb?: string; + dataDiskSizeGb?: string | null; /** * The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances. */ - dataDiskType?: string; + dataDiskType?: string | null; /** * The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. */ @@ -1158,7 +1158,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#settings. */ - kind?: string; + kind?: string | null; /** * The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location is only applicable to First Generation instances. */ @@ -1170,31 +1170,31 @@ export namespace sqladmin_v1beta4 { /** * The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances. */ - pricingPlan?: string; + pricingPlan?: string | null; /** * The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances. */ - replicationType?: string; + replicationType?: string | null; /** * The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. */ - settingsVersion?: string; + settingsVersion?: string | null; /** * Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. */ - storageAutoResize?: boolean; + storageAutoResize?: boolean | null; /** * The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. */ - storageAutoResizeLimit?: string; + storageAutoResizeLimit?: string | null; /** * The tier (or machine type) for this instance, for example db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see Instance Settings. */ - tier?: string; + tier?: string | null; /** * User-provided labels, represented as a dictionary where each label is a single key value pair. */ - userLabels?: {[key: string]: string}; + userLabels?: {[key: string]: string} | null; } /** * SslCerts Resource @@ -1203,39 +1203,39 @@ export namespace sqladmin_v1beta4 { /** * PEM representation. */ - cert?: string; + cert?: string | null; /** * Serial number, as extracted from the certificate. */ - certSerialNumber?: string; + certSerialNumber?: string | null; /** * User supplied name. Constrained to [a-zA-Z.-_ ]+. */ - commonName?: string; + commonName?: string | null; /** * The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z */ - createTime?: string; + createTime?: string | null; /** * The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ - expirationTime?: string; + expirationTime?: string | null; /** * Name of the database instance. */ - instance?: string; + instance?: string | null; /** * This is always sql#sslCert. */ - kind?: string; + kind?: string | null; /** * The URI of this resource. */ - selfLink?: string; + selfLink?: string | null; /** * Sha1 Fingerprint. */ - sha1Fingerprint?: string; + sha1Fingerprint?: string | null; } /** * SslCertDetail. @@ -1248,7 +1248,7 @@ export namespace sqladmin_v1beta4 { /** * The private key for the client cert, in pem format. Keep private in order to protect your security. */ - certPrivateKey?: string; + certPrivateKey?: string | null; } /** * SslCerts create ephemeral certificate request. @@ -1257,7 +1257,7 @@ export namespace sqladmin_v1beta4 { /** * PEM encoded public key to include in the signed certificate. */ - public_key?: string; + public_key?: string | null; } /** * SslCerts insert request. @@ -1266,7 +1266,7 @@ export namespace sqladmin_v1beta4 { /** * User supplied name. Must be a distinct name from the other certificates for this instance. */ - commonName?: string; + commonName?: string | null; } /** * SslCert insert response. @@ -1279,7 +1279,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#sslCertsInsert. */ - kind?: string; + kind?: string | null; /** * The operation to track the ssl certs insert request. */ @@ -1300,7 +1300,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#sslCertsList. */ - kind?: string; + kind?: string | null; } /** * A Google Cloud SQL service tier resource. @@ -1309,23 +1309,23 @@ export namespace sqladmin_v1beta4 { /** * The maximum disk size of this tier in bytes. */ - DiskQuota?: string; + DiskQuota?: string | null; /** * This is always sql#tier. */ - kind?: string; + kind?: string | null; /** * The maximum RAM usage of this tier in bytes. */ - RAM?: string; + RAM?: string | null; /** * The applicable regions for this tier. */ - region?: string[]; + region?: string[] | null; /** * An identifier for the machine type, for example, db-n1-standard-1. For related information, see Pricing. */ - tier?: string; + tier?: string | null; } /** * Tiers list response. @@ -1338,7 +1338,7 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#tiersList. */ - kind?: string; + kind?: string | null; } /** * Database Instance truncate log context. @@ -1347,11 +1347,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#truncateLogContext. */ - kind?: string; + kind?: string | null; /** * The type of log to truncate. Valid values are MYSQL_GENERAL_TABLE and MYSQL_SLOW_TABLE. */ - logType?: string; + logType?: string | null; } /** * A Cloud SQL user resource. @@ -1360,31 +1360,31 @@ export namespace sqladmin_v1beta4 { /** * This field is deprecated and will be removed from a future version of the API. */ - etag?: string; + etag?: string | null; /** * The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. */ - host?: string; + host?: string | null; /** * The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL. */ - instance?: string; + instance?: string | null; /** * This is always sql#user. */ - kind?: string; + kind?: string | null; /** * The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified in the URL. */ - name?: string; + name?: string | null; /** * The password for the user. */ - password?: string; + password?: string | null; /** * The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL. */ - project?: string; + project?: string | null; } /** * User list response. @@ -1397,11 +1397,11 @@ export namespace sqladmin_v1beta4 { /** * This is always sql#usersList. */ - kind?: string; + kind?: string | null; /** * An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. */ - nextPageToken?: string; + nextPageToken?: string | null; } export class Resource$Backupruns { diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index c0946f3f4f4..1a7d0a02daf 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -132,7 +132,7 @@ export namespace storage_v1 { /** * The bucket's billing configuration. */ - billing?: {requesterPays?: boolean}; + billing?: {requesterPays?: boolean} | null; /** * The bucket's Cross-Origin Resource Sharing (CORS) configuration. */ @@ -141,11 +141,11 @@ export namespace storage_v1 { method?: string[]; origin?: string[]; responseHeader?: string[]; - }>; + }> | null; /** * The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed. */ - defaultEventBasedHold?: boolean; + defaultEventBasedHold?: boolean | null; /** * Default access controls to apply to new objects when no ACL is provided. */ @@ -153,30 +153,30 @@ export namespace storage_v1 { /** * Encryption configuration for a bucket. */ - encryption?: {defaultKmsKeyName?: string}; + encryption?: {defaultKmsKeyName?: string} | null; /** * HTTP 1.1 Entity tag for the bucket. */ - etag?: string; + etag?: string | null; /** * The bucket's IAM configuration. */ iamConfiguration?: { bucketPolicyOnly?: {enabled?: boolean; lockedTime?: string}; uniformBucketLevelAccess?: {enabled?: boolean; lockedTime?: string}; - }; + } | null; /** * The ID of the bucket. For buckets, the id and name properties are the same. */ - id?: string; + id?: string | null; /** * The kind of item this is. For buckets, this is always storage#bucket. */ - kind?: string; + kind?: string | null; /** * User-provided labels, in key/value pairs. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The bucket's lifecycle configuration. See lifecycle management for more information. */ @@ -192,35 +192,35 @@ export namespace storage_v1 { numNewerVersions?: number; }; }>; - }; + } | null; /** * The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. */ - location?: string; + location?: string | null; /** * The type of the bucket location. */ - locationType?: string; + locationType?: string | null; /** * The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. */ - logging?: {logBucket?: string; logObjectPrefix?: string}; + logging?: {logBucket?: string; logObjectPrefix?: string} | null; /** * The metadata generation of this bucket. */ - metageneration?: string; + metageneration?: string | null; /** * The name of the bucket. */ - name?: string; + name?: string | null; /** * The owner of the bucket. This is always the project team's owner group. */ - owner?: {entity?: string; entityId?: string}; + owner?: {entity?: string; entityId?: string} | null; /** * The project number of the project the bucket belongs to. */ - projectNumber?: string; + projectNumber?: string | null; /** * The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error. */ @@ -228,31 +228,31 @@ export namespace storage_v1 { effectiveTime?: string; isLocked?: boolean; retentionPeriod?: string; - }; + } | null; /** * The URI of this bucket. */ - selfLink?: string; + 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. */ - storageClass?: string; + storageClass?: string | null; /** * The creation time of the bucket in RFC 3339 format. */ - timeCreated?: string; + timeCreated?: string | null; /** * The modification time of the bucket in RFC 3339 format. */ - updated?: string; + updated?: string | null; /** * The bucket's versioning configuration. */ - versioning?: {enabled?: boolean}; + versioning?: {enabled?: boolean} | null; /** * The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. */ - website?: {mainPageSuffix?: string; notFoundPage?: string}; + website?: {mainPageSuffix?: string; notFoundPage?: string} | null; } /** * An access-control entry. @@ -261,47 +261,47 @@ export namespace storage_v1 { /** * The name of the bucket. */ - bucket?: string; + bucket?: string | null; /** * The domain associated with the entity, if any. */ - domain?: string; + domain?: string | null; /** * The email address associated with the entity, if any. */ - email?: string; + email?: string | null; /** * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ - entity?: string; + entity?: string | null; /** * The ID for the entity, if any. */ - entityId?: string; + entityId?: string | null; /** * HTTP 1.1 Entity tag for the access-control entry. */ - etag?: string; + etag?: string | null; /** * The ID of the access-control entry. */ - id?: string; + id?: string | null; /** * The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. */ - kind?: string; + kind?: string | null; /** * The project team associated with the entity, if any. */ - projectTeam?: {projectNumber?: string; team?: string}; + projectTeam?: {projectNumber?: string; team?: string} | null; /** * The access permission for the entity. */ - role?: string; + role?: string | null; /** * The link to this access-control entry. */ - selfLink?: string; + selfLink?: string | null; } /** * An access-control list. @@ -314,7 +314,7 @@ export namespace storage_v1 { /** * The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. */ - kind?: string; + kind?: string | null; } /** * A list of buckets. @@ -327,11 +327,11 @@ export namespace storage_v1 { /** * The kind of item this is. For lists of buckets, this is always storage#buckets. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An notification channel used to watch for resource changes. @@ -340,43 +340,43 @@ export namespace storage_v1 { /** * The address where notifications are delivered for this channel. */ - address?: string; + address?: string | null; /** * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ - expiration?: string; + expiration?: string | null; /** * A UUID or similar unique string that identifies this channel. */ - id?: string; + id?: string | null; /** * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ - kind?: string; + kind?: string | null; /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: {[key: string]: string}; + params?: {[key: string]: string} | null; /** * A Boolean value to indicate whether payload is wanted. Optional. */ - payload?: boolean; + payload?: boolean | null; /** * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ - resourceId?: string; + resourceId?: string | null; /** * A version-specific identifier for the watched resource. */ - resourceUri?: string; + resourceUri?: string | null; /** * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ - token?: string; + token?: string | null; /** * The type of delivery mechanism used for this channel. */ - type?: string; + type?: string | null; } /** * A Compose request. @@ -389,7 +389,7 @@ export namespace storage_v1 { /** * The kind of item this is. */ - kind?: string; + kind?: string | null; /** * The list of source objects that will be concatenated into a single object. */ @@ -397,7 +397,7 @@ export namespace storage_v1 { generation?: string; name?: string; objectPreconditions?: {ifGenerationMatch?: 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" @@ -406,19 +406,19 @@ export namespace storage_v1 { /** * 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; + 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; + 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; + 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; + title?: string | null; } /** * JSON template to produce a JSON-style HMAC Key resource for Create responses. @@ -427,7 +427,7 @@ export namespace storage_v1 { /** * The kind of item this is. For HMAC keys, this is always storage#hmacKey. */ - kind?: string; + kind?: string | null; /** * Key metadata. */ @@ -435,7 +435,7 @@ export namespace storage_v1 { /** * HMAC secret key material. */ - secret?: string; + secret?: string | null; } /** * JSON template to produce a JSON-style HMAC Key metadata resource. @@ -444,43 +444,43 @@ export namespace storage_v1 { /** * The ID of the HMAC Key. */ - accessId?: string; + accessId?: string | null; /** * HTTP 1.1 Entity tag for the HMAC key. */ - etag?: string; + etag?: string | null; /** * The ID of the HMAC key, including the Project ID and the Access ID. */ - id?: string; + id?: string | null; /** * The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata. */ - kind?: string; + kind?: string | null; /** * Project ID owning the service account to which the key authenticates. */ - projectId?: string; + projectId?: string | null; /** * The link to this resource. */ - selfLink?: string; + selfLink?: string | null; /** * The email address of the key's associated service account. */ - serviceAccountEmail?: string; + serviceAccountEmail?: string | null; /** * The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED. */ - state?: string; + state?: string | null; /** * The creation time of the HMAC key in RFC 3339 format. */ - timeCreated?: string; + timeCreated?: string | null; /** * The last modification time of the HMAC key metadata in RFC 3339 format. */ - updated?: string; + updated?: string | null; } /** * A list of hmacKeys. @@ -493,11 +493,11 @@ export namespace storage_v1 { /** * The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A subscription to receive Google PubSub notifications. @@ -506,39 +506,39 @@ export namespace storage_v1 { /** * An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription. */ - custom_attributes?: {[key: string]: string}; + custom_attributes?: {[key: string]: string} | null; /** * HTTP 1.1 Entity tag for this subscription notification. */ - etag?: string; + etag?: string | null; /** * If present, only send notifications about listed event types. If empty, sent notifications for all event types. */ - event_types?: string[]; + event_types?: string[] | null; /** * The ID of the notification. */ - id?: string; + id?: string | null; /** * The kind of item this is. For notifications, this is always storage#notification. */ - kind?: string; + kind?: string | null; /** * If present, only apply this notification configuration to object names that begin with this prefix. */ - object_name_prefix?: string; + object_name_prefix?: string | null; /** * The desired content of the Payload. */ - payload_format?: string; + payload_format?: string | null; /** * The canonical URL of this notification. */ - selfLink?: string; + selfLink?: string | null; /** * The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' */ - topic?: string; + topic?: string | null; } /** * A list of notification subscriptions. @@ -551,7 +551,7 @@ export namespace storage_v1 { /** * The kind of item this is. For lists of notifications, this is always storage#notifications. */ - kind?: string; + kind?: string | null; } /** * An object. @@ -564,123 +564,126 @@ export namespace storage_v1 { /** * The name of the bucket containing this object. */ - bucket?: string; + bucket?: string | null; /** * Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. */ - cacheControl?: string; + cacheControl?: string | null; /** * Number of underlying components that make up this object. Components are accumulated by compose operations. */ - componentCount?: number; + componentCount?: number | null; /** * Content-Disposition of the object data. */ - contentDisposition?: string; + contentDisposition?: string | null; /** * Content-Encoding of the object data. */ - contentEncoding?: string; + contentEncoding?: string | null; /** * Content-Language of the object data. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. */ - contentType?: string; + contentType?: string | null; /** * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. */ - crc32c?: string; + crc32c?: string | null; /** * Metadata of customer-supplied encryption key, if the object is encrypted by such a key. */ - customerEncryption?: {encryptionAlgorithm?: string; keySha256?: string}; + customerEncryption?: { + encryptionAlgorithm?: string; + keySha256?: string; + } | null; /** * HTTP 1.1 Entity tag for the object. */ - etag?: string; + etag?: string | null; /** * Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. */ - eventBasedHold?: boolean; + eventBasedHold?: boolean | null; /** * The content generation of this object. Used for object versioning. */ - generation?: string; + generation?: string | null; /** * The ID of the object, including the bucket name, object name, and generation number. */ - id?: string; + id?: string | null; /** * The kind of item this is. For objects, this is always storage#object. */ - kind?: string; + kind?: string | null; /** * Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. */ - kmsKeyName?: string; + kmsKeyName?: string | null; /** * MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. */ - md5Hash?: string; + md5Hash?: string | null; /** * Media download link. */ - mediaLink?: string; + mediaLink?: string | null; /** * User-provided metadata, in key/value pairs. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. */ - metageneration?: string; + metageneration?: string | null; /** * The name of the object. Required if not specified by URL parameter. */ - name?: string; + name?: string | null; /** * The owner of the object. This will always be the uploader of the object. */ - owner?: {entity?: string; entityId?: string}; + owner?: {entity?: string; entityId?: string} | null; /** * A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold). */ - retentionExpirationTime?: string; + retentionExpirationTime?: string | null; /** * The link to this object. */ - selfLink?: string; + selfLink?: string | null; /** * Content-Length of the data in bytes. */ - size?: string; + size?: string | null; /** * Storage class of the object. */ - storageClass?: string; + storageClass?: string | null; /** * Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object. */ - temporaryHold?: boolean; + temporaryHold?: boolean | null; /** * The creation time of the object in RFC 3339 format. */ - timeCreated?: string; + timeCreated?: string | null; /** * The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. */ - timeDeleted?: string; + timeDeleted?: string | null; /** * The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. */ - timeStorageClassUpdated?: string; + timeStorageClassUpdated?: string | null; /** * The modification time of the object metadata in RFC 3339 format. */ - updated?: string; + updated?: string | null; } /** * An access-control entry. @@ -689,55 +692,55 @@ export namespace storage_v1 { /** * The name of the bucket. */ - bucket?: string; + bucket?: string | null; /** * The domain associated with the entity, if any. */ - domain?: string; + domain?: string | null; /** * The email address associated with the entity, if any. */ - email?: string; + email?: string | null; /** * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ - entity?: string; + entity?: string | null; /** * The ID for the entity, if any. */ - entityId?: string; + entityId?: string | null; /** * HTTP 1.1 Entity tag for the access-control entry. */ - etag?: string; + etag?: string | null; /** * The content generation of the object, if applied to an object. */ - generation?: string; + generation?: string | null; /** * The ID of the access-control entry. */ - id?: string; + id?: string | null; /** * The kind of item this is. For object access control entries, this is always storage#objectAccessControl. */ - kind?: string; + kind?: string | null; /** * The name of the object, if applied to an object. */ - object?: string; + object?: string | null; /** * The project team associated with the entity, if any. */ - projectTeam?: {projectNumber?: string; team?: string}; + projectTeam?: {projectNumber?: string; team?: string} | null; /** * The access permission for the entity. */ - role?: string; + role?: string | null; /** * The link to this access-control entry. */ - selfLink?: string; + selfLink?: string | null; } /** * An access-control list. @@ -750,7 +753,7 @@ export namespace storage_v1 { /** * The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. */ - kind?: string; + kind?: string | null; } /** * A list of objects. @@ -763,15 +766,15 @@ export namespace storage_v1 { /** * The kind of item this is. For lists of objects, this is always storage#objects. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. */ - prefixes?: string[]; + prefixes?: string[] | null; } /** * A bucket/object IAM policy. @@ -784,23 +787,23 @@ export namespace storage_v1 { condition?: Schema$Expr; members?: string[]; role?: string; - }>; + }> | null; /** * HTTP 1.1 Entity tag for the policy. */ - etag?: string; + etag?: string | null; /** * The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. */ - kind?: string; + kind?: string | null; /** * The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. */ - resourceId?: string; + resourceId?: string | null; /** * The IAM policy format version. */ - version?: number; + version?: number | null; } /** * A rewrite response. @@ -809,15 +812,15 @@ export namespace storage_v1 { /** * true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response. */ - done?: boolean; + done?: boolean | null; /** * The kind of item this is. */ - kind?: string; + kind?: string | null; /** * The total size of the object being copied in bytes. This property is always present in the response. */ - objectSize?: string; + objectSize?: string | null; /** * A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes. */ @@ -825,11 +828,11 @@ export namespace storage_v1 { /** * A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy. */ - rewriteToken?: string; + rewriteToken?: string | null; /** * The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response. */ - totalBytesRewritten?: string; + totalBytesRewritten?: string | null; } /** * A subscription to receive Google PubSub notifications. @@ -838,11 +841,11 @@ export namespace storage_v1 { /** * The ID of the notification. */ - email_address?: string; + email_address?: string | null; /** * The kind of item this is. For notifications, this is always storage#notification. */ - kind?: string; + kind?: string | null; } /** * A storage.(buckets|objects).testIamPermissions response. @@ -851,11 +854,11 @@ export namespace storage_v1 { /** * The kind of item this is. */ - kind?: string; + kind?: string | null; /** * The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows: - storage.buckets.delete — Delete bucket. - storage.buckets.get — Read bucket metadata. - storage.buckets.getIamPolicy — Read bucket IAM policy. - storage.buckets.create — Create bucket. - storage.buckets.list — List buckets. - storage.buckets.setIamPolicy — Update bucket IAM policy. - storage.buckets.update — Update bucket metadata. - storage.objects.delete — Delete object. - storage.objects.get — Read object data and metadata. - storage.objects.getIamPolicy — Read object IAM policy. - storage.objects.create — Create object. - storage.objects.list — List objects. - storage.objects.setIamPolicy — Update object IAM policy. - storage.objects.update — Update object metadata. */ - permissions?: string[]; + permissions?: string[] | null; } export class Resource$Bucketaccesscontrols { diff --git a/src/apis/storage/v1beta1.ts b/src/apis/storage/v1beta1.ts index c9ffb5c5292..ab9a3c1f59f 100644 --- a/src/apis/storage/v1beta1.ts +++ b/src/apis/storage/v1beta1.ts @@ -126,35 +126,35 @@ export namespace storage_v1beta1 { /** * The name of the bucket. */ - id?: string; + id?: string | null; /** * The kind of item this is. For buckets, this is always storage#bucket. */ - kind?: string; + kind?: string | null; /** * The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. */ - location?: string; + location?: string | null; /** * The owner of the bucket. This will always be the project team's owner group. */ - owner?: {entity?: string; entityId?: string}; + owner?: {entity?: string; entityId?: string} | null; /** * The project the bucket belongs to. */ - projectId?: string; + projectId?: string | null; /** * The URI of this bucket. */ - selfLink?: string; + selfLink?: string | null; /** * Creation time of the bucket in RFC 3339 format. */ - timeCreated?: string; + timeCreated?: string | null; /** * The bucket's website configuration. */ - website?: {mainPageSuffix?: string; notFoundPage?: string}; + website?: {mainPageSuffix?: string; notFoundPage?: string} | null; } /** * An access-control entry. @@ -163,39 +163,39 @@ export namespace storage_v1beta1 { /** * The name of the bucket. */ - bucket?: string; + bucket?: string | null; /** * The domain associated with the entity, if any. */ - domain?: string; + domain?: string | null; /** * The email address associated with the entity, if any. */ - email?: string; + email?: string | null; /** * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ - entity?: string; + entity?: string | null; /** * The ID for the entity, if any. */ - entityId?: string; + entityId?: string | null; /** * The ID of the access-control entry. */ - id?: string; + id?: string | null; /** * The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. */ - kind?: string; + kind?: string | null; /** * The access permission for the entity. Can be READER, WRITER, or OWNER. */ - role?: string; + role?: string | null; /** * The link to this access-control entry. */ - selfLink?: string; + selfLink?: string | null; } /** * An access-control list. @@ -208,7 +208,7 @@ export namespace storage_v1beta1 { /** * The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. */ - kind?: string; + kind?: string | null; } /** * A list of buckets. @@ -221,11 +221,11 @@ export namespace storage_v1beta1 { /** * The kind of item this is. For lists of buckets, this is always storage#buckets. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An object. @@ -238,31 +238,31 @@ export namespace storage_v1beta1 { /** * The bucket containing this object. */ - bucket?: string; + bucket?: string | null; /** * Cache-Control directive for the object data. */ - cacheControl?: string; + cacheControl?: string | null; /** * Content-Disposition of the object data. */ - contentDisposition?: string; + contentDisposition?: string | null; /** * Content-Encoding of the object data. */ - contentEncoding?: string; + contentEncoding?: string | null; /** * Content-Language of the object data. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * The ID of the object. */ - id?: string; + id?: string | null; /** * The kind of item this is. For objects, this is always storage#object. */ - kind?: string; + kind?: string | null; /** * Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. */ @@ -274,23 +274,23 @@ export namespace storage_v1beta1 { length?: string; link?: string; timeCreated?: string; - }; + } | null; /** * User-provided metadata, in key/value pairs. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * The name of this object. Required if not specified by URL parameter. */ - name?: string; + name?: string | null; /** * The owner of the object. This will always be the uploader of the object. */ - owner?: {entity?: string; entityId?: string}; + owner?: {entity?: string; entityId?: string} | null; /** * The link to this object. */ - selfLink?: string; + selfLink?: string | null; } /** * An access-control entry. @@ -299,43 +299,43 @@ export namespace storage_v1beta1 { /** * The name of the bucket. */ - bucket?: string; + bucket?: string | null; /** * The domain associated with the entity, if any. */ - domain?: string; + domain?: string | null; /** * The email address associated with the entity, if any. */ - email?: string; + email?: string | null; /** * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ - entity?: string; + entity?: string | null; /** * The ID for the entity, if any. */ - entityId?: string; + entityId?: string | null; /** * The ID of the access-control entry. */ - id?: string; + id?: string | null; /** * The kind of item this is. For object access control entries, this is always storage#objectAccessControl. */ - kind?: string; + kind?: string | null; /** * The name of the object. */ - object?: string; + object?: string | null; /** * The access permission for the entity. Can be READER or OWNER. */ - role?: string; + role?: string | null; /** * The link to this access-control entry. */ - selfLink?: string; + selfLink?: string | null; } /** * An access-control list. @@ -348,7 +348,7 @@ export namespace storage_v1beta1 { /** * The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. */ - kind?: string; + kind?: string | null; } /** * A list of objects. @@ -361,15 +361,15 @@ export namespace storage_v1beta1 { /** * The kind of item this is. For lists of objects, this is always storage#objects. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. */ - prefixes?: string[]; + prefixes?: string[] | null; } export class Resource$Bucketaccesscontrols { diff --git a/src/apis/storage/v1beta2.ts b/src/apis/storage/v1beta2.ts index eb2d2b9a198..406f47f0cc8 100644 --- a/src/apis/storage/v1beta2.ts +++ b/src/apis/storage/v1beta2.ts @@ -133,7 +133,7 @@ export namespace storage_v1beta2 { method?: string[]; origin?: string[]; responseHeader?: string[]; - }>; + }> | null; /** * Default access controls to apply to new objects when no ACL is provided. */ @@ -141,15 +141,15 @@ export namespace storage_v1beta2 { /** * HTTP 1.1 Entity tag for the bucket. */ - etag?: string; + etag?: string | null; /** * The ID of the bucket. */ - id?: string; + id?: string | null; /** * The kind of item this is. For buckets, this is always storage#bucket. */ - kind?: string; + kind?: string | null; /** * The bucket's lifecycle configuration. See object lifecycle management for more information. */ @@ -163,47 +163,47 @@ export namespace storage_v1beta2 { numNewerVersions?: number; }; }>; - }; + } | null; /** * The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. */ - location?: string; + location?: string | null; /** * The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. */ - logging?: {logBucket?: string; logObjectPrefix?: string}; + logging?: {logBucket?: string; logObjectPrefix?: string} | null; /** * The metadata generation of this bucket. */ - metageneration?: string; + metageneration?: string | null; /** * The name of the bucket. */ - name?: string; + name?: string | null; /** * The owner of the bucket. This is always the project team's owner group. */ - owner?: {entity?: string; entityId?: string}; + owner?: {entity?: string; entityId?: string} | null; /** * The URI of this bucket. */ - selfLink?: string; + selfLink?: string | null; /** * The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. */ - storageClass?: string; + storageClass?: string | null; /** * Creation time of the bucket in RFC 3339 format. */ - timeCreated?: string; + timeCreated?: string | null; /** * The bucket's versioning configuration. */ - versioning?: {enabled?: boolean}; + versioning?: {enabled?: boolean} | null; /** * The bucket's website configuration. */ - website?: {mainPageSuffix?: string; notFoundPage?: string}; + website?: {mainPageSuffix?: string; notFoundPage?: string} | null; } /** * An access-control entry. @@ -212,43 +212,43 @@ export namespace storage_v1beta2 { /** * The name of the bucket. */ - bucket?: string; + bucket?: string | null; /** * The domain associated with the entity, if any. */ - domain?: string; + domain?: string | null; /** * The email address associated with the entity, if any. */ - email?: string; + email?: string | null; /** * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ - entity?: string; + entity?: string | null; /** * The ID for the entity, if any. */ - entityId?: string; + entityId?: string | null; /** * HTTP 1.1 Entity tag for the access-control entry. */ - etag?: string; + etag?: string | null; /** * The ID of the access-control entry. */ - id?: string; + id?: string | null; /** * The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. */ - kind?: string; + kind?: string | null; /** * The access permission for the entity. Can be READER, WRITER, or OWNER. */ - role?: string; + role?: string | null; /** * The link to this access-control entry. */ - selfLink?: string; + selfLink?: string | null; } /** * An access-control list. @@ -261,7 +261,7 @@ export namespace storage_v1beta2 { /** * The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. */ - kind?: string; + kind?: string | null; } /** * A list of buckets. @@ -274,11 +274,11 @@ export namespace storage_v1beta2 { /** * The kind of item this is. For lists of buckets, this is always storage#buckets. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * An notification channel used to watch for resource changes. @@ -287,43 +287,43 @@ export namespace storage_v1beta2 { /** * The address where notifications are delivered for this channel. */ - address?: string; + address?: string | null; /** * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ - expiration?: string; + expiration?: string | null; /** * A UUID or similar unique string that identifies this channel. */ - id?: string; + id?: string | null; /** * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ - kind?: string; + kind?: string | null; /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: {[key: string]: string}; + params?: {[key: string]: string} | null; /** * A Boolean value to indicate whether payload is wanted. Optional. */ - payload?: boolean; + payload?: boolean | null; /** * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ - resourceId?: string; + resourceId?: string | null; /** * A version-specific identifier for the watched resource. */ - resourceUri?: string; + resourceUri?: string | null; /** * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ - token?: string; + token?: string | null; /** * The type of delivery mechanism used for this channel. */ - type?: string; + type?: string | null; } /** * A Compose request. @@ -336,7 +336,7 @@ export namespace storage_v1beta2 { /** * The kind of item this is. */ - kind?: string; + kind?: string | null; /** * The list of source objects that will be concatenated into a single object. */ @@ -344,7 +344,7 @@ export namespace storage_v1beta2 { generation?: string; name?: string; objectPreconditions?: {ifGenerationMatch?: string}; - }>; + }> | null; } /** * An object. @@ -357,95 +357,95 @@ export namespace storage_v1beta2 { /** * The bucket containing this object. */ - bucket?: string; + bucket?: string | null; /** * Cache-Control directive for the object data. */ - cacheControl?: string; + cacheControl?: string | null; /** * Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. */ - componentCount?: number; + componentCount?: number | null; /** * Content-Disposition of the object data. */ - contentDisposition?: string; + contentDisposition?: string | null; /** * Content-Encoding of the object data. */ - contentEncoding?: string; + contentEncoding?: string | null; /** * Content-Language of the object data. */ - contentLanguage?: string; + contentLanguage?: string | null; /** * Content-Type of the object data. */ - contentType?: string; + contentType?: string | null; /** * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. */ - crc32c?: string; + crc32c?: string | null; /** * HTTP 1.1 Entity tag for the object. */ - etag?: string; + etag?: string | null; /** * The content generation of this object. Used for object versioning. */ - generation?: string; + generation?: string | null; /** * The ID of the object. */ - id?: string; + id?: string | null; /** * The kind of item this is. For objects, this is always storage#object. */ - kind?: string; + kind?: string | null; /** * MD5 hash of the data; encoded using base64. */ - md5Hash?: string; + md5Hash?: string | null; /** * Media download link. */ - mediaLink?: string; + mediaLink?: string | null; /** * User-provided metadata, in key/value pairs. */ - metadata?: {[key: string]: string}; + metadata?: {[key: string]: string} | null; /** * The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. */ - metageneration?: string; + metageneration?: string | null; /** * The name of this object. Required if not specified by URL parameter. */ - name?: string; + name?: string | null; /** * The owner of the object. This will always be the uploader of the object. */ - owner?: {entity?: string; entityId?: string}; + owner?: {entity?: string; entityId?: string} | null; /** * The link to this object. */ - selfLink?: string; + selfLink?: string | null; /** * Content-Length of the data in bytes. */ - size?: string; + size?: string | null; /** * Storage class of the object. */ - storageClass?: string; + storageClass?: string | null; /** * Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. */ - timeDeleted?: string; + timeDeleted?: string | null; /** * Modification time of the object metadata in RFC 3339 format. */ - updated?: string; + updated?: string | null; } /** * An access-control entry. @@ -454,51 +454,51 @@ export namespace storage_v1beta2 { /** * The name of the bucket. */ - bucket?: string; + bucket?: string | null; /** * The domain associated with the entity, if any. */ - domain?: string; + domain?: string | null; /** * The email address associated with the entity, if any. */ - email?: string; + email?: string | null; /** * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ - entity?: string; + entity?: string | null; /** * The ID for the entity, if any. */ - entityId?: string; + entityId?: string | null; /** * HTTP 1.1 Entity tag for the access-control entry. */ - etag?: string; + etag?: string | null; /** * The content generation of the object. */ - generation?: string; + generation?: string | null; /** * The ID of the access-control entry. */ - id?: string; + id?: string | null; /** * The kind of item this is. For object access control entries, this is always storage#objectAccessControl. */ - kind?: string; + kind?: string | null; /** * The name of the object. */ - object?: string; + object?: string | null; /** * The access permission for the entity. Can be READER or OWNER. */ - role?: string; + role?: string | null; /** * The link to this access-control entry. */ - selfLink?: string; + selfLink?: string | null; } /** * An access-control list. @@ -507,11 +507,11 @@ export namespace storage_v1beta2 { /** * The list of items. */ - items?: any[]; + items?: any[] | null; /** * The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. */ - kind?: string; + kind?: string | null; } /** * A list of objects. @@ -524,15 +524,15 @@ export namespace storage_v1beta2 { /** * The kind of item this is. For lists of objects, this is always storage#objects. */ - kind?: string; + kind?: string | null; /** * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. */ - prefixes?: string[]; + prefixes?: string[] | null; } export class Resource$Bucketaccesscontrols { diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index f164b8fc131..0fc5f675053 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -130,11 +130,11 @@ export namespace storagetransfer_v1 { /** * Required. AWS access key ID. */ - accessKeyId?: string; + accessKeyId?: string | null; /** * Required. AWS secret access key. This field is not returned in RPC responses. */ - secretAccessKey?: string; + secretAccessKey?: string | null; } /** * An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name. @@ -147,7 +147,7 @@ export namespace storagetransfer_v1 { /** * Required. S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). */ - bucketName?: string; + bucketName?: 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 date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. @@ -156,15 +156,15 @@ export namespace storagetransfer_v1 { /** * 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; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -177,11 +177,11 @@ export namespace storagetransfer_v1 { /** * A list of messages that carry the error details. */ - errorDetails?: string[]; + errorDetails?: string[] | null; /** * Required. A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. */ - url?: string; + url?: string | null; } /** * A summary of errors by error code, plus a count and sample error log entries. @@ -190,11 +190,11 @@ export namespace storagetransfer_v1 { /** * Required. */ - errorCode?: string; + errorCode?: string | null; /** * Required. Count of this type of error. */ - errorCount?: string; + errorCount?: string | null; /** * Error samples. At most 5 error log entries will be recorded for a given error code for a single transfer operation. */ @@ -207,7 +207,7 @@ export namespace storagetransfer_v1 { /** * Required. Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/naming#requirements)). */ - bucketName?: string; + bucketName?: string | null; } /** * Google service account @@ -216,7 +216,7 @@ export namespace storagetransfer_v1 { /** * Email address of the service account. */ - accountEmail?: string; + accountEmail?: string | null; } /** * An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL - The location of the object. * Length - The size of the object in bytes. * MD5 - The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage/transfer/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/<URL-path>` is transferred to a data sink, the name of the object at the data sink is `<hostname>/<URL-path>`. * If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5) * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * [ObjectConditions](#ObjectConditions) have no effect when filtering objects to transfer. @@ -225,7 +225,7 @@ export namespace storagetransfer_v1 { /** * Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. */ - listUrl?: string; + listUrl?: string | null; } /** * The response message for Operations.ListOperations. @@ -234,7 +234,7 @@ export namespace storagetransfer_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -247,7 +247,7 @@ export namespace storagetransfer_v1 { /** * The list next page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of transfer jobs. */ @@ -260,19 +260,19 @@ export namespace storagetransfer_v1 { /** * `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 1000. */ - excludePrefixes?: string[]; + excludePrefixes?: string[] | null; /** * If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the `requests.gz` object in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 1000. */ - includePrefixes?: string[]; + includePrefixes?: string[] | null; /** * If specified, only objects with a `lastModificationTime` on or after `NOW` - `maxTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that, for each `TransferOperation` started by this `TransferJob`, `NOW` refers to the `start_time` of the 'TransferOperation`. Also, `lastModificationTime` refers to the time of the last change to the object's content or metadata - specifically, this would be the `updated` property of Cloud Storage objects and the `LastModified` field of S3 objects. */ - maxTimeElapsedSinceLastModification?: string; + maxTimeElapsedSinceLastModification?: string | null; /** * If specified, only objects with a `lastModificationTime` before `NOW` - `minTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that, for each `TransferOperation` started by this `TransferJob`, `NOW` refers to the `start_time` of the 'TransferOperation`. Also, `lastModificationTime` refers to the time of the last change to the object's content or metadata - specifically, this would be the `updated` property of Cloud Storage objects and the `LastModified` field of S3 objects. */ - minTimeElapsedSinceLastModification?: string; + minTimeElapsedSinceLastModification?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -281,7 +281,7 @@ export namespace storagetransfer_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -289,15 +289,15 @@ export namespace storagetransfer_v1 { /** * Represents the transfer operation object. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Request passed to PauseTransferOperation. @@ -312,15 +312,15 @@ export namespace storagetransfer_v1 { */ export interface Schema$Schedule { /** - * The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once. + * The last day a transfer runs. Date boundaries are determined relative to UTC time. A job will run once per 24 hours within the following guidelines: * If `scheduleEndDate` and `scheduleStartDate` are the same and in the future relative to UTC, the transfer is executed only one time. * If `scheduleEndDate` is later than `scheduleStartDate` and `scheduleEndDate` is in the future relative to UTC, the job will run each day at `startTimeOfDay` through `scheduleEndDate`. */ scheduleEndDate?: Schema$Date; /** - * Required. The first day the recurring transfer is scheduled to run. If `scheduleStartDate` is in the past, the transfer will run for the first time on the following day. + * Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If `scheduleStartDate` and `startTimeOfDay` are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request. Note: When starting jobs at or near midnight UTC it is possible that a job will start later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it will create a TransferJob with `scheduleStartDate` set to June 2 and a `startTimeOfDay` set to midnight UTC. The first scheduled TransferOperation will take place on June 3 at midnight UTC. */ scheduleStartDate?: Schema$Date; /** - * The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer's start time in a day is specified in your local timezone. + * The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If `startTimeOfDay` is not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through `scheduleEndDate`. If `startTimeOfDay` is specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, through `scheduleEndDate`. */ startTimeOfDay?: Schema$TimeOfDay; } @@ -331,15 +331,15 @@ export namespace storagetransfer_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. @@ -348,19 +348,19 @@ export namespace storagetransfer_v1 { /** * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ - hours?: number; + hours?: number | null; /** * Minutes of hour of day. Must be from 0 to 59. */ - minutes?: number; + minutes?: number | null; /** * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ - nanos?: number; + nanos?: number | null; /** * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ - seconds?: number; + seconds?: number | null; } /** * A collection of counters that report the progress of a transfer operation. @@ -369,67 +369,67 @@ export namespace storagetransfer_v1 { /** * Bytes that are copied to the data sink. */ - bytesCopiedToSink?: string; + bytesCopiedToSink?: string | null; /** * Bytes that are deleted from the data sink. */ - bytesDeletedFromSink?: string; + bytesDeletedFromSink?: string | null; /** * Bytes that are deleted from the data source. */ - bytesDeletedFromSource?: string; + bytesDeletedFromSource?: string | null; /** * Bytes that failed to be deleted from the data sink. */ - bytesFailedToDeleteFromSink?: string; + bytesFailedToDeleteFromSink?: string | null; /** * Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync. */ - bytesFoundFromSource?: string; + bytesFoundFromSource?: string | null; /** * Bytes found only in the data sink that are scheduled to be deleted. */ - bytesFoundOnlyFromSink?: string; + bytesFoundOnlyFromSink?: string | null; /** * Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred. */ - bytesFromSourceFailed?: string; + bytesFromSourceFailed?: string | null; /** * Bytes in the data source that are not transferred because they already exist in the data sink. */ - bytesFromSourceSkippedBySync?: string; + bytesFromSourceSkippedBySync?: string | null; /** * Objects that are copied to the data sink. */ - objectsCopiedToSink?: string; + objectsCopiedToSink?: string | null; /** * Objects that are deleted from the data sink. */ - objectsDeletedFromSink?: string; + objectsDeletedFromSink?: string | null; /** * Objects that are deleted from the data source. */ - objectsDeletedFromSource?: string; + objectsDeletedFromSource?: string | null; /** * Objects that failed to be deleted from the data sink. */ - objectsFailedToDeleteFromSink?: string; + objectsFailedToDeleteFromSink?: string | null; /** * Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync. */ - objectsFoundFromSource?: string; + objectsFoundFromSource?: string | null; /** * Objects found only in the data sink that are scheduled to be deleted. */ - objectsFoundOnlyFromSink?: string; + objectsFoundOnlyFromSink?: string | null; /** * Objects in the data source that failed to be transferred or that failed to be deleted after being transferred. */ - objectsFromSourceFailed?: string; + objectsFromSourceFailed?: string | null; /** * Objects in the data source that are not transferred because they already exist in the data sink. */ - objectsFromSourceSkippedBySync?: string; + objectsFromSourceSkippedBySync?: string | null; } /** * This resource represents the configuration of a transfer job that runs periodically. @@ -438,27 +438,27 @@ export namespace storagetransfer_v1 { /** * Output only. The time that the transfer job was created. */ - creationTime?: string; + creationTime?: string | null; /** * Output only. The time that the transfer job was deleted. */ - deletionTime?: string; + deletionTime?: string | null; /** * A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. */ - description?: string; + description?: string | null; /** * Output only. The time that the transfer job was last modified. */ - lastModificationTime?: string; + lastModificationTime?: string | null; /** * A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error. */ - name?: string; + name?: string | null; /** * The ID of the Google Cloud Platform Project that owns the job. */ - projectId?: string; + projectId?: string | null; /** * Schedule specification. */ @@ -466,7 +466,7 @@ export namespace storagetransfer_v1 { /** * Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation. */ - status?: string; + status?: string | null; /** * Transfer specification. */ @@ -483,7 +483,7 @@ export namespace storagetransfer_v1 { /** * End time of this transfer execution. */ - endTime?: string; + endTime?: string | null; /** * Summarizes errors encountered with sample error log entries. */ @@ -491,23 +491,23 @@ export namespace storagetransfer_v1 { /** * A globally unique ID assigned by the system. */ - name?: string; + name?: string | null; /** * The ID of the Google Cloud Platform Project that owns the operation. */ - projectId?: string; + projectId?: string | null; /** * Start time of this transfer execution. */ - startTime?: string; + startTime?: string | null; /** * Status of the transfer operation. */ - status?: string; + status?: string | null; /** * The name of the transfer job that triggers this transfer operation. */ - transferJobName?: string; + transferJobName?: string | null; /** * Transfer specification. */ @@ -520,15 +520,15 @@ export namespace storagetransfer_v1 { /** * Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and `deleteObjectsUniqueInSink` are mutually exclusive. */ - deleteObjectsFromSourceAfterTransfer?: boolean; + deleteObjectsFromSourceAfterTransfer?: boolean | null; /** * Whether objects that exist only in the sink should be deleted. Note that this option and `deleteObjectsFromSourceAfterTransfer` are mutually exclusive. */ - deleteObjectsUniqueInSink?: boolean; + deleteObjectsUniqueInSink?: boolean | null; /** * Whether overwriting objects that already exist in the sink is allowed. */ - overwriteObjectsAlreadyExistingInSink?: boolean; + overwriteObjectsAlreadyExistingInSink?: boolean | null; } /** * Configuration for running a transfer. @@ -566,7 +566,7 @@ export namespace storagetransfer_v1 { /** * Required. The ID of the Google Cloud Platform Console project that owns the job. */ - projectId?: string; + projectId?: string | null; /** * Required. The job to update. `transferJob` is expected to specify only three fields: `description`, `transferSpec`, and `status`. An UpdateTransferJobRequest that specifies other fields will be rejected with an error `INVALID_ARGUMENT`. */ @@ -574,7 +574,7 @@ export namespace storagetransfer_v1 { /** * The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: `description`, `transferSpec`, and `status`. To update the `transferSpec` of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error `INVALID_ARGUMENT`. */ - updateTransferJobFieldMask?: string; + updateTransferJobFieldMask?: string | null; } export class Resource$Googleserviceaccounts { diff --git a/src/apis/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index db93e9fd680..0effaa11345 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -126,7 +126,7 @@ export namespace streetviewpublish_v1 { /** * Required. IDs of the Photos. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=<id1>&photoIds=<id2>&...`. */ - photoIds?: string[]; + photoIds?: string[] | null; } /** * Response to batch delete of one or more Photos. @@ -184,11 +184,11 @@ export namespace streetviewpublish_v1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Level information containing level number and its corresponding name. @@ -197,11 +197,11 @@ export namespace streetviewpublish_v1 { /** * Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator. */ - name?: string; + name?: string | null; /** * Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK. */ - number?: number; + number?: number | null; } /** * Response to list all photos that belong to a user. @@ -210,7 +210,7 @@ export namespace streetviewpublish_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of photos. The pageSize field in the request determines the number of items returned. */ @@ -223,7 +223,7 @@ export namespace streetviewpublish_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -231,15 +231,15 @@ export namespace streetviewpublish_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Photo is used to store 360 photos along with photo metadata. @@ -248,7 +248,7 @@ export namespace streetviewpublish_v1 { /** * Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata. */ - captureTime?: string; + captureTime?: string | null; /** * Connections to other photos. A connection represents the link from this photo to another photo. */ @@ -256,11 +256,11 @@ export namespace streetviewpublish_v1 { /** * Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL. */ - downloadUrl?: string; + downloadUrl?: string | null; /** * Output only. Status in Google Maps, whether this photo was published or rejected. */ - mapsPublishStatus?: string; + mapsPublishStatus?: string | null; /** * Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google. */ @@ -276,15 +276,15 @@ export namespace streetviewpublish_v1 { /** * Output only. The share link for the photo. */ - shareLink?: string; + shareLink?: string | null; /** * Output only. The thumbnail URL for showing a preview of the given photo. */ - thumbnailUrl?: string; + thumbnailUrl?: string | null; /** * Output only. Status of rights transfer on this photo. */ - transferStatus?: string; + transferStatus?: string | null; /** * Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to. */ @@ -292,7 +292,7 @@ export namespace streetviewpublish_v1 { /** * Output only. View count of the photo. */ - viewCount?: string; + viewCount?: string | null; } /** * Identifier for a Photo. @@ -301,7 +301,7 @@ export namespace streetviewpublish_v1 { /** * Required. A unique identifier for a photo. */ - id?: string; + id?: string | null; } /** * Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos. @@ -323,15 +323,15 @@ export namespace streetviewpublish_v1 { /** * Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback. */ - languageCode?: string; + languageCode?: string | null; /** * Output-only. The name of the place, localized to the language_code. */ - name?: string; + name?: string | null; /** * Place identifier, as described in https://developers.google.com/places/place-id. */ - placeId?: string; + placeId?: string | null; } /** * Raw pose measurement for an entity. @@ -340,15 +340,15 @@ export namespace streetviewpublish_v1 { /** * The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. */ - accuracyMeters?: number; + accuracyMeters?: number | null; /** * Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. */ - altitude?: number; + altitude?: number | null; /** * Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. */ - heading?: number; + heading?: number | null; /** * Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. */ @@ -360,11 +360,11 @@ export namespace streetviewpublish_v1 { /** * Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity. */ - pitch?: number; + pitch?: number | null; /** * Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity. */ - roll?: number; + roll?: number | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -373,15 +373,15 @@ export namespace streetviewpublish_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request to update the metadata of a Photo. Updating the pixels of a photo is not supported. @@ -394,7 +394,7 @@ export namespace streetviewpublish_v1 { /** * Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` <aside class="note"><b>Note:</b> When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.</aside> */ - updateMask?: string; + updateMask?: string | null; } /** * Upload reference for media files. @@ -403,7 +403,7 @@ export namespace streetviewpublish_v1 { /** * Required. An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}" */ - uploadUrl?: string; + uploadUrl?: string | null; } export class Resource$Photo { diff --git a/src/apis/surveys/v2.ts b/src/apis/surveys/v2.ts index c864461c99c..89cc88963d4 100644 --- a/src/apis/surveys/v2.ts +++ b/src/apis/surveys/v2.ts @@ -105,19 +105,19 @@ export namespace surveys_v2 { export interface Schema$FieldMask { fields?: Schema$FieldMask[]; - id?: number; + id?: number | null; } export interface Schema$PageInfo { - resultPerPage?: number; - startIndex?: number; - totalResults?: number; + 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; + projection?: string | null; } /** * Representation of an individual survey object. @@ -134,15 +134,15 @@ export namespace surveys_v2 { /** * 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; + customerData?: string | null; /** * Text description of the survey. */ - description?: string; + 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[]; + owners?: string[] | null; /** * List of questions defining the survey. */ @@ -154,19 +154,19 @@ export namespace surveys_v2 { /** * State that the survey is in. */ - state?: string; + state?: string | null; /** * Unique survey ID, that is viewable in the URL of the Survey Creator UI */ - surveyUrlId?: string; + surveyUrlId?: string | null; /** * Optional name that will be given to the survey. */ - title?: string; + title?: string | null; /** * Number of responses desired for the survey. */ - wantedResponseCount?: number; + wantedResponseCount?: number | null; } /** * Specifications for the target audience of a survey run through the API. @@ -175,27 +175,27 @@ export namespace surveys_v2 { /** * Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+'] */ - ages?: string[]; + 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; + 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; + countrySubdivision?: string | null; /** * Optional gender to target. */ - gender?: string; + 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[]; + languages?: string[] | null; /** * Online population source where the respondents are sampled from. */ - populationSource?: string; + populationSource?: string | null; } /** * Message defining the cost to run a given survey through API. @@ -204,19 +204,19 @@ export namespace surveys_v2 { /** * 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; + costPerResponseNanos?: string | null; /** * Currency code that the cost is given in. */ - currencyCode?: string; + 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; + maxCostPerResponseNanos?: string | null; /** * Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos */ - nanos?: string; + nanos?: string | null; } /** * Message defining the question specifications. @@ -225,72 +225,72 @@ export namespace surveys_v2 { /** * The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize. */ - answerOrder?: string; + answerOrder?: string | null; /** * Required list of answer options for a question. */ - answers?: string[]; + 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; + 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; + highValueLabel?: string | null; images?: Schema$SurveyQuestionImage[]; /** * Currently only support pinning an answer option to the last position. */ - lastAnswerPositionPinned?: boolean; + 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; + 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; + mustPickSuggestion?: boolean | null; /** * Number of stars to use for ratings questions. */ - numStars?: string; + numStars?: string | null; /** * Placeholder text for an open text question. */ - openTextPlaceholder?: string; + 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[]; + openTextSuggestions?: string[] | null; /** * Required question text shown to the respondent. */ - question?: string; + 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; + 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; + 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[]; + thresholdAnswers?: string[] | null; /** * Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide. */ - type?: string; + type?: string | null; /** * Optional unit of measurement for display (for example: hours, people, miles). */ - unitOfMeasurementLabel?: string; + unitOfMeasurementLabel?: string | null; /** * The YouTube video ID to be show in video questions. */ - videoId?: string; + videoId?: string | null; } /** * Container object for image data and alt_text. @@ -299,15 +299,15 @@ export namespace surveys_v2 { /** * The alt text property used in image tags is required for all images. */ - altText?: string; + altText?: string | null; /** * Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types. */ - data?: string; + data?: string | null; /** * The read-only URL for the hosted images. */ - url?: string; + url?: string | null; } /** * Message representing why the survey was rejected from review, if it was. @@ -316,11 +316,11 @@ export namespace surveys_v2 { /** * A human-readable explanation of what was wrong with the survey. */ - explanation?: string; + explanation?: string | null; /** * Which category of rejection this was. See the Google Surveys Help Center for additional details on each category. */ - type?: string; + type?: string | null; } /** * Reference to the current results for a given survey. @@ -329,24 +329,24 @@ export namespace surveys_v2 { /** * Human readable string describing the status of the request. */ - status?: string; + status?: string | null; /** * External survey ID as viewable by survey owners in the editor view. */ - surveyUrlId?: string; + 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; + 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; + requestId?: string | null; /** * An individual survey resource. */ @@ -357,23 +357,23 @@ export namespace surveys_v2 { /** * *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; + 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; + 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; + requestId?: string | null; } export interface Schema$TokenPagination { - nextPageToken?: string; - previousPageToken?: string; + nextPageToken?: string | null; + previousPageToken?: string | null; } export class Resource$Results { diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index fef955ad1d1..b0633a5de2b 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -108,19 +108,19 @@ export namespace tagmanager_v1 { /** * The Account ID uniquely identifies the GTM Account. */ - accountId?: string; + accountId?: string | null; /** * The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Account display name. */ - name?: string; + name?: string | null; /** * Whether the account shares data anonymously with Google and others. */ - shareData?: boolean; + shareData?: boolean | null; } /** * Defines the Google Tag Manager Account access permissions. @@ -129,7 +129,7 @@ export namespace tagmanager_v1 { /** * List of Account permissions. Valid account permissions are read and manage. */ - permission?: string[]; + permission?: string[] | null; } /** * Represents a predicate. @@ -142,7 +142,7 @@ export namespace tagmanager_v1 { /** * The type of operator for this condition. */ - type?: string; + type?: string | null; } /** * Represents a Google Tag Manager Container. @@ -151,47 +151,47 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * The Container ID uniquely identifies the GTM Container. */ - containerId?: string; + containerId?: string | null; /** * Optional list of domain names associated with the Container. */ - domainName?: string[]; + 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. */ - enabledBuiltInVariable?: string[]; + enabledBuiltInVariable?: string[] | null; /** * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Container display name. */ - name?: string; + name?: string | null; /** * Container Notes. */ - notes?: string; + notes?: string | null; /** * Container Public ID. */ - publicId?: string; + publicId?: string | null; /** * Container Country ID. */ - timeZoneCountryId?: string; + timeZoneCountryId?: string | null; /** * Container Time Zone ID. */ - timeZoneId?: string; + timeZoneId?: string | null; /** * List of Usage Contexts for the Container. Valid values include: web, android, ios. */ - usageContext?: string[]; + usageContext?: string[] | null; } /** * Defines the Google Tag Manager Container access permissions. @@ -200,11 +200,11 @@ export namespace tagmanager_v1 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * List of Container permissions. Valid container permissions are: read, edit, delete, publish. */ - permission?: string[]; + permission?: string[] | null; } /** * Represents a Google Tag Manager Container Version. @@ -213,7 +213,7 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * The container that this version was taken from. */ @@ -221,19 +221,19 @@ export namespace tagmanager_v1 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The Container Version ID uniquely identifies the GTM Container Version. */ - containerVersionId?: string; + containerVersionId?: string | null; /** * A value of true indicates this container version has been deleted. */ - deleted?: boolean; + deleted?: boolean | null; /** * The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * The folders in the container that this version was taken from. */ @@ -245,11 +245,11 @@ export namespace tagmanager_v1 { /** * Container version display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this container version in the container. */ - notes?: string; + notes?: string | null; /** * The rules in the container that this version was taken from. */ @@ -274,43 +274,43 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The Container Version ID uniquely identifies the GTM Container Version. */ - containerVersionId?: string; + containerVersionId?: string | null; /** * A value of true indicates this container version has been deleted. */ - deleted?: boolean; + deleted?: boolean | null; /** * Container version display name. */ - name?: string; + name?: string | null; /** * Number of macros in the container version. */ - numMacros?: string; + numMacros?: string | null; /** * Number of rules in the container version. */ - numRules?: string; + numRules?: string | null; /** * Number of tags in the container version. */ - numTags?: string; + numTags?: string | null; /** * Number of triggers in the container version. */ - numTriggers?: string; + numTriggers?: string | null; /** * Number of variables in the container version. */ - numVariables?: string; + numVariables?: string | null; } /** * Options for new container versions. @@ -319,15 +319,15 @@ export namespace tagmanager_v1 { /** * The name of the container version to be created. */ - name?: string; + name?: string | null; /** * The notes of the container version to be created. */ - notes?: string; + notes?: string | null; /** * The creation of this version may be for quick preview and shouldn't be saved. */ - quickPreview?: boolean; + quickPreview?: boolean | null; } /** * Create container versions response. @@ -336,7 +336,7 @@ export namespace tagmanager_v1 { /** * Compiler errors or not. */ - compilerError?: boolean; + compilerError?: boolean | null; /** * The container version created. */ @@ -349,48 +349,48 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * The environment authorization code. */ - authorizationCode?: string; + authorizationCode?: string | null; /** * The last update time-stamp for the authorization code. */ - authorizationTimestampMs?: string; + authorizationTimestampMs?: string | null; /** * GTM Container ID. */ - containerId?: string; - containerVersionId?: string; + containerId?: string | null; + containerVersionId?: string | null; /** * The environment description. Can be set or changed only on USER type environments. */ - description?: string; + description?: string | null; /** * Whether or not to enable debug by default on for the environment. */ - enableDebug?: boolean; + enableDebug?: boolean | null; /** * GTM Environment ID uniquely identifies the GTM Environment. */ - environmentId?: string; + environmentId?: string | null; /** * The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * The environment display name. Can be set or changed only on USER type environments. */ - name?: string; + name?: string | null; /** * The type of this environment. */ - type?: string; + type?: string | null; /** * Default preview page url for the environment. */ - url?: string; + url?: string | null; } /** * Represents a Google Tag Manager Folder. @@ -399,23 +399,23 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * The Folder ID uniquely identifies the GTM Folder. */ - folderId?: string; + folderId?: string | null; /** * Folder display name. */ - name?: string; + name?: string | null; } /** * Represents a Google Tag Manager Folder's contents. @@ -526,35 +526,35 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + 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. */ - disablingRuleId?: string[]; + 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. */ - enablingRuleId?: string[]; + enablingRuleId?: string[] | null; /** * The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * The Macro ID uniquely identifies the GTM Macro. */ - macroId?: string; + macroId?: string | null; /** * Macro display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this macro in the container. */ - notes?: string; + notes?: string | null; /** * The macro's parameters. */ @@ -562,19 +562,19 @@ export namespace tagmanager_v1 { /** * Parent folder id. */ - parentFolderId?: string; + parentFolderId?: string | null; /** * The end timestamp in milliseconds to schedule a macro. */ - scheduleEndMs?: string; + scheduleEndMs?: string | null; /** * The start timestamp in milliseconds to schedule a macro. */ - scheduleStartMs?: string; + scheduleStartMs?: string | null; /** * GTM Macro Type. */ - type?: string; + type?: string | null; } /** * Represents a Google Tag Manager Parameter. @@ -583,7 +583,7 @@ export namespace tagmanager_v1 { /** * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. */ - key?: string; + key?: string | null; /** * This list parameter's parameters (keys will be ignored). */ @@ -595,11 +595,11 @@ export namespace tagmanager_v1 { /** * 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 */ - type?: string; + type?: string | null; /** * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. */ - value?: string; + value?: string | null; } /** * Publish container version response. @@ -608,7 +608,7 @@ export namespace tagmanager_v1 { /** * Compiler errors or not. */ - compilerError?: boolean; + compilerError?: boolean | null; /** * The container version created. */ @@ -621,7 +621,7 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * The list of conditions that make up this rule (implicit AND between them). */ @@ -629,33 +629,33 @@ export namespace tagmanager_v1 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Rule display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this rule in the container. */ - notes?: string; + notes?: string | null; /** * The Rule ID uniquely identifies the GTM Rule. */ - ruleId?: string; + ruleId?: string | null; } export interface Schema$SetupTag { /** * If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status. */ - stopOnSetupFailure?: boolean; + stopOnSetupFailure?: boolean | null; /** * The name of the setup tag. */ - tagName?: string; + tagName?: string | null; } /** * Represents a Google Tag Manager Tag. @@ -664,43 +664,43 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. */ - blockingRuleId?: string[]; + blockingRuleId?: string[] | null; /** * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. */ - blockingTriggerId?: string[]; + blockingTriggerId?: string[] | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. */ - fingerprint?: string; + 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. */ - firingRuleId?: string[]; + 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. */ - firingTriggerId?: string[]; + firingTriggerId?: string[] | null; /** * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). */ - liveOnly?: boolean; + liveOnly?: boolean | null; /** * Tag display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this tag in the container. */ - notes?: string; + notes?: string | null; /** * The tag's parameters. */ @@ -708,11 +708,11 @@ export namespace tagmanager_v1 { /** * Parent folder id. */ - parentFolderId?: string; + parentFolderId?: string | null; /** * True if the tag is paused. */ - paused?: boolean; + 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. */ @@ -720,11 +720,11 @@ export namespace tagmanager_v1 { /** * The end timestamp in milliseconds to schedule a tag. */ - scheduleEndMs?: string; + scheduleEndMs?: string | null; /** * The start timestamp in milliseconds to schedule a tag. */ - scheduleStartMs?: string; + scheduleStartMs?: string | null; /** * The list of setup tags. Currently we only allow one. */ @@ -732,11 +732,11 @@ export namespace tagmanager_v1 { /** * Option to fire this tag. */ - tagFiringOption?: string; + tagFiringOption?: string | null; /** * The Tag ID uniquely identifies the GTM Tag. */ - tagId?: string; + tagId?: string | null; /** * The list of teardown tags. Currently we only allow one. */ @@ -744,17 +744,17 @@ export namespace tagmanager_v1 { /** * GTM Tag Type. */ - type?: string; + type?: string | null; } export interface Schema$TeardownTag { /** * If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status. */ - stopTeardownOnFailure?: boolean; + stopTeardownOnFailure?: boolean | null; /** * The name of the teardown tag. */ - tagName?: string; + tagName?: string | null; } /** * Represents a Google Tag Manager Trigger @@ -763,7 +763,7 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * Used in the case of auto event tracking. */ @@ -775,7 +775,7 @@ export namespace tagmanager_v1 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. */ @@ -795,7 +795,7 @@ export namespace tagmanager_v1 { /** * The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. */ - fingerprint?: string; + 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. */ @@ -819,7 +819,7 @@ export namespace tagmanager_v1 { /** * Trigger display name. */ - name?: string; + name?: string | null; /** * Additional parameters. */ @@ -827,7 +827,7 @@ export namespace tagmanager_v1 { /** * Parent folder id. */ - parentFolderId?: string; + parentFolderId?: string | null; /** * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. */ @@ -839,11 +839,11 @@ export namespace tagmanager_v1 { /** * The Trigger ID uniquely identifies the GTM Trigger. */ - triggerId?: string; + triggerId?: string | null; /** * Defines the data layer event that causes this trigger. */ - type?: string; + 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. */ @@ -884,7 +884,7 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container access permissions. */ @@ -892,11 +892,11 @@ export namespace tagmanager_v1 { /** * User's email address. */ - emailAddress?: string; + emailAddress?: string | null; /** * Account Permission ID. */ - permissionId?: string; + permissionId?: string | null; } /** * Represents a Google Tag Manager Variable. @@ -905,31 +905,31 @@ export namespace tagmanager_v1 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + 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. */ - disablingTriggerId?: string[]; + 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. */ - enablingTriggerId?: string[]; + enablingTriggerId?: string[] | null; /** * The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Variable display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this variable in the container. */ - notes?: string; + notes?: string | null; /** * The variable's parameters. */ @@ -937,23 +937,23 @@ export namespace tagmanager_v1 { /** * Parent folder id. */ - parentFolderId?: string; + parentFolderId?: string | null; /** * The end timestamp in milliseconds to schedule a variable. */ - scheduleEndMs?: string; + scheduleEndMs?: string | null; /** * The start timestamp in milliseconds to schedule a variable. */ - scheduleStartMs?: string; + scheduleStartMs?: string | null; /** * GTM Variable Type. */ - type?: string; + type?: string | null; /** * The Variable ID uniquely identifies the GTM Variable. */ - variableId?: string; + variableId?: string | null; } export class Resource$Accounts { diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index f4ec7b78a3d..4fc79ab3584 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -108,27 +108,27 @@ export namespace tagmanager_v2 { /** * The Account ID uniquely identifies the GTM Account. */ - accountId?: string; + accountId?: string | null; /** * The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Account display name. */ - name?: string; + name?: string | null; /** * GTM Account's API relative path. */ - path?: string; + 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. */ - shareData?: boolean; + shareData?: boolean | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; } /** * Defines the Google Tag Manager Account access permissions. @@ -137,7 +137,7 @@ export namespace tagmanager_v2 { /** * Whether the user has no access, user access, or admin access to an account. */ - permission?: string; + permission?: string | null; } /** * Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing propeties of the gtm data layer, monitoring clicks, or accessing elements of a page URL. @@ -146,27 +146,27 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * Name of the built-in variable to be used to refer to the built-in variable. */ - name?: string; + name?: string | null; /** * GTM BuiltInVariable's API relative path. */ - path?: string; + path?: string | null; /** * Type of built-in variable. */ - type?: string; + type?: string | null; /** * GTM Workspace ID. */ - workspaceId?: string; + workspaceId?: string | null; } /** * Represents a predicate. @@ -179,7 +179,7 @@ export namespace tagmanager_v2 { /** * The type of operator for this condition. */ - type?: string; + type?: string | null; } /** * Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions. @@ -188,43 +188,43 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * The Container ID uniquely identifies the GTM Container. */ - containerId?: string; + containerId?: string | null; /** * List of domain names associated with the Container. */ - domainName?: string[]; + domainName?: string[] | null; /** * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Container display name. */ - name?: string; + name?: string | null; /** * Container Notes. */ - notes?: string; + notes?: string | null; /** * GTM Container's API relative path. */ - path?: string; + path?: string | null; /** * Container Public ID. */ - publicId?: string; + publicId?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * List of Usage Contexts for the Container. Valid values include: web, android, or ios. */ - usageContext?: string[]; + usageContext?: string[] | null; } /** * Defines the Google Tag Manager Container access permissions. @@ -233,11 +233,11 @@ export namespace tagmanager_v2 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * List of Container permissions. */ - permission?: string; + permission?: string | null; } /** * Represents a Google Tag Manager Container Version. @@ -246,7 +246,7 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * The built-in variables in the container that this version was taken from. */ @@ -258,11 +258,11 @@ export namespace tagmanager_v2 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The Container Version ID uniquely identifies the GTM Container Version. */ - containerVersionId?: string; + containerVersionId?: string | null; /** * The custom templates in the container that this version was taken from. */ @@ -270,15 +270,15 @@ export namespace tagmanager_v2 { /** * A value of true indicates this container version has been deleted. */ - deleted?: boolean; + deleted?: boolean | null; /** * Container version description. */ - description?: string; + description?: string | null; /** * The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * The folders in the container that this version was taken from. */ @@ -286,11 +286,11 @@ export namespace tagmanager_v2 { /** * Container version display name. */ - name?: string; + name?: string | null; /** * GTM ContainerVersions's API relative path. */ - path?: string; + path?: string | null; /** * The tags in the container that this version was taken from. */ @@ -298,7 +298,7 @@ export namespace tagmanager_v2 { /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * The triggers in the container that this version was taken from. */ @@ -319,55 +319,55 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The Container Version ID uniquely identifies the GTM Container Version. */ - containerVersionId?: string; + containerVersionId?: string | null; /** * A value of true indicates this container version has been deleted. */ - deleted?: boolean; + deleted?: boolean | null; /** * Container version display name. */ - name?: string; + name?: string | null; /** * Number of custom templates in the container version. */ - numCustomTemplates?: string; + numCustomTemplates?: string | null; /** * Number of macros in the container version. */ - numMacros?: string; + numMacros?: string | null; /** * Number of rules in the container version. */ - numRules?: string; + numRules?: string | null; /** * Number of tags in the container version. */ - numTags?: string; + numTags?: string | null; /** * Number of triggers in the container version. */ - numTriggers?: string; + numTriggers?: string | null; /** * Number of variables in the container version. */ - numVariables?: string; + numVariables?: string | null; /** * Number of zones in the container version. */ - numZones?: string; + numZones?: string | null; /** * GTM Container Versions's API relative path. */ - path?: string; + path?: string | null; } export interface Schema$CreateBuiltInVariableResponse { /** @@ -382,11 +382,11 @@ export namespace tagmanager_v2 { /** * The name of the container version to be created. */ - name?: string; + name?: string | null; /** * The notes of the container version to be created. */ - notes?: string; + notes?: string | null; } /** * Create container versions response. @@ -395,7 +395,7 @@ export namespace tagmanager_v2 { /** * Compiler errors or not. */ - compilerError?: boolean; + compilerError?: boolean | null; /** * The container version created. */ @@ -403,7 +403,7 @@ export namespace tagmanager_v2 { /** * Auto generated workspace path created as a result of version creation. This field should only be populated if the created version was not a quick preview. */ - newWorkspacePath?: string; + newWorkspacePath?: string | null; /** * Whether version creation failed when syncing the workspace to the latest container version. */ @@ -416,39 +416,39 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Custom Template display name. */ - name?: string; + name?: string | null; /** * GTM Custom Template's API relative path. */ - path?: string; + path?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * The custom template in text format. */ - templateData?: string; + templateData?: string | null; /** * The Custom Template ID uniquely identifies the GTM custom template. */ - templateId?: string; + templateId?: string | null; /** * GTM Workspace ID. */ - workspaceId?: string; + workspaceId?: string | null; } /** * A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace. @@ -457,7 +457,7 @@ export namespace tagmanager_v2 { /** * Represents how the entity has been changed in the workspace. */ - changeStatus?: string; + changeStatus?: string | null; /** * The Folder being represented by the entity. */ @@ -482,11 +482,11 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * The environment authorization code. */ - authorizationCode?: string; + authorizationCode?: string | null; /** * The last update time-stamp for the authorization code. */ @@ -494,51 +494,51 @@ export namespace tagmanager_v2 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * Represents a link to a container version. */ - containerVersionId?: string; + containerVersionId?: string | null; /** * The environment description. Can be set or changed only on USER type environments. */ - description?: string; + description?: string | null; /** * Whether or not to enable debug by default for the environment. */ - enableDebug?: boolean; + enableDebug?: boolean | null; /** * GTM Environment ID uniquely identifies the GTM Environment. */ - environmentId?: string; + environmentId?: string | null; /** * The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * The environment display name. Can be set or changed only on USER type environments. */ - name?: string; + name?: string | null; /** * GTM Environment's API relative path. */ - path?: string; + path?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * The type of this environment. */ - type?: string; + type?: string | null; /** * Default preview page url for the environment. */ - url?: string; + url?: string | null; /** * Represents a link to a quick preview of a workspace. */ - workspaceId?: string; + workspaceId?: string | null; } /** * Represents a Google Tag Manager Folder. @@ -547,39 +547,39 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * The Folder ID uniquely identifies the GTM Folder. */ - folderId?: string; + folderId?: string | null; /** * Folder display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this folder in the container. */ - notes?: string; + notes?: string | null; /** * GTM Folder's API relative path. */ - path?: string; + path?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * GTM Workspace ID. */ - workspaceId?: string; + workspaceId?: string | null; } /** * Represents a Google Tag Manager Folder's contents. @@ -588,7 +588,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of tags inside the folder. */ @@ -626,7 +626,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * List Containers Response. @@ -639,7 +639,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * List container versions response. @@ -652,7 +652,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * A list of enabled built-in variables. @@ -665,7 +665,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * List Environments Response. @@ -678,7 +678,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * List Folders Response. @@ -691,7 +691,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * List Tags Response. @@ -700,7 +700,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * All GTM Tags of a GTM Container. */ @@ -710,7 +710,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * All GTM Custom Templates of a GTM Container. */ @@ -723,7 +723,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * All GTM Triggers of a GTM Container. */ @@ -736,7 +736,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * All GTM UserPermissions of a GTM Account. */ @@ -749,7 +749,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * All GTM Variables of a GTM Container. */ @@ -762,7 +762,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * All Workspaces of a GTM Container. */ @@ -772,7 +772,7 @@ export namespace tagmanager_v2 { /** * Continuation token for fetching the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * All GTM Zones of a GTM Container. */ @@ -798,7 +798,7 @@ export namespace tagmanager_v2 { /** * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. */ - key?: string; + key?: string | null; /** * This list parameter's parameters (keys will be ignored). */ @@ -810,11 +810,11 @@ export namespace tagmanager_v2 { /** * 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 */ - type?: string; + type?: string | null; /** * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. */ - value?: string; + value?: string | null; } /** * Publish container version response. @@ -823,7 +823,7 @@ export namespace tagmanager_v2 { /** * Compiler errors or not. */ - compilerError?: boolean; + compilerError?: boolean | null; /** * The container version created. */ @@ -836,7 +836,7 @@ export namespace tagmanager_v2 { /** * Were there compiler errors or not. */ - compilerError?: boolean; + compilerError?: boolean | null; /** * The quick previewed container version. */ @@ -853,7 +853,7 @@ export namespace tagmanager_v2 { /** * Whether the built-in variable is enabled after reversion. */ - enabled?: boolean; + enabled?: boolean | null; } /** * The result of reverting folder changes in a workspace. @@ -916,11 +916,11 @@ export namespace tagmanager_v2 { /** * If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status. */ - stopOnSetupFailure?: boolean; + stopOnSetupFailure?: boolean | null; /** * The name of the setup tag. */ - tagName?: string; + tagName?: string | null; } /** * The status of a workspace after synchronization. @@ -929,11 +929,11 @@ export namespace tagmanager_v2 { /** * Synchornization operation detected a merge conflict. */ - mergeConflict?: boolean; + mergeConflict?: boolean | null; /** * An error occurred during the synchronization operation. */ - syncError?: boolean; + syncError?: boolean | null; } /** * A response after synchronizing the workspace to the latest container version. @@ -955,43 +955,43 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. */ - blockingRuleId?: string[]; + blockingRuleId?: string[] | null; /** * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. */ - blockingTriggerId?: string[]; + blockingTriggerId?: string[] | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. */ - fingerprint?: string; + 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. */ - firingRuleId?: string[]; + 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. */ - firingTriggerId?: string[]; + firingTriggerId?: string[] | null; /** * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). */ - liveOnly?: boolean; + liveOnly?: boolean | null; /** * Tag display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this tag in the container. */ - notes?: string; + notes?: string | null; /** * The tag's parameters. */ @@ -999,15 +999,15 @@ export namespace tagmanager_v2 { /** * Parent folder id. */ - parentFolderId?: string; + parentFolderId?: string | null; /** * GTM Tag's API relative path. */ - path?: string; + path?: string | null; /** * Indicates whether the tag is paused, which prevents the tag from firing. */ - paused?: boolean; + 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. */ @@ -1015,11 +1015,11 @@ export namespace tagmanager_v2 { /** * The end timestamp in milliseconds to schedule a tag. */ - scheduleEndMs?: string; + scheduleEndMs?: string | null; /** * The start timestamp in milliseconds to schedule a tag. */ - scheduleStartMs?: string; + scheduleStartMs?: string | null; /** * The list of setup tags. Currently we only allow one. */ @@ -1027,15 +1027,15 @@ export namespace tagmanager_v2 { /** * Option to fire this tag. */ - tagFiringOption?: string; + tagFiringOption?: string | null; /** * The Tag ID uniquely identifies the GTM Tag. */ - tagId?: string; + tagId?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * The list of teardown tags. Currently we only allow one. */ @@ -1043,11 +1043,11 @@ export namespace tagmanager_v2 { /** * GTM Tag Type. */ - type?: string; + type?: string | null; /** * GTM Workspace ID. */ - workspaceId?: string; + workspaceId?: string | null; } /** * Represents a tag that fires after another tag in order to tear down dependencies. @@ -1056,11 +1056,11 @@ export namespace tagmanager_v2 { /** * If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status. */ - stopTeardownOnFailure?: boolean; + stopTeardownOnFailure?: boolean | null; /** * The name of the teardown tag. */ - tagName?: string; + 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. @@ -1069,11 +1069,11 @@ export namespace tagmanager_v2 { /** * 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; + 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; + seconds?: string | null; } /** * Represents a Google Tag Manager Trigger @@ -1082,7 +1082,7 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * Used in the case of auto event tracking. */ @@ -1094,7 +1094,7 @@ export namespace tagmanager_v2 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. */ @@ -1114,7 +1114,7 @@ export namespace tagmanager_v2 { /** * The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. */ - fingerprint?: string; + 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. */ @@ -1138,11 +1138,11 @@ export namespace tagmanager_v2 { /** * Trigger display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this trigger in the container. */ - notes?: string; + notes?: string | null; /** * Additional parameters. */ @@ -1150,11 +1150,11 @@ export namespace tagmanager_v2 { /** * Parent folder id. */ - parentFolderId?: string; + parentFolderId?: string | null; /** * GTM Trigger's API relative path. */ - path?: string; + path?: string | null; /** * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. */ @@ -1162,7 +1162,7 @@ export namespace tagmanager_v2 { /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. */ @@ -1170,11 +1170,11 @@ export namespace tagmanager_v2 { /** * The Trigger ID uniquely identifies the GTM Trigger. */ - triggerId?: string; + triggerId?: string | null; /** * Defines the data layer event that causes this trigger. */ - type?: string; + 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. */ @@ -1206,7 +1206,7 @@ export namespace tagmanager_v2 { /** * GTM Workspace ID. */ - workspaceId?: string; + workspaceId?: string | null; } /** * Represents a user's permissions to an account and its container. @@ -1219,7 +1219,7 @@ export namespace tagmanager_v2 { /** * The Account ID uniquely identifies the GTM Account. */ - accountId?: string; + accountId?: string | null; /** * GTM Container access permissions. */ @@ -1227,11 +1227,11 @@ export namespace tagmanager_v2 { /** * User's email address. */ - emailAddress?: string; + emailAddress?: string | null; /** * GTM UserPermission's API relative path. */ - path?: string; + path?: string | null; } /** * Represents a Google Tag Manager Variable. @@ -1240,23 +1240,23 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + 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. */ - disablingTriggerId?: string[]; + 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. */ - enablingTriggerId?: string[]; + enablingTriggerId?: string[] | null; /** * The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Option to convert a variable value to other value. */ @@ -1264,11 +1264,11 @@ export namespace tagmanager_v2 { /** * Variable display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this variable in the container. */ - notes?: string; + notes?: string | null; /** * The variable's parameters. */ @@ -1276,41 +1276,41 @@ export namespace tagmanager_v2 { /** * Parent folder id. */ - parentFolderId?: string; + parentFolderId?: string | null; /** * GTM Variable's API relative path. */ - path?: string; + path?: string | null; /** * The end timestamp in milliseconds to schedule a variable. */ - scheduleEndMs?: string; + scheduleEndMs?: string | null; /** * The start timestamp in milliseconds to schedule a variable. */ - scheduleStartMs?: string; + scheduleStartMs?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * GTM Variable Type. */ - type?: string; + type?: string | null; /** * The Variable ID uniquely identifies the GTM Variable. */ - variableId?: string; + variableId?: string | null; /** * GTM Workspace ID. */ - workspaceId?: string; + workspaceId?: string | null; } export interface Schema$VariableFormatValue { /** * The option to convert a string-type variable value to either lowercase or uppercase. */ - caseConversionType?: string; + caseConversionType?: string | null; /** * The value to convert if a variable value is false. */ @@ -1335,35 +1335,35 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * Workspace description. */ - description?: string; + description?: string | null; /** * The fingerprint of the GTM Workspace as computed at storage time. This value is recomputed whenever the workspace is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Workspace display name. */ - name?: string; + name?: string | null; /** * GTM Workspace's API relative path. */ - path?: string; + path?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * The Workspace ID uniquely identifies the GTM Workspace. */ - workspaceId?: string; + workspaceId?: string | null; } /** * Represents a Google Tag Manager Zone's contents. @@ -1372,7 +1372,7 @@ export namespace tagmanager_v2 { /** * GTM Account ID. */ - accountId?: string; + accountId?: string | null; /** * This Zone's boundary. */ @@ -1384,27 +1384,27 @@ export namespace tagmanager_v2 { /** * GTM Container ID. */ - containerId?: string; + containerId?: string | null; /** * The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. */ - fingerprint?: string; + fingerprint?: string | null; /** * Zone display name. */ - name?: string; + name?: string | null; /** * User notes on how to apply this zone in the container. */ - notes?: string; + notes?: string | null; /** * GTM Zone's API relative path. */ - path?: string; + path?: string | null; /** * Auto generated link to the tag manager UI */ - tagManagerUrl?: string; + tagManagerUrl?: string | null; /** * This Zone's type restrictions. */ @@ -1412,11 +1412,11 @@ export namespace tagmanager_v2 { /** * GTM Workspace ID. */ - workspaceId?: string; + workspaceId?: string | null; /** * The Zone ID uniquely identifies the GTM Zone. */ - zoneId?: string; + zoneId?: string | null; } /** * Represents a Zone's boundaries. @@ -1429,7 +1429,7 @@ export namespace tagmanager_v2 { /** * Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. */ - customEvaluationTriggerId?: string[]; + customEvaluationTriggerId?: string[] | null; } /** * Represents a child container of a Zone. @@ -1438,11 +1438,11 @@ export namespace tagmanager_v2 { /** * The zone's nickname for the child container. */ - nickname?: string; + nickname?: string | null; /** * The child container's public id. */ - publicId?: string; + publicId?: string | null; } /** * Represents a Zone's type restrictions. @@ -1451,11 +1451,11 @@ export namespace tagmanager_v2 { /** * True if type restrictions have been enabled for this Zone. */ - enable?: boolean; + enable?: boolean | null; /** * List of type public ids that have been whitelisted for use in this Zone. */ - whitelistedTypeId?: string[]; + whitelistedTypeId?: string[] | null; } export class Resource$Accounts { diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index 7caa7dbb612..55164298e1d 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -107,95 +107,95 @@ export namespace tasks_v1 { /** * Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. */ - completed?: string; + completed?: string | null; /** * Flag indicating whether the task has been deleted. The default if False. */ - deleted?: boolean; + deleted?: boolean | null; /** * Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API. */ - due?: string; + due?: string | null; /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. */ - hidden?: boolean; + hidden?: boolean | null; /** * Task identifier. */ - id?: string; + id?: string | null; /** * Type of the resource. This is always "tasks#task". */ - kind?: string; + kind?: string | null; /** * Collection of links. This collection is read-only. */ - links?: Array<{description?: string; link?: string; type?: string}>; + links?: Array<{description?: string; link?: string; type?: string}> | null; /** * Notes describing the task. Optional. */ - notes?: string; + notes?: string | null; /** * Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. */ - parent?: string; + parent?: string | null; /** * String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. */ - position?: string; + position?: string | null; /** * URL pointing to this task. Used to retrieve, update, or delete this task. */ - selfLink?: string; + selfLink?: string | null; /** * Status of the task. This is either "needsAction" or "completed". */ - status?: string; + status?: string | null; /** * Title of the task. */ - title?: string; + title?: string | null; /** * Last modification time of the task (as a RFC 3339 timestamp). */ - updated?: string; + updated?: string | null; } export interface Schema$TaskList { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Task list identifier. */ - id?: string; + id?: string | null; /** * Type of the resource. This is always "tasks#taskList". */ - kind?: string; + kind?: string | null; /** * URL pointing to this task list. Used to retrieve, update, or delete this task list. */ - selfLink?: string; + selfLink?: string | null; /** * Title of the task list. */ - title?: string; + title?: string | null; /** * Last modification time of the task list (as a RFC 3339 timestamp). */ - updated?: string; + updated?: string | null; } export interface Schema$TaskLists { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Collection of task lists. */ @@ -203,17 +203,17 @@ export namespace tasks_v1 { /** * Type of the resource. This is always "tasks#taskLists". */ - kind?: string; + kind?: string | null; /** * Token that can be used to request the next page of this result. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$Tasks { /** * ETag of the resource. */ - etag?: string; + etag?: string | null; /** * Collection of tasks. */ @@ -221,11 +221,11 @@ export namespace tasks_v1 { /** * Type of the resource. This is always "tasks#tasks". */ - kind?: string; + kind?: string | null; /** * Token used to access the next page of this result. */ - nextPageToken?: string; + nextPageToken?: string | null; } export class Resource$Tasklists { diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 0178bed0d1f..377effd9159 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -141,19 +141,19 @@ export namespace testing_v1 { /** * Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ - androidModelId?: string; + androidModelId?: string | null; /** * Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ - androidVersionId?: string; + androidVersionId?: string | null; /** * Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */ - locale?: string; + locale?: string | null; /** * Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */ - orientation?: string; + orientation?: string | null; } /** * The currently supported Android devices. @@ -196,11 +196,11 @@ export namespace testing_v1 { /** * The java package for the application under test. The default value is determined by examining the application's manifest. */ - appPackageId?: string; + appPackageId?: string | null; /** * The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See <https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator> for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator. */ - orchestratorOption?: string; + orchestratorOption?: string | null; /** * Required. The APK containing the test code to be executed. */ @@ -208,15 +208,15 @@ export namespace testing_v1 { /** * The java package for the test to be executed. The default value is determined by examining the application's manifest. */ - testPackageId?: string; + testPackageId?: string | null; /** * The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. */ - testRunnerClass?: string; + testRunnerClass?: string | null; /** * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. */ - testTargets?: string[]; + testTargets?: string[] | null; } /** * A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored. @@ -225,19 +225,19 @@ export namespace testing_v1 { /** * Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ - androidModelIds?: string[]; + androidModelIds?: string[] | null; /** * Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ - androidVersionIds?: string[]; + androidVersionIds?: string[] | null; /** * Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. */ - locales?: string[]; + locales?: string[] | null; /** * Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. */ - orientations?: string[]; + orientations?: string[] | null; } /** * A description of an Android device tests may be run on. @@ -246,59 +246,59 @@ export namespace testing_v1 { /** * The company that this device is branded with. Example: "Google", "Samsung". */ - brand?: string; + brand?: string | null; /** * The name of the industrial design. This corresponds to android.os.Build.DEVICE. */ - codename?: string; + codename?: string | null; /** * Whether this device is virtual or physical. */ - form?: string; + form?: string | null; /** * Whether this device is a phone, tablet, wearable, etc. */ - formFactor?: string; + formFactor?: string | null; /** * The unique opaque id for this model. Use this for invoking the TestExecutionService. */ - id?: string; + id?: string | null; /** * True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config. */ - lowFpsVideoRecording?: boolean; + lowFpsVideoRecording?: boolean | null; /** * The manufacturer of this device. */ - manufacturer?: string; + manufacturer?: string | null; /** * The human-readable marketing name for this device model. Examples: "Nexus 5", "Galaxy S5". */ - name?: string; + name?: string | null; /** * Screen density in DPI. This corresponds to ro.sf.lcd_density */ - screenDensity?: number; + screenDensity?: number | null; /** * Screen size in the horizontal (X) dimension measured in pixels. */ - screenX?: number; + screenX?: number | null; /** * Screen size in the vertical (Y) dimension measured in pixels. */ - screenY?: number; + screenY?: number | null; /** * The list of supported ABIs for this device. This corresponds to either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first element in the list. Elements are optionally prefixed by "version_id:" (where version_id is the id of an AndroidVersion), denoting an ABI that is supported only on a particular version. */ - supportedAbis?: string[]; + supportedAbis?: string[] | null; /** * The set of Android versions this device supports. */ - supportedVersionIds?: string[]; + supportedVersionIds?: string[] | null; /** * Tags for this dimension. Examples: "default", "preview", "deprecated". */ - tags?: string[]; + tags?: string[] | null; } /** * A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes. @@ -315,19 +315,19 @@ export namespace testing_v1 { /** * The initial activity that should be used to start the app. */ - appInitialActivity?: string; + appInitialActivity?: string | null; /** * The java package for the application under test. The default value is determined by examining the application's manifest. */ - appPackageId?: string; + appPackageId?: string | null; /** * The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. */ - maxDepth?: number; + maxDepth?: number | null; /** * The max number of steps Robo can execute. Default is no limit. */ - maxSteps?: number; + maxSteps?: number | null; /** * A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. */ @@ -369,15 +369,15 @@ export namespace testing_v1 { /** * The java package for the application under test. The default is determined by examining the application's manifest. */ - appPackageId?: string; + appPackageId?: string | null; /** * The list of scenario labels that should be run during the test. The scenario labels should map to labels defined in the application's manifest. For example, player_experience and com.google.test.loops.player_experience add all of the loops labeled in the manifest with the com.google.test.loops.player_experience name to the execution. Scenarios can also be specified in the scenarios field. */ - scenarioLabels?: string[]; + scenarioLabels?: string[] | null; /** * The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. */ - scenarios?: number[]; + scenarios?: number[] | null; } /** * A version of the Android OS. @@ -386,11 +386,11 @@ export namespace testing_v1 { /** * The API level for this Android version. Examples: 18, 19. */ - apiLevel?: number; + apiLevel?: number | null; /** * The code name for this Android version. Examples: "JellyBean", "KitKat". */ - codeName?: string; + codeName?: string | null; /** * Market share for this version. */ @@ -398,7 +398,7 @@ export namespace testing_v1 { /** * An opaque id for this Android version. Use this id to invoke the TestExecutionService. */ - id?: string; + id?: string | null; /** * The date this Android version became available in the market. */ @@ -406,11 +406,11 @@ export namespace testing_v1 { /** * Tags for this dimension. Examples: "default", "preview", "deprecated". */ - tags?: string[]; + tags?: string[] | null; /** * A string representing this version of the Android OS. Examples: "4.3", "4.4". */ - versionString?: string; + versionString?: string | null; } /** * An Android package file to install. @@ -423,7 +423,7 @@ export namespace testing_v1 { /** * The java package for the APK to be installed. Value is determined by examining the application's manifest. */ - packageName?: string; + packageName?: string | null; } /** * Android application details based on application manifest and apk archive contents. @@ -438,24 +438,24 @@ export namespace testing_v1 { /** * User-readable name for the application. */ - applicationLabel?: string; + applicationLabel?: string | null; intentFilters?: Schema$IntentFilter[]; /** * Maximum API level on which the application is designed to run. */ - maxSdkVersion?: number; + maxSdkVersion?: number | null; /** * Minimum API level required for the application to run. */ - minSdkVersion?: number; + minSdkVersion?: number | null; /** * Full Java-style package name for this application, e.g. "com.example.foo". */ - packageName?: string; + packageName?: string | null; /** * Specifies the API Level on which the application is designed to run. */ - targetSdkVersion?: number; + targetSdkVersion?: number | null; } /** * An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. <p>See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles. @@ -473,7 +473,7 @@ export namespace testing_v1 { /** * The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect. */ - testState?: string; + testState?: string | null; } /** * Information about the client which invoked the test. @@ -486,7 +486,7 @@ export namespace testing_v1 { /** * Required. Client name, such as gcloud. */ - name?: string; + name?: string | null; } /** * Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}. @@ -495,11 +495,11 @@ export namespace testing_v1 { /** * Required. The key of detailed client information. */ - key?: string; + key?: string | null; /** * Required. The value of detailed client information. */ - value?: string; + value?: 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 date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. @@ -508,15 +508,15 @@ export namespace testing_v1 { /** * 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; + 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; + month?: number | null; /** * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ - year?: number; + year?: number | null; } /** * A single device file description. @@ -538,11 +538,11 @@ export namespace testing_v1 { /** * Output only. The estimated fraction (0-1) of the total market with this configuration. */ - marketShare?: number; + marketShare?: number | null; /** * Output only. The time this distribution was measured. */ - measurementTime?: string; + measurementTime?: string | null; } /** * The environment in which the test is run. @@ -581,11 +581,11 @@ export namespace testing_v1 { /** * Key for the environment variable. */ - key?: string; + key?: string | null; /** * Value for the environment variable. */ - value?: string; + value?: string | null; } /** * A reference to a file, used for user inputs. @@ -594,7 +594,7 @@ export namespace testing_v1 { /** * A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app-debug-unaligned.apk */ - gcsPath?: string; + gcsPath?: string | null; } /** * Response containing the details of the specified Android application APK. @@ -616,7 +616,7 @@ export namespace testing_v1 { /** * Required. The path to a directory in GCS that will eventually contain the results for this test. The requesting user must have write access on the bucket in the supplied path. */ - gcsPath?: string; + gcsPath?: string | null; } /** * The <intent-filter> section of an <activity> tag. https://developer.android.com/guide/topics/manifest/intent-filter-element.html @@ -625,15 +625,15 @@ export namespace testing_v1 { /** * The android:name value of the <action> tag. */ - actionNames?: string[]; + actionNames?: string[] | null; /** * The android:name value of the <category> tag. */ - categoryNames?: string[]; + categoryNames?: string[] | null; /** * The android:mimeType value of the <data> tag. */ - mimeType?: string; + mimeType?: string | null; } /** * A single iOS device. @@ -642,19 +642,19 @@ export namespace testing_v1 { /** * Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ - iosModelId?: string; + iosModelId?: string | null; /** * Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ - iosVersionId?: string; + iosVersionId?: string | null; /** * Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */ - locale?: string; + locale?: string | null; /** * Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */ - orientation?: string; + orientation?: string | null; } /** * The currently supported iOS devices. @@ -693,39 +693,39 @@ export namespace testing_v1 { /** * Device capabilities. Copied from https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html */ - deviceCapabilities?: string[]; + deviceCapabilities?: string[] | null; /** * Whether this device is a phone, tablet, wearable, etc. */ - formFactor?: string; + formFactor?: string | null; /** * The unique opaque id for this model. Use this for invoking the TestExecutionService. */ - id?: string; + id?: string | null; /** * The human-readable name for this device model. Examples: "iPhone 4s", "iPad Mini 2". */ - name?: string; + name?: string | null; /** * Screen density in DPI. */ - screenDensity?: number; + screenDensity?: number | null; /** * Screen size in the horizontal (X) dimension measured in pixels. */ - screenX?: number; + screenX?: number | null; /** * Screen size in the vertical (Y) dimension measured in pixels. */ - screenY?: number; + screenY?: number | null; /** * The set of iOS major software versions this device supports. */ - supportedVersionIds?: string[]; + supportedVersionIds?: string[] | null; /** * Tags for this dimension. Examples: "default", "preview", "deprecated". */ - tags?: string[]; + tags?: string[] | null; } /** * iOS configuration that can be selected at the time a test is run. @@ -747,7 +747,7 @@ export namespace testing_v1 { /** * The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. */ - networkProfile?: string; + networkProfile?: string | null; } /** * An iOS version. @@ -756,23 +756,23 @@ export namespace testing_v1 { /** * An opaque id for this iOS version. Use this id to invoke the TestExecutionService. */ - id?: string; + id?: string | null; /** * An integer representing the major iOS version. Examples: "8", "9". */ - majorVersion?: number; + majorVersion?: number | null; /** * An integer representing the minor iOS version. Examples: "1", "2". */ - minorVersion?: number; + minorVersion?: number | null; /** * The available Xcode versions for this version. */ - supportedXcodeVersionIds?: string[]; + supportedXcodeVersionIds?: string[] | null; /** * Tags for this dimension. Examples: "default", "preview", "deprecated". */ - tags?: string[]; + tags?: string[] | null; } /** * A test of an iOS application that uses the XCTest framework. Xcode supports the option to "build for testing", which generates an .xctestrun file that contains a test specification (arguments, test methods, etc). This test type accepts a zip file containing the .xctestrun file and the corresponding contents of the Build/Products directory that contains all the binaries needed to run the tests. @@ -781,7 +781,7 @@ export namespace testing_v1 { /** * Output only. The bundle id for the application under test. */ - appBundleId?: string; + appBundleId?: string | null; /** * Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. */ @@ -789,7 +789,7 @@ export namespace testing_v1 { /** * The Xcode version that should be used for the test. Use the TestEnvironmentDiscoveryService to get supported options. Defaults to the latest Xcode version Firebase Test Lab supports. */ - xcodeVersion?: string; + xcodeVersion?: string | null; /** * An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. */ @@ -806,19 +806,19 @@ export namespace testing_v1 { /** * The id for this locale. Example: "en_US". */ - id?: string; + id?: string | null; /** * A human-friendly name for this language/locale. Example: "English". */ - name?: string; + name?: string | null; /** * A human-friendly string representing the region for this locale. Example: "United States". Not present for every locale. */ - region?: string; + region?: string | null; /** * Tags for this dimension. Example: "default". */ - tags?: string[]; + tags?: string[] | null; } export interface Schema$NetworkConfiguration { /** @@ -828,7 +828,7 @@ export namespace testing_v1 { /** * The unique opaque id for this network traffic configuration. */ - id?: string; + id?: string | null; /** * The emulation rule applying to the upload traffic. */ @@ -848,7 +848,7 @@ export namespace testing_v1 { /** * Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \<shared-storage\>/Android/obb/\<package-name\>/ on the device. */ - obbFileName?: string; + obbFileName?: string | null; } /** * Screen orientation of the device. @@ -857,15 +857,15 @@ export namespace testing_v1 { /** * The id for this orientation. Example: "portrait". */ - id?: string; + id?: string | null; /** * A human-friendly name for this orientation. Example: "portrait". */ - name?: string; + name?: string | null; /** * Tags for this dimension. Example: "default". */ - tags?: string[]; + tags?: string[] | null; } /** * The currently provided software environment on the devices under test. @@ -874,7 +874,7 @@ export namespace testing_v1 { /** * A string representing the current version of Android Test Orchestrator that is provided by TestExecutionService. Example: "1.0.2 beta". */ - orchestratorVersion?: string; + orchestratorVersion?: string | null; } /** * A file or directory to install on the device before the test starts. @@ -887,7 +887,7 @@ export namespace testing_v1 { /** * Required. Where to put the content on the device. Must be an absolute, whitelisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are whitelisted: <p>${EXTERNAL_STORAGE}, or /sdcard</p> <p>${ANDROID_DATA}/local/tmp, or /data/local/tmp</p> <p>Specifying a path outside of these directory trees is invalid. <p> The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. <p> It is strongly advised to use the <a href= "http://developer.android.com/reference/android/os/Environment.html"> Environment API</a> in app and test code to access files on the device in a portable way. */ - devicePath?: string; + devicePath?: string | null; } /** * Locations where the results of running the test are stored. @@ -900,7 +900,7 @@ export namespace testing_v1 { /** * Output only. URL to the results in the Firebase Web Console. */ - resultsUrl?: string; + resultsUrl?: string | null; /** * Output only. The tool results execution that results are written to. */ @@ -917,15 +917,15 @@ export namespace testing_v1 { /** * Required. The type of action that Robo should perform on the specified element. */ - actionType?: string; + actionType?: string | null; /** * The text that Robo is directed to set. If left empty, the directive will be treated as a CLICK on the element matching the resource_name. */ - inputText?: string; + inputText?: string | null; /** * Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the "foo" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html */ - resourceName?: string; + resourceName?: string | null; } /** * Message for specifying the start activities to crawl. @@ -942,7 +942,7 @@ export namespace testing_v1 { /** * Timeout in seconds for each intent. */ - timeout?: string; + timeout?: string | null; } /** * A starting intent specified by an action, uri, and categories. @@ -951,15 +951,15 @@ export namespace testing_v1 { /** * Action name. Required for START_ACTIVITY. */ - action?: string; + action?: string | null; /** * Intent categories to set on the intent. */ - categories?: string[]; + categories?: string[] | null; /** * URI for the action. */ - uri?: string; + uri?: string | null; } /** * Additional details about the progress of the running test. @@ -968,11 +968,11 @@ export namespace testing_v1 { /** * Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. */ - errorMessage?: string; + errorMessage?: string | null; /** * Output only. Human-readable, detailed descriptions of the test's progress. For example: "Provisioning a device", "Starting Test". During the course of execution new data may be appended to the end of progress_messages. */ - progressMessages?: string[]; + progressMessages?: string[] | null; } /** * A description of a test environment. @@ -1006,19 +1006,19 @@ export namespace testing_v1 { /** * Output only. Unique id set by the service. */ - id?: string; + id?: string | null; /** * Output only. Id of the containing TestMatrix. */ - matrixId?: string; + matrixId?: string | null; /** * Output only. The cloud project that owns the test execution. */ - projectId?: string; + projectId?: string | null; /** * Output only. Indicates the current progress of the test execution (e.g., FINISHED). */ - state?: string; + state?: string | null; /** * Output only. Additional details about the running test. */ @@ -1030,7 +1030,7 @@ export namespace testing_v1 { /** * Output only. The time this test execution was initially created. */ - timestamp?: string; + timestamp?: string | null; /** * Output only. Where the results for this execution are written. */ @@ -1051,19 +1051,19 @@ export namespace testing_v1 { /** * The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. */ - flakyTestAttempts?: number; + flakyTestAttempts?: number | null; /** * Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. */ - invalidMatrixDetails?: string; + invalidMatrixDetails?: string | null; /** * Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. */ - outcomeSummary?: string; + outcomeSummary?: string | null; /** * The cloud project that owns the test matrix. */ - projectId?: string; + projectId?: string | null; /** * Required. Where the results for the matrix are written. */ @@ -1071,7 +1071,7 @@ export namespace testing_v1 { /** * Output only. Indicates the current progress of the test matrix. */ - state?: string; + state?: string | null; /** * Output only. The list of test executions that the service creates for this matrix. */ @@ -1079,7 +1079,7 @@ export namespace testing_v1 { /** * Output only. Unique id set by the service. */ - testMatrixId?: string; + testMatrixId?: string | null; /** * Required. How to run the test. */ @@ -1087,7 +1087,7 @@ export namespace testing_v1 { /** * Output only. The time this test matrix was initially created. */ - timestamp?: string; + timestamp?: string | null; } /** * A description of how to set up the Android device prior to running the test. @@ -1104,7 +1104,7 @@ export namespace testing_v1 { /** * List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device. */ - directoriesToPull?: string[]; + directoriesToPull?: string[] | null; /** * Environment variables to set for the test (only applicable for instrumentation tests). */ @@ -1116,7 +1116,7 @@ export namespace testing_v1 { /** * The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. */ - networkProfile?: string; + networkProfile?: string | null; } /** * A description of how to run the test. @@ -1137,11 +1137,11 @@ export namespace testing_v1 { /** * Disables performance metrics recording. May reduce test latency. */ - disablePerformanceMetrics?: boolean; + disablePerformanceMetrics?: boolean | null; /** * Disables video recording. May reduce test latency. */ - disableVideoRecording?: boolean; + disableVideoRecording?: boolean | null; /** * Test setup requirements for iOS. */ @@ -1157,7 +1157,7 @@ export namespace testing_v1 { /** * Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. */ - testTimeout?: string; + testTimeout?: string | null; } /** * Represents a tool results execution resource. This has the results of a TestMatrix. @@ -1166,15 +1166,15 @@ export namespace testing_v1 { /** * Output only. A tool results execution ID. */ - executionId?: string; + executionId?: string | null; /** * Output only. A tool results history ID. */ - historyId?: string; + historyId?: string | null; /** * Output only. The cloud project that owns the tool results execution. */ - projectId?: string; + projectId?: string | null; } /** * Represents a tool results history resource. @@ -1183,11 +1183,11 @@ export namespace testing_v1 { /** * Required. A tool results history ID. */ - historyId?: string; + historyId?: string | null; /** * Required. The cloud project that owns the tool results history. */ - projectId?: string; + projectId?: string | null; } /** * Represents a tool results step resource. This has the results of a TestExecution. @@ -1196,19 +1196,19 @@ export namespace testing_v1 { /** * Output only. A tool results execution ID. */ - executionId?: string; + executionId?: string | null; /** * Output only. A tool results history ID. */ - historyId?: string; + historyId?: string | null; /** * Output only. The cloud project that owns the tool results step. */ - projectId?: string; + projectId?: string | null; /** * Output only. A tool results step ID. */ - stepId?: string; + stepId?: string | null; } /** * Network emulation parameters. @@ -1217,23 +1217,23 @@ export namespace testing_v1 { /** * Bandwidth in kbits/second. */ - bandwidth?: number; + bandwidth?: number | null; /** * Burst size in kbits. */ - burst?: number; + burst?: number | null; /** * Packet delay, must be >= 0. */ - delay?: string; + delay?: string | null; /** * Packet duplication ratio (0.0 - 1.0). */ - packetDuplicationRatio?: number; + packetDuplicationRatio?: number | null; /** * Packet loss ratio (0.0 - 1.0). */ - packetLossRatio?: number; + packetLossRatio?: number | null; } /** * An Xcode version that an iOS version is compatible with. @@ -1242,11 +1242,11 @@ export namespace testing_v1 { /** * Tags for this Xcode version. Example: "default". */ - tags?: string[]; + tags?: string[] | null; /** * The id for this version. Example: "9.2". */ - version?: string; + version?: string | null; } export class Resource$Applicationdetailservice { diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index 56d76533902..635ff73f0dc 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -126,27 +126,27 @@ export namespace texttospeech_v1 { /** * Required. The format of the audio byte stream. */ - audioEncoding?: string; + audioEncoding?: string | null; /** * Optional. Input only. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. See [audio profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. */ - effectsProfileId?: string[]; + effectsProfileId?: string[] | null; /** * Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ - pitch?: number; + pitch?: number | null; /** * The synthesis sample rate (in hertz) for this audio. Optional. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ - sampleRateHertz?: number; + sampleRateHertz?: number | null; /** * Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ - speakingRate?: number; + speakingRate?: number | null; /** * Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ - volumeGainDb?: number; + volumeGainDb?: number | null; } /** * The message returned to the client by the `ListVoices` method. @@ -164,11 +164,11 @@ export namespace texttospeech_v1 { /** * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](/speech/text-to-speech/docs/ssml). */ - ssml?: string; + ssml?: string | null; /** * The raw text to be synthesized. */ - text?: string; + text?: string | null; } /** * The top-level message sent by the client for the `SynthesizeSpeech` method. @@ -194,7 +194,7 @@ export namespace texttospeech_v1 { /** * The audio data bytes encoded as specified in the request, including the header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ - audioContent?: string; + audioContent?: string | null; } /** * Description of a voice supported by the TTS service. @@ -203,19 +203,19 @@ export namespace texttospeech_v1 { /** * The languages that this voice supports, expressed as [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw"). */ - languageCodes?: string[]; + languageCodes?: string[] | null; /** * The name of this voice. Each distinct voice has a unique name. */ - name?: string; + name?: string | null; /** * The natural sample rate (in hertz) for this voice. */ - naturalSampleRateHertz?: number; + naturalSampleRateHertz?: number | null; /** * The gender of this voice. */ - ssmlGender?: string; + ssmlGender?: string | null; } /** * Description of which voice to use for a synthesis request. @@ -224,15 +224,15 @@ export namespace texttospeech_v1 { /** * The language (and optionally also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". Required. This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". */ - languageCode?: string; + languageCode?: string | null; /** * The name of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and gender. */ - name?: string; + name?: string | null; /** * The preferred gender of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ - ssmlGender?: string; + ssmlGender?: string | null; } export class Resource$Text { diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 08540efd02d..648e0af854d 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -126,27 +126,27 @@ export namespace texttospeech_v1beta1 { /** * Required. The format of the audio byte stream. */ - audioEncoding?: string; + audioEncoding?: string | null; /** * Optional. Input only. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. See [audio profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. */ - effectsProfileId?: string[]; + effectsProfileId?: string[] | null; /** * Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ - pitch?: number; + pitch?: number | null; /** * The synthesis sample rate (in hertz) for this audio. Optional. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ - sampleRateHertz?: number; + sampleRateHertz?: number | null; /** * Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ - speakingRate?: number; + speakingRate?: number | null; /** * Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ - volumeGainDb?: number; + volumeGainDb?: number | null; } /** * The message returned to the client by the `ListVoices` method. @@ -164,11 +164,11 @@ export namespace texttospeech_v1beta1 { /** * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](/speech/text-to-speech/docs/ssml). */ - ssml?: string; + ssml?: string | null; /** * The raw text to be synthesized. */ - text?: string; + text?: string | null; } /** * The top-level message sent by the client for the `SynthesizeSpeech` method. @@ -194,7 +194,7 @@ export namespace texttospeech_v1beta1 { /** * The audio data bytes encoded as specified in the request, including the header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ - audioContent?: string; + audioContent?: string | null; } /** * Description of a voice supported by the TTS service. @@ -203,19 +203,19 @@ export namespace texttospeech_v1beta1 { /** * The languages that this voice supports, expressed as [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw"). */ - languageCodes?: string[]; + languageCodes?: string[] | null; /** * The name of this voice. Each distinct voice has a unique name. */ - name?: string; + name?: string | null; /** * The natural sample rate (in hertz) for this voice. */ - naturalSampleRateHertz?: number; + naturalSampleRateHertz?: number | null; /** * The gender of this voice. */ - ssmlGender?: string; + ssmlGender?: string | null; } /** * Description of which voice to use for a synthesis request. @@ -224,15 +224,15 @@ export namespace texttospeech_v1beta1 { /** * The language (and optionally also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". Required. This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". */ - languageCode?: string; + languageCode?: string | null; /** * The name of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and gender. */ - name?: string; + name?: string | null; /** * The preferred gender of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ - ssmlGender?: string; + ssmlGender?: string | null; } export class Resource$Text { diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 7f7aa4e777d..1bec68621e5 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -108,19 +108,19 @@ export namespace toolresults_v1beta3 { /** * The name of the app. Optional */ - name?: string; + name?: string | null; /** * The package name of the app. Required. */ - packageName?: string; + packageName?: string | null; /** * The internal version code of the app. Optional. */ - versionCode?: string; + versionCode?: string | null; /** * The version name of the app. Optional. */ - versionName?: string; + versionName?: string | null; } /** * A test of an Android application that can control an Android component independently of its normal lifecycle. See for more information on types of Android tests. @@ -129,19 +129,19 @@ export namespace toolresults_v1beta3 { /** * The java package for the test to be executed. Required */ - testPackageId?: string; + testPackageId?: string | null; /** * The InstrumentationTestRunner class. Required */ - testRunnerClass?: string; + testRunnerClass?: string | null; /** * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. */ - testTargets?: string[]; + testTargets?: string[] | null; /** * The flag indicates whether Android Test Orchestrator will be used to run test or not. */ - useOrchestrator?: boolean; + useOrchestrator?: boolean | null; } /** * A test of an android application that explores the application on a virtual or physical Android device, finding culprits and crashes as it goes. @@ -150,23 +150,23 @@ export namespace toolresults_v1beta3 { /** * The initial activity that should be used to start the app. Optional */ - appInitialActivity?: string; + appInitialActivity?: string | null; /** * The java package for the bootstrap. Optional */ - bootstrapPackageId?: string; + bootstrapPackageId?: string | null; /** * The runner class for the bootstrap. Optional */ - bootstrapRunnerClass?: string; + bootstrapRunnerClass?: string | null; /** * The max depth of the traversal stack Robo can explore. Optional */ - maxDepth?: number; + maxDepth?: number | null; /** * The max number of steps/actions Robo can execute. Default is no limit (0). Optional */ - maxSteps?: number; + maxSteps?: number | null; } /** * An Android mobile test specification. @@ -196,11 +196,11 @@ export namespace toolresults_v1beta3 { /** * A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. */ - typeUrl?: string; + typeUrl?: string | null; /** * Must be a valid serialized protocol buffer of the above specified type. */ - value?: string; + value?: string | null; } export interface Schema$AppStartTime { /** @@ -216,9 +216,9 @@ export namespace toolresults_v1beta3 { * Encapsulates the metadata for basic sample series represented by a line chart */ export interface Schema$BasicPerfSampleSeries { - perfMetricType?: string; - perfUnit?: string; - sampleSeriesLabel?: string; + perfMetricType?: string | null; + perfUnit?: string | null; + sampleSeriesLabel?: string | null; } /** * The request must provide up to a maximum of 5000 samples to be created; a larger sample size will cause an INVALID_ARGUMENT error @@ -236,15 +236,15 @@ export namespace toolresults_v1beta3 { /** * description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A' */ - cpuProcessor?: string; + cpuProcessor?: string | null; /** * the CPU clock speed in GHz */ - cpuSpeedInGhz?: number; + cpuSpeedInGhz?: number | null; /** * the number of CPU cores */ - numberOfCores?: number; + numberOfCores?: number | null; } /** * A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # Examples Example 1: Compute Duration from two Timestamps in pseudo code. Timestamp start = ...; Timestamp end = ...; Duration duration = ...; duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos; if (duration.seconds 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end = ...; end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos; if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; } Example 3: Compute Duration from datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s". @@ -253,11 +253,11 @@ export namespace toolresults_v1beta3 { /** * Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive. */ - nanos?: number; + nanos?: number | null; /** * Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years */ - seconds?: string; + seconds?: 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. @@ -274,7 +274,7 @@ export namespace toolresults_v1beta3 { /** * A unique identifier within a History for this Execution. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create/update request: never set */ - executionId?: string; + executionId?: string | null; /** * Classify the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional */ @@ -286,11 +286,11 @@ export namespace toolresults_v1beta3 { /** * The initial state is IN_PROGRESS. The only legal state transitions is from IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if an invalid transition is requested. The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times. If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE. - In response always set - In create/update request: optional */ - state?: string; + state?: string | null; /** * TestExecution Matrix ID that the TestExecutionService uses. - In response: present if set by create - In create: optional - In update: never set */ - testExecutionMatrixId?: string; + testExecutionMatrixId?: string | null; } /** * Details for an outcome with a FAILURE outcome summary. @@ -299,23 +299,23 @@ export namespace toolresults_v1beta3 { /** * If the failure was severe because the system (app) under test crashed. */ - crashed?: boolean; + crashed?: boolean | null; /** * If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform. */ - notInstalled?: boolean; + notInstalled?: boolean | null; /** * If a native process (including any other than the app) crashed. */ - otherNativeCrash?: boolean; + otherNativeCrash?: boolean | null; /** * If the test overran some time limit, and that is why it failed. */ - timedOut?: boolean; + timedOut?: boolean | null; /** * If the robo was unable to crawl the app; perhaps because the app did not start. */ - unableToCrawl?: boolean; + unableToCrawl?: boolean | null; } /** * A reference to a file. @@ -324,7 +324,7 @@ export namespace toolresults_v1beta3 { /** * The URI of a file stored in Google Cloud Storage. For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000 An INVALID_ARGUMENT error will be returned if the URI format is not supported. - In response: always set - In create/update request: always set */ - fileUri?: string; + fileUri?: string | null; } /** * Graphics statistics for the App. The information is collected from 'adb shell dumpsys graphicsstats'. For more info see: https://developer.android.com/training/testing/performance.html Statistics will only be present for API 23+. @@ -337,57 +337,57 @@ export namespace toolresults_v1beta3 { /** * Total "high input latency" events. */ - highInputLatencyCount?: string; + highInputLatencyCount?: string | null; /** * Total frames with slow render time. Should be <= total_frames. */ - jankyFrames?: string; + jankyFrames?: string | null; /** * Total "missed vsync" events. */ - missedVsyncCount?: string; + missedVsyncCount?: string | null; /** * 50th percentile frame render time in milliseconds. */ - p50Millis?: string; + p50Millis?: string | null; /** * 90th percentile frame render time in milliseconds. */ - p90Millis?: string; + p90Millis?: string | null; /** * 95th percentile frame render time in milliseconds. */ - p95Millis?: string; + p95Millis?: string | null; /** * 99th percentile frame render time in milliseconds. */ - p99Millis?: string; + p99Millis?: string | null; /** * Total "slow bitmap upload" events. */ - slowBitmapUploadCount?: string; + slowBitmapUploadCount?: string | null; /** * Total "slow draw" events. */ - slowDrawCount?: string; + slowDrawCount?: string | null; /** * Total "slow UI thread" events. */ - slowUiThreadCount?: string; + slowUiThreadCount?: string | null; /** * Total frames rendered by package. */ - totalFrames?: string; + totalFrames?: string | null; } export interface Schema$GraphicsStatsBucket { /** * Number of frames in the bucket. */ - frameCount?: string; + frameCount?: string | null; /** * Lower bound of render time in milliseconds. */ - renderMillis?: string; + renderMillis?: string | null; } /** * A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build. Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch. @@ -396,15 +396,15 @@ export namespace toolresults_v1beta3 { /** * A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional */ - displayName?: string; + displayName?: string | null; /** * A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set */ - historyId?: string; + historyId?: string | null; /** * A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set */ - name?: string; + name?: string | null; } /** * An image, with a link to the main image and a thumbnail. @@ -421,7 +421,7 @@ export namespace toolresults_v1beta3 { /** * The step to which the image is attached. Always set. */ - stepId?: string; + stepId?: string | null; /** * The thumbnail. */ @@ -434,15 +434,15 @@ export namespace toolresults_v1beta3 { /** * If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running. */ - abortedByUser?: boolean; + abortedByUser?: boolean | null; /** * If results are being provided to the user in certain cases of infrastructure failures */ - hasErrorLogs?: boolean; + hasErrorLogs?: boolean | null; /** * If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed. For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail. */ - infrastructureFailure?: boolean; + infrastructureFailure?: boolean | null; } /** * Step Id and outcome of each individual step that was run as a group with other steps with the same configuration. @@ -451,13 +451,13 @@ export namespace toolresults_v1beta3 { /** * Unique int given to each step. Ranges from 0(inclusive) to total number of steps(exclusive). The primary step is 0. */ - multistepNumber?: number; - outcomeSummary?: string; + multistepNumber?: number | null; + outcomeSummary?: string | null; /** * How long it took for this step to run. */ runDuration?: Schema$Duration; - stepId?: string; + stepId?: string | null; } export interface Schema$ListExecutionsResponse { /** @@ -467,7 +467,7 @@ export namespace toolresults_v1beta3 { /** * A continuation token to resume the query at the next item. Will only be set if there are more Executions to fetch. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for HistoryService.List @@ -480,7 +480,7 @@ export namespace toolresults_v1beta3 { /** * A continuation token to resume the query at the next item. Will only be set if there are more histories to fetch. Tokens are valid for up to one hour from the time of the first list request. For instance, if you make a list request at 1PM and use the token from this first request 10 minutes later, the token from this second response will only be valid for 50 minutes. */ - nextPageToken?: string; + nextPageToken?: string | null; } export interface Schema$ListPerfSampleSeriesResponse { /** @@ -492,7 +492,7 @@ export namespace toolresults_v1beta3 { /** * Optional, returned if result size exceeds the page size specified in the request (or the default page size, 500, if unspecified). It indicates the last sample timestamp to be used as page_token in subsequent request */ - nextPageToken?: string; + nextPageToken?: string | null; perfSamples?: Schema$PerfSample[]; } export interface Schema$ListScreenshotClustersResponse { @@ -508,7 +508,7 @@ export namespace toolresults_v1beta3 { /** * A continuation token to resume the query at the next item. If set, indicates that there are more steps to read, by calling list again with this value in the page_token field. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Steps. */ @@ -521,7 +521,7 @@ export namespace toolresults_v1beta3 { /** * A continuation token to resume the query at the next item. If set, indicates that there are more thumbnails to read, by calling list again with this value in the page_token field. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of image data. Images are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep). */ @@ -531,7 +531,7 @@ export namespace toolresults_v1beta3 { * Response message for StepService.ListTestCases. */ export interface Schema$ListTestCasesResponse { - nextPageToken?: string; + nextPageToken?: string | null; /** * List of test cases. */ @@ -541,11 +541,11 @@ export namespace toolresults_v1beta3 { /** * Maximum memory that can be allocated to the process in KiB */ - memoryCapInKibibyte?: string; + memoryCapInKibibyte?: string | null; /** * Total memory available on the device in KiB */ - memoryTotalInKibibyte?: string; + memoryTotalInKibibyte?: string | null; } /** * Details when multiple steps are run with the same configuration as a group. @@ -554,7 +554,7 @@ export namespace toolresults_v1beta3 { /** * Unique int given to each step. Ranges from 0(inclusive) to total number of steps(exclusive). The primary step is 0. */ - multistepNumber?: number; + multistepNumber?: number | null; /** * Present if it is a primary (original) step. */ @@ -562,7 +562,7 @@ export namespace toolresults_v1beta3 { /** * Step Id of the primary (original) step, which might be this step. */ - primaryStepId?: string; + primaryStepId?: string | null; } /** * Interprets a result so that humans and machines can act on it. @@ -587,7 +587,7 @@ export namespace toolresults_v1beta3 { /** * The simplest way to interpret a result. Required */ - summary?: string; + summary?: string | null; } /** * Encapsulates performance environment info @@ -610,7 +610,7 @@ export namespace toolresults_v1beta3 { /** * A tool results execution ID. */ - executionId?: string; + executionId?: string | null; /** * Graphics statistics for the entire run. Statistics are reset at the beginning of the run and collected at the end of the run. */ @@ -618,7 +618,7 @@ export namespace toolresults_v1beta3 { /** * A tool results history ID. */ - historyId?: string; + historyId?: string | null; /** * Describes the environment in which the performance metrics were collected */ @@ -626,15 +626,15 @@ export namespace toolresults_v1beta3 { /** * Set of resource collected */ - perfMetrics?: string[]; + perfMetrics?: string[] | null; /** * The cloud project */ - projectId?: string; + projectId?: string | null; /** * A tool results step ID. */ - stepId?: string; + stepId?: string | null; } /** * Resource representing a single performance measure or data point @@ -647,7 +647,7 @@ export namespace toolresults_v1beta3 { /** * Value observed */ - value?: number; + value?: number | null; } /** * Resource representing a collection of performance samples (or data points) @@ -660,23 +660,23 @@ export namespace toolresults_v1beta3 { /** * A tool results execution ID. */ - executionId?: string; + executionId?: string | null; /** * A tool results history ID. */ - historyId?: string; + historyId?: string | null; /** * The cloud project */ - projectId?: string; + projectId?: string | null; /** * A sample series id */ - sampleSeriesId?: string; + sampleSeriesId?: string | null; /** * A tool results step ID. */ - stepId?: string; + stepId?: string | null; } /** * Stores rollup test status of multiple steps that were run as a group and outcome of each individual step. @@ -689,7 +689,7 @@ export namespace toolresults_v1beta3 { /** * Rollup test status of multiple steps that were run with the same configuration as a group. */ - rollUp?: string; + rollUp?: string | null; } /** * Per-project settings for the Tool Results service. @@ -698,11 +698,11 @@ export namespace toolresults_v1beta3 { /** * The name of the Google Cloud Storage bucket to which results are written. By default, this is unset. In update request: optional In response: optional */ - defaultBucket?: string; + defaultBucket?: string | null; /** * The name of the project's settings. Always of the form: projects/{project-id}/settings In update request: never set In response: always set */ - name?: string; + name?: string | null; } /** * Request message for StepService.PublishXunitXmlFiles. @@ -717,29 +717,29 @@ export namespace toolresults_v1beta3 { /** * File reference of the png file. Required. */ - fileReference?: string; + fileReference?: string | null; /** * Locale of the device that the screenshot was taken on. Required. */ - locale?: string; + locale?: string | null; /** * Model of the device that the screenshot was taken on. Required. */ - model?: string; + model?: string | null; /** * OS version of the device that the screenshot was taken on. Required. */ - version?: string; + version?: string | null; } export interface Schema$ScreenshotCluster { /** * A string that describes the activity of every screen in the cluster. */ - activity?: string; + activity?: string | null; /** * A unique identifier for the cluster. */ - clusterId?: string; + clusterId?: string | null; /** * A singular screen that represents the cluster as a whole. This screen will act as the "cover" of the entire cluster. When users look at the clusters, only the key screen from each cluster will be shown. Which screen is the key screen is determined by the ClusteringAlgorithm */ @@ -756,15 +756,15 @@ export namespace toolresults_v1beta3 { /** * If the App doesn't support the specific API level. */ - incompatibleAppVersion?: boolean; + incompatibleAppVersion?: boolean | null; /** * If the App doesn't run on the specific architecture, for example, x86. */ - incompatibleArchitecture?: boolean; + incompatibleArchitecture?: boolean | null; /** * If the requested OS version doesn't run on the specific device model. */ - incompatibleDevice?: boolean; + incompatibleDevice?: boolean | null; } /** * The details about how to run the execution. @@ -782,7 +782,7 @@ export namespace toolresults_v1beta3 { /** * The stack trace message. Required */ - exception?: string; + exception?: 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). @@ -791,7 +791,7 @@ export namespace toolresults_v1beta3 { /** * The status code, which should be an enum value of [google.rpc.Code][]. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ @@ -799,7 +799,7 @@ export namespace toolresults_v1beta3 { /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][] field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 23 @@ -816,7 +816,7 @@ export namespace toolresults_v1beta3 { /** * A description of this tool For example: mvn clean package -D skipTests=true - In response: present if set by create/update request - In create/update request: optional */ - description?: string; + description?: string | null; /** * How much the device resource is used to perform the test. This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage. PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set. - In response: present if previously set. - In create request: optional - In update request: optional */ @@ -828,7 +828,7 @@ export namespace toolresults_v1beta3 { /** * Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails. - In response: always set - In create/update request: never set */ - hasImages?: boolean; + hasImages?: boolean | null; /** * Arbitrary user-supplied key/value pairs that are associated with the step. Users are responsible for managing the key namespace such that keys don't accidentally collide. An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters. - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value */ @@ -840,7 +840,7 @@ export namespace toolresults_v1beta3 { /** * A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name. - In response: always set - In create request: always set - In update request: never set */ - name?: string; + name?: string | null; /** * Classification of the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional */ @@ -852,11 +852,11 @@ export namespace toolresults_v1beta3 { /** * The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE A PRECONDITION_FAILED will be returned if an invalid transition is requested. It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times. - In response: always set - In create/update request: optional */ - state?: string; + state?: string | null; /** * A unique identifier within a Execution for this Step. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response: always set - In create/update request: never set */ - stepId?: string; + stepId?: string | null; /** * An execution of a test runner. */ @@ -867,12 +867,12 @@ export namespace toolresults_v1beta3 { toolExecutionStep?: Schema$ToolExecutionStep; } export interface Schema$StepDimensionValueEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } export interface Schema$StepLabelsEntry { - key?: string; - value?: string; + key?: string | null; + value?: string | null; } /** * Details for an outcome with a SUCCESS outcome summary. @@ -881,7 +881,7 @@ export namespace toolresults_v1beta3 { /** * If a native process other than the app crashed. */ - otherNativeCrash?: boolean; + otherNativeCrash?: boolean | null; } export interface Schema$TestCase { /** @@ -895,7 +895,7 @@ export namespace toolresults_v1beta3 { /** * Why the test case was skipped. Present only for skipped test case */ - skippedMessage?: string; + skippedMessage?: string | null; /** * The stack trace details if the test case failed or encountered an error. The maximum size of the stack traces is 100KiB, beyond which the stack track will be truncated. Zero if the test case passed. */ @@ -907,11 +907,11 @@ export namespace toolresults_v1beta3 { /** * The status of the test case. Required. */ - status?: string; + status?: string | null; /** * A unique identifier within a Step for this Test Case. */ - testCaseId?: string; + testCaseId?: string | null; /** * Test case reference, e.g. name, class name and test suite name. Required. */ @@ -928,15 +928,15 @@ export namespace toolresults_v1beta3 { /** * The name of the class. */ - className?: string; + className?: string | null; /** * The name of the test case. Required. */ - name?: string; + name?: string | null; /** * The name of the test suite to which this test case belongs. */ - testSuiteName?: string; + testSuiteName?: string | null; } /** * A step that represents running tests. It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted. Users can also add test results manually by using the test_result field. @@ -966,15 +966,15 @@ export namespace toolresults_v1beta3 { /** * Category of issue. Required. */ - category?: string; + category?: string | null; /** * A brief human-readable message describing the issue. Required. */ - errorMessage?: string; + errorMessage?: string | null; /** * Severity of issue. Required. */ - severity?: string; + severity?: string | null; /** * Deprecated in favor of stack trace fields inside specific warnings. */ @@ -982,7 +982,7 @@ export namespace toolresults_v1beta3 { /** * Type of issue. Required. */ - type?: string; + type?: string | null; /** * Warning message with additional details of the issue. Should always be a message from com.google.devtools.toolresults.v1.warnings */ @@ -999,23 +999,23 @@ export namespace toolresults_v1beta3 { /** * Number of test cases in error, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never */ - errorCount?: number; + errorCount?: number | null; /** * 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; + failureCount?: number | null; /** * The name of the test suite. - In create/response: always set - In update request: never */ - name?: string; + name?: string | null; /** * Number of test cases not run, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never */ - skippedCount?: number; + skippedCount?: number | null; /** * Number of test cases, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never */ - totalCount?: number; + totalCount?: number | null; /** * If this test suite was parsed from XML, this is the URI where the original XML file is stored. Note: Multiple test suites can share the same xml_source Returns INVALID_ARGUMENT if the uri format is not supported. - In create/response: optional - In update request: never */ @@ -1037,19 +1037,19 @@ export namespace toolresults_v1beta3 { /** * The thumbnail's content type, i.e. "image/png". Always set. */ - contentType?: string; + contentType?: string | null; /** * The thumbnail file itself. That is, the bytes here are precisely the bytes that make up the thumbnail file; they can be served as an image as-is (with the appropriate content type.) Always set. */ - data?: string; + data?: string | null; /** * The height of the thumbnail, in pixels. Always set. */ - heightPx?: number; + heightPx?: number | null; /** * The width of the thumbnail, in pixels. Always set. */ - widthPx?: number; + widthPx?: number | 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. @@ -1058,11 +1058,11 @@ export namespace toolresults_v1beta3 { /** * 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; + 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; + seconds?: string | null; } /** * An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. @@ -1071,7 +1071,7 @@ export namespace toolresults_v1beta3 { /** * The full tokenized command line including the program name (equivalent to argv in a C program). - In response: present if set by create request - In create request: optional - In update request: never set */ - commandLineArguments?: string[]; + commandLineArguments?: string[] | null; /** * Tool execution exit code. This field will be set once the tool has exited. - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set. */ @@ -1101,7 +1101,7 @@ export namespace toolresults_v1beta3 { /** * Tool execution exit code. A value of 0 means that the execution was successful. - In response: always set - In create/update request: always set */ - number?: number; + number?: number | null; } /** * A reference to a ToolExecution output file. diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index 2fe0a1b7762..cc2dd587267 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -124,11 +124,11 @@ export namespace tpu_v1 { /** * The resource name. */ - name?: string; + name?: string | null; /** * the accelerator type. */ - type?: string; + type?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -145,11 +145,11 @@ export namespace tpu_v1 { /** * The next page token or empty if none. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -162,7 +162,7 @@ export namespace tpu_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for ListNodes. @@ -171,7 +171,7 @@ export namespace tpu_v1 { /** * The next page token or empty if none. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The listed nodes. */ @@ -179,7 +179,7 @@ export namespace tpu_v1 { /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Operations.ListOperations. @@ -188,7 +188,7 @@ export namespace tpu_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -201,7 +201,7 @@ export namespace tpu_v1 { /** * The next page token or empty if none. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The listed nodes. */ @@ -209,7 +209,7 @@ export namespace tpu_v1 { /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * A resource that represents Google Cloud Platform location. @@ -218,23 +218,23 @@ export namespace tpu_v1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * A network endpoint over which a TPU worker can be reached. @@ -243,11 +243,11 @@ export namespace tpu_v1 { /** * The IP address of this network endpoint. */ - ipAddress?: string; + ipAddress?: string | null; /** * The port of this network endpoint. */ - port?: number; + port?: number | null; } /** * A TPU instance. @@ -256,43 +256,43 @@ export namespace tpu_v1 { /** * The type of hardware accelerators associated with this node. Required. */ - acceleratorType?: string; + acceleratorType?: string | null; /** * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Required. */ - cidrBlock?: string; + cidrBlock?: string | null; /** * Output only. The time when the node was created. */ - createTime?: string; + createTime?: string | null; /** * The user-supplied description of the TPU. Maximum of 512 characters. */ - description?: string; + description?: string | null; /** * The health status of the TPU node. */ - health?: string; + health?: string | null; /** * Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. */ - healthDescription?: string; + healthDescription?: string | null; /** * Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. */ - ipAddress?: string; + ipAddress?: string | null; /** * Resource labels to represent user-provided metadata. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The immutable name of the TPU */ - name?: string; + name?: string | null; /** * The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. */ - network?: string; + network?: string | null; /** * Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first. */ @@ -300,20 +300,20 @@ export namespace tpu_v1 { /** * Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. */ - port?: string; + port?: string | null; schedulingConfig?: Schema$SchedulingConfig; /** * Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Output only. The current state for the TPU Node. */ - state?: string; + state?: string | null; /** * The version of Tensorflow running in the Node. Required. */ - tensorflowVersion?: string; + tensorflowVersion?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -322,7 +322,7 @@ export namespace tpu_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -330,15 +330,15 @@ export namespace tpu_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Represents the metadata of the long-running operation. @@ -347,31 +347,31 @@ export namespace tpu_v1 { /** * [Output only] API version used to start the operation. */ - apiVersion?: string; + apiVersion?: string | null; /** * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ - cancelRequested?: boolean; + cancelRequested?: boolean | null; /** * [Output only] The time the operation was created. */ - createTime?: string; + createTime?: string | null; /** * [Output only] The time the operation finished running. */ - endTime?: string; + endTime?: string | null; /** * [Output only] Human-readable status of the operation, if any. */ - statusDetail?: string; + statusDetail?: string | null; /** * [Output only] Server-defined resource path for the target of the operation. */ - target?: string; + target?: string | null; /** * [Output only] Name of the verb executed by the operation. */ - verb?: string; + verb?: string | null; } /** * Request for ReimageNode. @@ -380,14 +380,14 @@ export namespace tpu_v1 { /** * The version for reimage to create. */ - tensorflowVersion?: string; + tensorflowVersion?: string | null; } export interface Schema$SchedulingConfig { - preemptible?: boolean; + preemptible?: boolean | null; /** * Whether the node is created under a reservation. */ - reserved?: boolean; + reserved?: boolean | null; } /** * Request for StartNode. @@ -400,15 +400,15 @@ export namespace tpu_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request for StopNode. @@ -421,11 +421,11 @@ export namespace tpu_v1 { /** * The resource name. */ - name?: string; + name?: string | null; /** * the tensorflow version. */ - version?: string; + version?: string | null; } export class Resource$Projects { diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index 6cd00bad9bb..c8914234889 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -124,11 +124,11 @@ export namespace tpu_v1alpha1 { /** * The resource name. */ - name?: string; + name?: string | null; /** * the accelerator type. */ - type?: string; + type?: string | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -145,11 +145,11 @@ export namespace tpu_v1alpha1 { /** * The next page token or empty if none. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -162,7 +162,7 @@ export namespace tpu_v1alpha1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for ListNodes. @@ -171,7 +171,7 @@ export namespace tpu_v1alpha1 { /** * The next page token or empty if none. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The listed nodes. */ @@ -179,7 +179,7 @@ export namespace tpu_v1alpha1 { /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * The response message for Operations.ListOperations. @@ -188,7 +188,7 @@ export namespace tpu_v1alpha1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -201,7 +201,7 @@ export namespace tpu_v1alpha1 { /** * The next page token or empty if none. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The listed nodes. */ @@ -209,7 +209,7 @@ export namespace tpu_v1alpha1 { /** * Locations that could not be reached. */ - unreachable?: string[]; + unreachable?: string[] | null; } /** * A resource that represents Google Cloud Platform location. @@ -218,23 +218,23 @@ export namespace tpu_v1alpha1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * A network endpoint over which a TPU worker can be reached. @@ -243,11 +243,11 @@ export namespace tpu_v1alpha1 { /** * The IP address of this network endpoint. */ - ipAddress?: string; + ipAddress?: string | null; /** * The port of this network endpoint. */ - port?: number; + port?: number | null; } /** * A TPU instance. @@ -256,43 +256,43 @@ export namespace tpu_v1alpha1 { /** * The type of hardware accelerators associated with this node. Required. */ - acceleratorType?: string; + acceleratorType?: string | null; /** * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Required. */ - cidrBlock?: string; + cidrBlock?: string | null; /** * Output only. The time when the node was created. */ - createTime?: string; + createTime?: string | null; /** * The user-supplied description of the TPU. Maximum of 512 characters. */ - description?: string; + description?: string | null; /** * The health status of the TPU node. */ - health?: string; + health?: string | null; /** * Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. */ - healthDescription?: string; + healthDescription?: string | null; /** * Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. */ - ipAddress?: string; + ipAddress?: string | null; /** * Resource labels to represent user-provided metadata. */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * Output only. The immutable name of the TPU */ - name?: string; + name?: string | null; /** * The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. */ - network?: string; + network?: string | null; /** * Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first. */ @@ -300,20 +300,20 @@ export namespace tpu_v1alpha1 { /** * Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. */ - port?: string; + port?: string | null; schedulingConfig?: Schema$SchedulingConfig; /** * Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data. */ - serviceAccount?: string; + serviceAccount?: string | null; /** * Output only. The current state for the TPU Node. */ - state?: string; + state?: string | null; /** * The version of Tensorflow running in the Node. Required. */ - tensorflowVersion?: string; + tensorflowVersion?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -322,7 +322,7 @@ export namespace tpu_v1alpha1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -330,15 +330,15 @@ export namespace tpu_v1alpha1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Represents the metadata of the long-running operation. @@ -347,31 +347,31 @@ export namespace tpu_v1alpha1 { /** * [Output only] API version used to start the operation. */ - apiVersion?: string; + apiVersion?: string | null; /** * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ - cancelRequested?: boolean; + cancelRequested?: boolean | null; /** * [Output only] The time the operation was created. */ - createTime?: string; + createTime?: string | null; /** * [Output only] The time the operation finished running. */ - endTime?: string; + endTime?: string | null; /** * [Output only] Human-readable status of the operation, if any. */ - statusDetail?: string; + statusDetail?: string | null; /** * [Output only] Server-defined resource path for the target of the operation. */ - target?: string; + target?: string | null; /** * [Output only] Name of the verb executed by the operation. */ - verb?: string; + verb?: string | null; } /** * Request for ReimageNode. @@ -380,14 +380,14 @@ export namespace tpu_v1alpha1 { /** * The version for reimage to create. */ - tensorflowVersion?: string; + tensorflowVersion?: string | null; } export interface Schema$SchedulingConfig { - preemptible?: boolean; + preemptible?: boolean | null; /** * Whether the node is created under a reservation. */ - reserved?: boolean; + reserved?: boolean | null; } /** * Request for StartNode. @@ -400,15 +400,15 @@ export namespace tpu_v1alpha1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Request for StopNode. @@ -421,11 +421,11 @@ export namespace tpu_v1alpha1 { /** * The resource name. */ - name?: string; + name?: string | null; /** * the tensorflow version. */ - version?: string; + version?: string | null; } export class Resource$Projects { diff --git a/src/apis/translate/v2.ts b/src/apis/translate/v2.ts index c2cd64a9776..12fed6c351b 100644 --- a/src/apis/translate/v2.ts +++ b/src/apis/translate/v2.ts @@ -146,7 +146,7 @@ export namespace translate_v2 { /** * The input text upon which to perform language detection. Repeat this parameter to perform language detection on multiple text inputs. */ - q?: string[]; + q?: string[] | null; } /** * The request message for discovering supported languages. @@ -155,7 +155,7 @@ export namespace translate_v2 { /** * The language to use to return localized, human readable names of supported languages. */ - target?: string; + target?: string | null; } export interface Schema$LanguagesListResponse { /** @@ -167,11 +167,11 @@ export namespace translate_v2 { /** * Supported language code, generally consisting of its ISO 639-1 identifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes including language + region identifiers are returned (e.g. 'zh-TW' and 'zh-CH') */ - language?: string; + language?: string | null; /** * Human readable name of the language localized to the target language. */ - name?: string; + name?: string | null; } /** * The main translation request message for the Cloud Translation API. @@ -180,23 +180,23 @@ export namespace translate_v2 { /** * The format of the source text, in either HTML (default) or plain-text. A value of "html" indicates HTML and a value of "text" indicates plain-text. */ - format?: string; + format?: string | null; /** * The `model` type requested for this translation. Valid values are listed in public documentation. */ - model?: string; + model?: string | null; /** * The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs. */ - q?: string[]; + q?: string[] | null; /** * The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to identify the source language automatically and return it within the response. */ - source?: string; + source?: string | null; /** * The language to use for translation of the input text, set to one of the language codes listed in Language Support. */ - target?: string; + target?: string | null; } /** * The main language translation response message. @@ -211,15 +211,15 @@ export namespace translate_v2 { /** * The source language of the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language will not occur and this field will be empty. */ - detectedSourceLanguage?: string; + detectedSourceLanguage?: string | null; /** * The `model` type used for this translation. Valid values are listed in public documentation. Can be different from requested `model`. Present only if specific model type was explicitly requested. */ - model?: string; + model?: string | null; /** * Text translated into the target language. */ - translatedText?: string; + translatedText?: string | null; } export class Resource$Detections { diff --git a/src/apis/translate/v3beta1.ts b/src/apis/translate/v3beta1.ts index 6459deeec08..ca3bba3dce7 100644 --- a/src/apis/translate/v3beta1.ts +++ b/src/apis/translate/v3beta1.ts @@ -124,15 +124,19 @@ export namespace translate_v3beta1 { /** * Optional. Glossaries to be applied for translation. It's keyed by target language code. */ - glossaries?: {[key: string]: Schema$TranslateTextGlossaryConfig}; + glossaries?: {[key: string]: Schema$TranslateTextGlossaryConfig} | null; /** * Required. Input configurations. The total number of files matched should be <= 1000. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding. */ inputConfigs?: Schema$InputConfig[]; + /** + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://goo.gl/xmQnxf for more information on and examples of labels. + */ + labels?: {[key: string]: string} | null; /** * Optional. The models to use for translation. Map's key is target language code. Map's value is model name. Value can be a built-in general model, or an AutoML Translation model. The value format depends on model type: - AutoML Translation models: `projects/{project-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-id}/locations/{location-id}/models/general/base` If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used. */ - models?: {[key: string]: string}; + models?: {[key: string]: string} | null; /** * Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs. */ @@ -140,11 +144,11 @@ export namespace translate_v3beta1 { /** * Required. Source language code. */ - sourceLanguageCode?: string; + sourceLanguageCode?: string | null; /** * Required. Specify up to 10 language codes here. */ - targetLanguageCodes?: string[]; + targetLanguageCodes?: string[] | null; } /** * The request message for Operations.CancelOperation. @@ -157,11 +161,11 @@ export namespace translate_v3beta1 { /** * The confidence of the detection result for this language. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code of source content in the request, detected automatically. */ - languageCode?: string; + languageCode?: string | null; } /** * The request message for language detection. @@ -170,15 +174,19 @@ export namespace translate_v3beta1 { /** * The content of the input stored as a string. */ - content?: string; + content?: string | null; + /** + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://goo.gl/xmQnxf for more information on and examples of labels. + */ + labels?: {[key: string]: string} | null; /** * Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". */ - mimeType?: string; + mimeType?: string | null; /** * Optional. The language detection model to be used. Format: `projects/{project-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used. */ - model?: string; + model?: string | null; } /** * The response message for language detection. @@ -200,7 +208,7 @@ export namespace translate_v3beta1 { /** * Required. There must be no files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and start with "gs://", otherwise an INVALID_ARGUMENT (400) error is returned. */ - outputUriPrefix?: string; + outputUriPrefix?: string | null; } /** * The Google Cloud Storage location for the input content. @@ -209,7 +217,7 @@ export namespace translate_v3beta1 { /** * Required. Source data URI. For example, `gs://my_bucket/my_object`. */ - inputUri?: string; + inputUri?: string | null; } /** * Represents a glossary built from user provided data. @@ -218,11 +226,11 @@ export namespace translate_v3beta1 { /** * Output only. When the glossary creation was finished. */ - endTime?: string; + endTime?: string | null; /** * Output only. The number of entries defined in the glossary. */ - entryCount?: number; + entryCount?: number | null; /** * Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints. */ @@ -238,11 +246,11 @@ export namespace translate_v3beta1 { /** * Required. The resource name of the glossary. Glossary names have the form `projects/{project-id}/locations/{location-id}/glossaries/{glossary-id}`. */ - name?: string; + name?: string | null; /** * Output only. When CreateGlossary was called. */ - submitTime?: string; + submitTime?: string | null; } /** * Input configuration for glossaries. @@ -264,7 +272,7 @@ export namespace translate_v3beta1 { /** * Optional. Can be "text/plain" or "text/html". For `.tsv`, "text/html" is used if mime_type is missing. For `.html`, this field must be "text/html" or empty. For `.txt`, this field must be "text/plain" or empty. */ - mimeType?: string; + mimeType?: string | null; } /** * Used with unidirectional glossaries. @@ -273,11 +281,11 @@ export namespace translate_v3beta1 { /** * Required. The BCP-47 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code. */ - sourceLanguageCode?: string; + sourceLanguageCode?: string | null; /** * Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. */ - targetLanguageCode?: string; + targetLanguageCode?: string | null; } /** * Used with equivalent term set glossaries. @@ -286,7 +294,7 @@ export namespace translate_v3beta1 { /** * The BCP-47 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code. */ - languageCodes?: string[]; + languageCodes?: string[] | null; } /** * Response message for ListGlossaries. @@ -299,7 +307,7 @@ export namespace translate_v3beta1 { /** * A token to retrieve a page of results. Pass this value in the [ListGlossariesRequest.page_token] field in the subsequent call to `ListGlossaries` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Locations.ListLocations. @@ -312,7 +320,7 @@ export namespace translate_v3beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Operations.ListOperations. @@ -321,7 +329,7 @@ export namespace translate_v3beta1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -334,23 +342,23 @@ export namespace translate_v3beta1 { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ - displayName?: string; + displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ - labels?: {[key: string]: string}; + labels?: {[key: string]: string} | null; /** * The canonical id for this location. For example: `"us-east1"`. */ - locationId?: string; + locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ - metadata?: {[key: string]: any}; + 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; + name?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -359,7 +367,7 @@ export namespace translate_v3beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -367,15 +375,15 @@ export namespace translate_v3beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Output configuration for BatchTranslateText request. @@ -393,15 +401,15 @@ export namespace translate_v3beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A single supported language response corresponds to information related to one supported language. @@ -410,19 +418,19 @@ export namespace translate_v3beta1 { /** * Human readable name of the language localized in the display language specified in the request. */ - displayName?: string; + displayName?: string | null; /** * Supported language code, generally consisting of its ISO 639-1 identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes including language and region identifiers are returned (for example, 'zh-TW' and 'zh-CN') */ - languageCode?: string; + languageCode?: string | null; /** * Can be used as source language. */ - supportSource?: boolean; + supportSource?: boolean | null; /** * Can be used as target language. */ - supportTarget?: boolean; + supportTarget?: boolean | null; } /** * The response message for discovering supported languages. @@ -440,11 +448,11 @@ export namespace translate_v3beta1 { /** * Required. Specifies the glossary used for this translation. Use this format: projects/x/locations/x/glossaries/* */ - glossary?: string; + glossary?: string | null; /** * Optional. Indicates match is case-insensitive. Default value is false if missing. */ - ignoreCase?: boolean; + ignoreCase?: boolean | null; } /** * The request message for synchronous translation. @@ -453,27 +461,31 @@ export namespace translate_v3beta1 { /** * Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. Use BatchTranslateText for larger text. */ - contents?: string[]; + contents?: string[] | null; /** * Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned. */ glossaryConfig?: Schema$TranslateTextGlossaryConfig; + /** + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://goo.gl/xmQnxf for more information on and examples of labels. + */ + labels?: {[key: string]: string} | null; /** * Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". */ - mimeType?: string; + mimeType?: string | null; /** * Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-id}/locations/{location-id}/models/general/base` For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-id}/locations/global/models/general/nmt`. If missing, the system decides which google base model to use. */ - model?: string; + model?: string | null; /** * Optional. The BCP-47 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. */ - sourceLanguageCode?: string; + sourceLanguageCode?: string | null; /** * Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in Language Support. */ - targetLanguageCode?: string; + targetLanguageCode?: string | null; } export interface Schema$TranslateTextResponse { /** @@ -492,7 +504,7 @@ export namespace translate_v3beta1 { /** * The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty. */ - detectedLanguageCode?: string; + detectedLanguageCode?: string | null; /** * The `glossary_config` used for this translation. */ @@ -500,11 +512,11 @@ export namespace translate_v3beta1 { /** * Only present when `model` is present in the request. This is same as `model` provided in the request. */ - model?: string; + model?: string | null; /** * Text translated into the target language. */ - translatedText?: string; + translatedText?: string | null; } /** * The request message for Operations.WaitOperation. @@ -513,7 +525,7 @@ export namespace translate_v3beta1 { /** * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - timeout?: string; + timeout?: string | null; } export class Resource$Projects { diff --git a/src/apis/urlshortener/v1.ts b/src/apis/urlshortener/v1.ts index 02cde3874cf..ec16ee1c38b 100644 --- a/src/apis/urlshortener/v1.ts +++ b/src/apis/urlshortener/v1.ts @@ -113,7 +113,7 @@ export namespace urlshortener_v1 { /** * Number of clicks on all goo.gl short URLs pointing to this long URL. */ - longUrlClicks?: string; + longUrlClicks?: string | null; /** * Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available. */ @@ -125,7 +125,7 @@ export namespace urlshortener_v1 { /** * Number of clicks on this short URL. */ - shortUrlClicks?: string; + shortUrlClicks?: string | null; } export interface Schema$AnalyticsSummary { /** @@ -153,11 +153,11 @@ export namespace urlshortener_v1 { /** * Number of clicks for this top entry, e.g. for this particular country or browser. */ - count?: string; + count?: string | null; /** * Label assigned to this top entry, e.g. "US" or "Chrome". */ - id?: string; + id?: string | null; } export interface Schema$Url { /** @@ -167,23 +167,23 @@ export namespace urlshortener_v1 { /** * Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00". */ - created?: string; + created?: string | null; /** * Short URL, e.g. "http://goo.gl/l6MS". */ - id?: string; + id?: string | null; /** * The fixed string "urlshortener#url". */ - kind?: string; + kind?: string | null; /** * Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED". */ - longUrl?: string; + longUrl?: string | null; /** * Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example. */ - status?: string; + status?: string | null; } export interface Schema$UrlHistory { /** @@ -193,19 +193,19 @@ export namespace urlshortener_v1 { /** * Number of items returned with each full "page" of results. Note that the last page could have fewer items than the "itemsPerPage" value. */ - itemsPerPage?: number; + itemsPerPage?: number | null; /** * The fixed string "urlshortener#urlHistory". */ - kind?: string; + kind?: string | null; /** * A token to provide to get the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * Total number of short URLs associated with this user (may be approximate). */ - totalItems?: number; + totalItems?: number | null; } export class Resource$Url { diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 5e0e87ab8ae..e5a93853ce5 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -124,7 +124,7 @@ export namespace vault_v1 { /** * A set of accounts to search. */ - emails?: string[]; + emails?: string[] | null; } /** * A status detailing the status of each account creation, and the HeldAccount, if successful. @@ -146,11 +146,11 @@ export namespace vault_v1 { /** * Account ids to identify which accounts to add. Only account_ids or only emails should be specified, but not both. */ - accountIds?: string[]; + accountIds?: string[] | null; /** * Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both. */ - emails?: string[]; + emails?: string[] | null; } /** * Response for batch create held accounts. @@ -168,7 +168,7 @@ export namespace vault_v1 { /** * Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor. */ - ccMe?: boolean; + ccMe?: boolean | null; /** * The MatterPermission to add. */ @@ -176,7 +176,7 @@ export namespace vault_v1 { /** * True to send notification email to the added account. False to not send notification email. */ - sendEmails?: boolean; + sendEmails?: boolean | null; } /** * Close a matter by ID. @@ -198,19 +198,19 @@ export namespace vault_v1 { /** * The cloud storage bucket name of this export file. Can be used in cloud storage JSON/XML API. */ - bucketName?: string; + bucketName?: string | null; /** * The md5 hash of the file. */ - md5Hash?: string; + md5Hash?: string | null; /** * The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API. */ - objectName?: string; + objectName?: string | null; /** * The size of the export file. */ - size?: string; + size?: string | null; } /** * Export sink for cloud storage files. @@ -249,7 +249,7 @@ export namespace vault_v1 { /** * Set to true to include access level information for users with <a href="https://support.google.com/vault/answer/6099459#metadata">indirect access</a> to files. */ - includeAccessInfo?: boolean; + includeAccessInfo?: boolean | null; } /** * Drive search advanced options @@ -258,15 +258,15 @@ export namespace vault_v1 { /** * Set to true to include shared drive. */ - includeSharedDrives?: boolean; + includeSharedDrives?: boolean | null; /** * Set to true to include Team Drive. */ - includeTeamDrives?: boolean; + includeTeamDrives?: boolean | null; /** * Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date. */ - versionDate?: string; + versionDate?: 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 `{}`. @@ -283,7 +283,7 @@ export namespace vault_v1 { /** * Output only. The time when the export was created. */ - createTime?: string; + createTime?: string | null; /** * Advanced options of the export. */ @@ -291,15 +291,15 @@ export namespace vault_v1 { /** * Output only. The generated export ID. */ - id?: string; + id?: string | null; /** * Output only. The matter ID. */ - matterId?: string; + matterId?: string | null; /** * The export name. */ - name?: string; + name?: string | null; /** * The search query being exported. */ @@ -315,7 +315,7 @@ export namespace vault_v1 { /** * Output only. The export status. */ - status?: string; + status?: string | null; } /** * Export advanced options @@ -340,7 +340,7 @@ export namespace vault_v1 { /** * The requested export location. */ - region?: string; + region?: string | null; } /** * Stats of an export. @@ -349,15 +349,15 @@ export namespace vault_v1 { /** * The number of documents already processed by the export. */ - exportedArtifactCount?: string; + exportedArtifactCount?: string | null; /** * The size of export in bytes. */ - sizeInBytes?: string; + sizeInBytes?: string | null; /** * The number of documents to be exported. */ - totalArtifactCount?: string; + totalArtifactCount?: string | null; } /** * The options for groups export. @@ -366,7 +366,7 @@ export namespace vault_v1 { /** * The export format for groups export. */ - exportFormat?: string; + exportFormat?: string | null; } /** * The options for hangouts chat export. @@ -375,7 +375,7 @@ export namespace vault_v1 { /** * The export format for hangouts chat export. */ - exportFormat?: string; + exportFormat?: string | null; } /** * Accounts to search @@ -384,7 +384,7 @@ export namespace vault_v1 { /** * A set of rooms to search. */ - roomId?: string[]; + roomId?: string[] | null; } /** * Hangouts chat search advanced options @@ -393,7 +393,7 @@ export namespace vault_v1 { /** * Set to true to include rooms. */ - includeRooms?: boolean; + includeRooms?: boolean | null; } /** * An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus. @@ -402,23 +402,23 @@ export namespace vault_v1 { /** * The account's ID as provided by the <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. */ - accountId?: string; + accountId?: string | null; /** * The primary email address of the account. If used as an input, this takes precedence over account ID. */ - email?: string; + email?: string | null; /** * Output only. The first name of the account holder. */ - firstName?: string; + firstName?: string | null; /** * Output only. When the account was put on hold. */ - holdTime?: string; + holdTime?: string | null; /** * Output only. The last name of the account holder. */ - lastName?: string; + lastName?: string | null; } /** * Query options for Drive holds. @@ -427,11 +427,11 @@ export namespace vault_v1 { /** * If true, include files in shared drives in the hold. */ - includeSharedDriveFiles?: boolean; + includeSharedDriveFiles?: boolean | null; /** * If true, include files in Team Drives in the hold. */ - includeTeamDriveFiles?: boolean; + includeTeamDriveFiles?: boolean | null; } /** * Query options for group holds. @@ -440,15 +440,15 @@ export namespace vault_v1 { /** * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ - endTime?: string; + endTime?: string | null; /** * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ - startTime?: string; + startTime?: string | null; /** * The search terms for the hold. */ - terms?: string; + terms?: string | null; } /** * Query options for hangouts chat holds. @@ -457,7 +457,7 @@ export namespace vault_v1 { /** * If true, include rooms the user has participated in. */ - includeRooms?: boolean; + includeRooms?: boolean | null; } /** * Query options for mail holds. @@ -466,15 +466,15 @@ export namespace vault_v1 { /** * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ - endTime?: string; + endTime?: string | null; /** * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ - startTime?: string; + startTime?: string | null; /** * The search terms for the hold. */ - terms?: string; + terms?: string | null; } /** * A organizational unit being held in a particular hold. This structure is immutable. @@ -483,11 +483,11 @@ export namespace vault_v1 { /** * When the org unit was put on hold. This property is immutable. */ - holdTime?: string; + holdTime?: string | null; /** * The org unit's immutable ID as provided by the Admin SDK. */ - orgUnitId?: string; + orgUnitId?: string | null; } /** * Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit. @@ -500,15 +500,15 @@ export namespace vault_v1 { /** * The corpus to be searched. */ - corpus?: string; + corpus?: string | null; /** * The unique immutable ID of the hold. Assigned during creation. */ - holdId?: string; + holdId?: string | null; /** * The name of the hold. */ - name?: string; + name?: string | null; /** * If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field. */ @@ -520,7 +520,7 @@ export namespace vault_v1 { /** * The last time this hold was modified. */ - updateTime?: string; + updateTime?: string | null; } /** * The holds for a matter. @@ -533,7 +533,7 @@ export namespace vault_v1 { /** * Page token to retrieve the next page of results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Returns a list of held accounts for a hold. @@ -555,7 +555,7 @@ export namespace vault_v1 { /** * Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Provides the list of matters. @@ -568,7 +568,7 @@ export namespace vault_v1 { /** * Page token to retrieve the next page of results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Definition of the response for method ListSaveQuery. @@ -577,7 +577,7 @@ export namespace vault_v1 { /** * Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of output saved queries. */ @@ -590,11 +590,11 @@ export namespace vault_v1 { /** * The export file format. */ - exportFormat?: string; + exportFormat?: string | null; /** * Set to true to export confidential mode content. */ - showConfidentialModeContent?: boolean; + showConfidentialModeContent?: boolean | null; } /** * Mail search advanced options @@ -603,7 +603,7 @@ export namespace vault_v1 { /** * Set to true to exclude drafts. */ - excludeDrafts?: boolean; + excludeDrafts?: boolean | null; } /** * Represents a matter. @@ -612,11 +612,11 @@ export namespace vault_v1 { /** * The description of the matter. */ - description?: string; + description?: string | null; /** * The matter ID which is generated by the server. Should be blank when creating a new matter. */ - matterId?: string; + matterId?: string | null; /** * List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. */ @@ -624,11 +624,11 @@ export namespace vault_v1 { /** * The name of the matter. */ - name?: string; + name?: string | null; /** * The state of the matter. */ - state?: string; + state?: string | null; } /** * Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. @@ -637,11 +637,11 @@ export namespace vault_v1 { /** * The account id, as provided by <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. */ - accountId?: string; + accountId?: string | null; /** * The user's role in this matter. */ - role?: string; + role?: string | null; } /** * Org Unit to search @@ -650,7 +650,7 @@ export namespace vault_v1 { /** * Org unit to search, as provided by the <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK Directory API</a>. */ - orgUnitId?: string; + orgUnitId?: string | null; } /** * A query definition relevant for search & export. @@ -663,11 +663,11 @@ export namespace vault_v1 { /** * The corpus to search. */ - corpus?: string; + corpus?: string | null; /** * The data source to search from. */ - dataScope?: string; + dataScope?: string | null; /** * For Drive search, specify more options in this field. */ @@ -675,7 +675,7 @@ export namespace vault_v1 { /** * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ - endTime?: string; + endTime?: string | null; /** * When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only) */ @@ -691,7 +691,7 @@ export namespace vault_v1 { /** * The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only. */ - method?: string; + method?: string | null; /** * When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. */ @@ -699,7 +699,7 @@ export namespace vault_v1 { /** * The search method to use. */ - searchMethod?: string; + searchMethod?: string | null; /** * When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified. */ @@ -707,7 +707,7 @@ export namespace vault_v1 { /** * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ - startTime?: string; + startTime?: string | null; /** * When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified. */ @@ -715,11 +715,11 @@ export namespace vault_v1 { /** * The corpus-specific <a href="https://support.google.com/vault/answer/2474474">search operators</a> used to generate search results. */ - terms?: string; + terms?: string | null; /** * The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time Zone</a>. */ - timeZone?: string; + timeZone?: string | null; } /** * Remove a list of accounts from a hold. @@ -728,7 +728,7 @@ export namespace vault_v1 { /** * Account ids to identify HeldAccounts to remove. */ - accountIds?: string[]; + accountIds?: string[] | null; } /** * Response for batch delete held accounts. @@ -746,7 +746,7 @@ export namespace vault_v1 { /** * The account ID. */ - accountId?: string; + accountId?: string | null; } /** * Reopen a matter by ID. @@ -768,15 +768,15 @@ export namespace vault_v1 { /** * Output only. The server generated timestamp at which saved query was created. */ - createTime?: string; + createTime?: string | null; /** * Name of the saved query. */ - displayName?: string; + displayName?: string | null; /** * Output only. The matter id of the associated matter. The server does not look at this field during create and always uses matter id in the URL. */ - matterId?: string; + matterId?: string | null; /** * The underlying Query object which contains all the information of the saved query. */ @@ -784,7 +784,7 @@ export namespace vault_v1 { /** * A unique identifier for the saved query. */ - savedQueryId?: string; + savedQueryId?: string | null; } /** * Shared drives to search @@ -793,7 +793,7 @@ export namespace vault_v1 { /** * List of Shared drive ids, as provided by <a href="https://developers.google.com/drive">Drive API</a>. */ - sharedDriveIds?: string[]; + sharedDriveIds?: 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). @@ -802,15 +802,15 @@ export namespace vault_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * Team Drives to search @@ -819,7 +819,7 @@ export namespace vault_v1 { /** * List of Team Drive ids, as provided by <a href="https://developers.google.com/drive">Drive API</a>. */ - teamDriveIds?: string[]; + teamDriveIds?: string[] | null; } /** * Undelete a matter by ID. @@ -832,11 +832,11 @@ export namespace vault_v1 { /** * The displayed name of the user. */ - displayName?: string; + displayName?: string | null; /** * The email address of the user. */ - email?: string; + email?: string | null; } export class Resource$Matters { diff --git a/src/apis/verifiedaccess/v1.ts b/src/apis/verifiedaccess/v1.ts index f85d31ad22d..c94de15f372 100644 --- a/src/apis/verifiedaccess/v1.ts +++ b/src/apis/verifiedaccess/v1.ts @@ -141,11 +141,11 @@ export namespace verifiedaccess_v1 { /** * The data to be signed. */ - data?: string; + data?: string | null; /** * The signature of the data field. */ - signature?: string; + signature?: string | null; } /** * signed ChallengeResponse @@ -158,7 +158,7 @@ export namespace verifiedaccess_v1 { /** * Service can optionally provide identity information about the device or user associated with the key. For an EMK, this value is the enrolled domain. For an EUK, this value is the user's email address. If present, this value will be checked against contents of the response, and verification will fail if there is no match. */ - expectedIdentity?: string; + expectedIdentity?: string | null; } /** * Result message for VerifiedAccess.VerifyChallengeResponse. @@ -167,19 +167,19 @@ export namespace verifiedaccess_v1 { /** * Device enrollment id is returned in this field (for the machine response only). */ - deviceEnrollmentId?: string; + deviceEnrollmentId?: string | null; /** * Device permanent id is returned in this field (for the machine response only). */ - devicePermanentId?: string; + devicePermanentId?: string | null; /** * Certificate Signing Request (in the SPKAC format, base64 encoded) is returned in this field. This field will be set only if device has included CSR in its challenge response. (the option to include CSR is now available for both user and machine responses) */ - signedPublicKeyAndChallenge?: string; + signedPublicKeyAndChallenge?: string | null; /** * For EMCert check, device permanent id is returned here. For EUCert check, signed_public_key_and_challenge [base64 encoded] is returned if present, otherwise empty string is returned. This field is deprecated, please use device_permanent_id or signed_public_key_and_challenge fields. */ - verificationOutput?: string; + verificationOutput?: string | null; } export class Resource$Challenge { diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 497ffbdd0bb..15b76080ae3 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -146,15 +146,15 @@ export namespace videointelligence_v1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -172,11 +172,11 @@ export namespace videointelligence_v1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -206,11 +206,11 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -219,7 +219,7 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -232,19 +232,19 @@ export namespace videointelligence_v1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -262,11 +262,11 @@ export namespace videointelligence_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -275,7 +275,7 @@ export namespace videointelligence_v1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -291,7 +291,7 @@ export namespace videointelligence_v1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -304,7 +304,7 @@ export namespace videointelligence_v1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -313,11 +313,11 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -334,7 +334,7 @@ export namespace videointelligence_v1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -347,7 +347,7 @@ export namespace videointelligence_v1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -360,7 +360,7 @@ export namespace videointelligence_v1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -369,7 +369,7 @@ export namespace videointelligence_v1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -386,15 +386,15 @@ export namespace videointelligence_v1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -402,11 +402,11 @@ export namespace videointelligence_v1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -427,7 +427,7 @@ export namespace videointelligence_v1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -440,6 +440,10 @@ export namespace videointelligence_v1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -448,6 +452,10 @@ export namespace videointelligence_v1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Speech transcription. */ @@ -464,11 +472,11 @@ export namespace videointelligence_v1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -477,23 +485,23 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -520,15 +528,15 @@ export namespace videointelligence_v1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -546,11 +554,11 @@ export namespace videointelligence_v1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -580,11 +588,11 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -593,7 +601,7 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -606,19 +614,19 @@ export namespace videointelligence_v1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -636,11 +644,11 @@ export namespace videointelligence_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -649,7 +657,7 @@ export namespace videointelligence_v1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -665,7 +673,7 @@ export namespace videointelligence_v1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -678,7 +686,7 @@ export namespace videointelligence_v1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -687,11 +695,11 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -708,7 +716,7 @@ export namespace videointelligence_v1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -721,7 +729,7 @@ export namespace videointelligence_v1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -734,7 +742,7 @@ export namespace videointelligence_v1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -743,7 +751,7 @@ export namespace videointelligence_v1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -760,15 +768,15 @@ export namespace videointelligence_v1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -776,11 +784,11 @@ export namespace videointelligence_v1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -801,7 +809,7 @@ export namespace videointelligence_v1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -814,6 +822,10 @@ export namespace videointelligence_v1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -822,6 +834,10 @@ export namespace videointelligence_v1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -838,11 +854,11 @@ export namespace videointelligence_v1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -851,23 +867,23 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -894,15 +910,15 @@ export namespace videointelligence_v1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -920,11 +936,11 @@ export namespace videointelligence_v1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -954,11 +970,11 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -967,7 +983,7 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -980,19 +996,19 @@ export namespace videointelligence_v1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1010,11 +1026,11 @@ export namespace videointelligence_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1023,7 +1039,7 @@ export namespace videointelligence_v1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1039,7 +1055,7 @@ export namespace videointelligence_v1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1052,7 +1068,7 @@ export namespace videointelligence_v1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1061,11 +1077,11 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1082,7 +1098,7 @@ export namespace videointelligence_v1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -1095,7 +1111,7 @@ export namespace videointelligence_v1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1108,7 +1124,7 @@ export namespace videointelligence_v1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1117,7 +1133,7 @@ export namespace videointelligence_v1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1134,15 +1150,15 @@ export namespace videointelligence_v1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1150,11 +1166,11 @@ export namespace videointelligence_v1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1175,7 +1191,7 @@ export namespace videointelligence_v1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -1188,6 +1204,10 @@ export namespace videointelligence_v1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1196,6 +1216,10 @@ export namespace videointelligence_v1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1212,11 +1236,11 @@ export namespace videointelligence_v1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1225,23 +1249,23 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1268,15 +1292,15 @@ export namespace videointelligence_v1 { /** * Detected attribute confidence. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. */ - name?: string; + name?: string | null; /** * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. */ - value?: string; + value?: string | null; } /** * Detected entity from video analysis. @@ -1285,15 +1309,15 @@ export namespace videointelligence_v1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1311,11 +1335,11 @@ export namespace videointelligence_v1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1345,11 +1369,11 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1358,7 +1382,7 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1388,19 +1412,19 @@ export namespace videointelligence_v1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1418,11 +1442,11 @@ export namespace videointelligence_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1431,7 +1455,7 @@ export namespace videointelligence_v1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1447,7 +1471,7 @@ export namespace videointelligence_v1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1460,7 +1484,7 @@ export namespace videointelligence_v1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1469,11 +1493,11 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1490,7 +1514,7 @@ export namespace videointelligence_v1 { /** * 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; + languageCode?: string | null; } /** * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. @@ -1503,7 +1527,7 @@ export namespace videointelligence_v1 { /** * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ - annotationResultsUri?: string; + annotationResultsUri?: string | null; /** * If set, returns a google.rpc.Status message that specifies the error for the operation. */ @@ -1541,7 +1565,7 @@ export namespace videointelligence_v1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1554,7 +1578,7 @@ export namespace videointelligence_v1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1563,7 +1587,7 @@ export namespace videointelligence_v1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1588,7 +1612,7 @@ export namespace videointelligence_v1 { /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. */ - timeOffset?: string; + timeOffset?: string | null; } /** * A track of an object instance. @@ -1601,7 +1625,7 @@ export namespace videointelligence_v1 { /** * Optional. The confidence score of the tracked object. */ - confidence?: number; + confidence?: number | null; /** * Video segment of a track. */ @@ -1618,15 +1642,15 @@ export namespace videointelligence_v1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1634,11 +1658,11 @@ export namespace videointelligence_v1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1659,7 +1683,7 @@ export namespace videointelligence_v1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of logos detected, tracked and recognized in video. */ @@ -1676,6 +1700,10 @@ export namespace videointelligence_v1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1684,6 +1712,10 @@ export namespace videointelligence_v1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1700,11 +1732,11 @@ export namespace videointelligence_v1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1713,23 +1745,23 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1747,23 +1779,23 @@ export namespace videointelligence_v1 { /** * Requested video annotation features. */ - features?: string[]; + features?: string[] | null; /** * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ - inputContent?: string; + inputContent?: string | null; /** * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ - inputUri?: string; + inputUri?: string | null; /** * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ - locationId?: string; + locationId?: string | null; /** * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ - outputUri?: string; + outputUri?: string | null; /** * Additional video context and/or feature-specific parameters. */ @@ -1785,15 +1817,15 @@ export namespace videointelligence_v1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1811,7 +1843,7 @@ export namespace videointelligence_v1 { /** * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for explicit content. @@ -1820,11 +1852,11 @@ export namespace videointelligence_v1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1854,23 +1886,23 @@ export namespace videointelligence_v1 { /** * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - frameConfidenceThreshold?: number; + frameConfidenceThreshold?: number | null; /** * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ - labelDetectionMode?: string; + labelDetectionMode?: string | null; /** * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ - stationaryCamera?: boolean; + stationaryCamera?: boolean | null; /** * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - videoConfidenceThreshold?: number; + videoConfidenceThreshold?: number | null; } /** * Video frame level annotation results for label detection. @@ -1879,11 +1911,11 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1892,7 +1924,7 @@ export namespace videointelligence_v1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1905,19 +1937,19 @@ export namespace videointelligence_v1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1935,11 +1967,11 @@ export namespace videointelligence_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1948,7 +1980,7 @@ export namespace videointelligence_v1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1964,7 +1996,7 @@ export namespace videointelligence_v1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Config for OBJECT_TRACKING. @@ -1973,7 +2005,7 @@ export namespace videointelligence_v1 { /** * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1986,7 +2018,7 @@ export namespace videointelligence_v1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Config for SHOT_CHANGE_DETECTION. @@ -1995,7 +2027,7 @@ export namespace videointelligence_v1 { /** * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -2004,7 +2036,7 @@ export namespace videointelligence_v1 { /** * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ - phrases?: string[]; + phrases?: string[] | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -2013,11 +2045,11 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -2034,7 +2066,7 @@ export namespace videointelligence_v1 { /** * 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; + languageCode?: string | null; } /** * Config for SPEECH_TRANSCRIPTION. @@ -2043,35 +2075,35 @@ export namespace videointelligence_v1 { /** * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ - audioTracks?: number[]; + audioTracks?: number[] | null; /** * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ - diarizationSpeakerCount?: number; + diarizationSpeakerCount?: number | null; /** * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ - enableAutomaticPunctuation?: boolean; + enableAutomaticPunctuation?: boolean | null; /** * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ - enableSpeakerDiarization?: boolean; + enableSpeakerDiarization?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ - enableWordConfidence?: boolean; + enableWordConfidence?: boolean | null; /** * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ - filterProfanity?: boolean; + filterProfanity?: boolean | null; /** * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ - maxAlternatives?: number; + maxAlternatives?: number | null; /** * *Optional* A means to provide context to assist the speech recognition. */ @@ -2088,7 +2120,7 @@ export namespace videointelligence_v1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Config for TEXT_DETECTION. @@ -2097,11 +2129,11 @@ export namespace videointelligence_v1 { /** * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -2114,7 +2146,7 @@ export namespace videointelligence_v1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -2123,7 +2155,7 @@ export namespace videointelligence_v1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -2140,15 +2172,15 @@ export namespace videointelligence_v1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -2156,11 +2188,11 @@ export namespace videointelligence_v1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -2181,7 +2213,7 @@ export namespace videointelligence_v1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -2194,6 +2226,10 @@ export namespace videointelligence_v1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -2202,6 +2238,10 @@ export namespace videointelligence_v1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Speech transcription. */ @@ -2251,11 +2291,11 @@ export namespace videointelligence_v1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -2264,23 +2304,23 @@ export namespace videointelligence_v1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * The request message for Operations.CancelOperation. @@ -2293,7 +2333,7 @@ export namespace videointelligence_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -2306,7 +2346,7 @@ export namespace videointelligence_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -2314,15 +2354,15 @@ export namespace videointelligence_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. @@ -2335,15 +2375,15 @@ export namespace videointelligence_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Operations { diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index 6095f431155..e2f4e7a8de9 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -133,23 +133,23 @@ export namespace videointelligence_v1beta2 { /** * Requested video annotation features. */ - features?: string[]; + features?: string[] | null; /** * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ - inputContent?: string; + inputContent?: string | null; /** * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ - inputUri?: string; + inputUri?: string | null; /** * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ - locationId?: string; + locationId?: string | null; /** * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ - outputUri?: string; + outputUri?: string | null; /** * Additional video context and/or feature-specific parameters. */ @@ -171,15 +171,15 @@ export namespace videointelligence_v1beta2 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -197,7 +197,7 @@ export namespace videointelligence_v1beta2 { /** * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for explicit content. @@ -206,11 +206,11 @@ export namespace videointelligence_v1beta2 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -240,23 +240,23 @@ export namespace videointelligence_v1beta2 { /** * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - frameConfidenceThreshold?: number; + frameConfidenceThreshold?: number | null; /** * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ - labelDetectionMode?: string; + labelDetectionMode?: string | null; /** * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ - stationaryCamera?: boolean; + stationaryCamera?: boolean | null; /** * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - videoConfidenceThreshold?: number; + videoConfidenceThreshold?: number | null; } /** * Video frame level annotation results for label detection. @@ -265,11 +265,11 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -278,7 +278,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -291,19 +291,19 @@ export namespace videointelligence_v1beta2 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -321,11 +321,11 @@ export namespace videointelligence_v1beta2 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -334,7 +334,7 @@ export namespace videointelligence_v1beta2 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -350,7 +350,7 @@ export namespace videointelligence_v1beta2 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Config for OBJECT_TRACKING. @@ -359,7 +359,7 @@ export namespace videointelligence_v1beta2 { /** * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -372,7 +372,7 @@ export namespace videointelligence_v1beta2 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Config for SHOT_CHANGE_DETECTION. @@ -381,7 +381,7 @@ export namespace videointelligence_v1beta2 { /** * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -390,7 +390,7 @@ export namespace videointelligence_v1beta2 { /** * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ - phrases?: string[]; + phrases?: string[] | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -399,11 +399,11 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -420,7 +420,7 @@ export namespace videointelligence_v1beta2 { /** * 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; + languageCode?: string | null; } /** * Config for SPEECH_TRANSCRIPTION. @@ -429,35 +429,35 @@ export namespace videointelligence_v1beta2 { /** * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ - audioTracks?: number[]; + audioTracks?: number[] | null; /** * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ - diarizationSpeakerCount?: number; + diarizationSpeakerCount?: number | null; /** * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ - enableAutomaticPunctuation?: boolean; + enableAutomaticPunctuation?: boolean | null; /** * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ - enableSpeakerDiarization?: boolean; + enableSpeakerDiarization?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ - enableWordConfidence?: boolean; + enableWordConfidence?: boolean | null; /** * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ - filterProfanity?: boolean; + filterProfanity?: boolean | null; /** * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ - maxAlternatives?: number; + maxAlternatives?: number | null; /** * *Optional* A means to provide context to assist the speech recognition. */ @@ -474,7 +474,7 @@ export namespace videointelligence_v1beta2 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Config for TEXT_DETECTION. @@ -483,11 +483,11 @@ export namespace videointelligence_v1beta2 { /** * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -500,7 +500,7 @@ export namespace videointelligence_v1beta2 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -509,7 +509,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -526,15 +526,15 @@ export namespace videointelligence_v1beta2 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -542,11 +542,11 @@ export namespace videointelligence_v1beta2 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -567,7 +567,7 @@ export namespace videointelligence_v1beta2 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -580,6 +580,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -588,6 +592,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Speech transcription. */ @@ -637,11 +645,11 @@ export namespace videointelligence_v1beta2 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -650,23 +658,23 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -693,15 +701,15 @@ export namespace videointelligence_v1beta2 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -719,11 +727,11 @@ export namespace videointelligence_v1beta2 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -753,11 +761,11 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -766,7 +774,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -779,19 +787,19 @@ export namespace videointelligence_v1beta2 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -809,11 +817,11 @@ export namespace videointelligence_v1beta2 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -822,7 +830,7 @@ export namespace videointelligence_v1beta2 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -838,7 +846,7 @@ export namespace videointelligence_v1beta2 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -851,7 +859,7 @@ export namespace videointelligence_v1beta2 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -860,11 +868,11 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -881,7 +889,7 @@ export namespace videointelligence_v1beta2 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -894,7 +902,7 @@ export namespace videointelligence_v1beta2 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -907,7 +915,7 @@ export namespace videointelligence_v1beta2 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -916,7 +924,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -933,15 +941,15 @@ export namespace videointelligence_v1beta2 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -949,11 +957,11 @@ export namespace videointelligence_v1beta2 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -974,7 +982,7 @@ export namespace videointelligence_v1beta2 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -987,6 +995,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -995,6 +1007,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1011,11 +1027,11 @@ export namespace videointelligence_v1beta2 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1024,23 +1040,23 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1067,15 +1083,15 @@ export namespace videointelligence_v1beta2 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1093,11 +1109,11 @@ export namespace videointelligence_v1beta2 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1127,11 +1143,11 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1140,7 +1156,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1153,19 +1169,19 @@ export namespace videointelligence_v1beta2 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1183,11 +1199,11 @@ export namespace videointelligence_v1beta2 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1196,7 +1212,7 @@ export namespace videointelligence_v1beta2 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1212,7 +1228,7 @@ export namespace videointelligence_v1beta2 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1225,7 +1241,7 @@ export namespace videointelligence_v1beta2 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1234,11 +1250,11 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1255,7 +1271,7 @@ export namespace videointelligence_v1beta2 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -1268,7 +1284,7 @@ export namespace videointelligence_v1beta2 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1281,7 +1297,7 @@ export namespace videointelligence_v1beta2 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1290,7 +1306,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1307,15 +1323,15 @@ export namespace videointelligence_v1beta2 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1323,11 +1339,11 @@ export namespace videointelligence_v1beta2 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1348,7 +1364,7 @@ export namespace videointelligence_v1beta2 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -1361,6 +1377,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1369,6 +1389,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1385,11 +1409,11 @@ export namespace videointelligence_v1beta2 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1398,23 +1422,23 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1441,15 +1465,15 @@ export namespace videointelligence_v1beta2 { /** * Detected attribute confidence. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. */ - name?: string; + name?: string | null; /** * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. */ - value?: string; + value?: string | null; } /** * Detected entity from video analysis. @@ -1458,15 +1482,15 @@ export namespace videointelligence_v1beta2 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1484,11 +1508,11 @@ export namespace videointelligence_v1beta2 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1518,11 +1542,11 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1531,7 +1555,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1561,19 +1585,19 @@ export namespace videointelligence_v1beta2 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1591,11 +1615,11 @@ export namespace videointelligence_v1beta2 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1604,7 +1628,7 @@ export namespace videointelligence_v1beta2 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1620,7 +1644,7 @@ export namespace videointelligence_v1beta2 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1633,7 +1657,7 @@ export namespace videointelligence_v1beta2 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1642,11 +1666,11 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1663,7 +1687,7 @@ export namespace videointelligence_v1beta2 { /** * 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; + languageCode?: string | null; } /** * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. @@ -1676,7 +1700,7 @@ export namespace videointelligence_v1beta2 { /** * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ - annotationResultsUri?: string; + annotationResultsUri?: string | null; /** * If set, returns a google.rpc.Status message that specifies the error for the operation. */ @@ -1714,7 +1738,7 @@ export namespace videointelligence_v1beta2 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1727,7 +1751,7 @@ export namespace videointelligence_v1beta2 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1736,7 +1760,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1761,7 +1785,7 @@ export namespace videointelligence_v1beta2 { /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. */ - timeOffset?: string; + timeOffset?: string | null; } /** * A track of an object instance. @@ -1774,7 +1798,7 @@ export namespace videointelligence_v1beta2 { /** * Optional. The confidence score of the tracked object. */ - confidence?: number; + confidence?: number | null; /** * Video segment of a track. */ @@ -1791,15 +1815,15 @@ export namespace videointelligence_v1beta2 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1807,11 +1831,11 @@ export namespace videointelligence_v1beta2 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1832,7 +1856,7 @@ export namespace videointelligence_v1beta2 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of logos detected, tracked and recognized in video. */ @@ -1849,6 +1873,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1857,6 +1885,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1873,11 +1905,11 @@ export namespace videointelligence_v1beta2 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1886,23 +1918,23 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1929,15 +1961,15 @@ export namespace videointelligence_v1beta2 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1955,11 +1987,11 @@ export namespace videointelligence_v1beta2 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1989,11 +2021,11 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -2002,7 +2034,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -2015,19 +2047,19 @@ export namespace videointelligence_v1beta2 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -2045,11 +2077,11 @@ export namespace videointelligence_v1beta2 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -2058,7 +2090,7 @@ export namespace videointelligence_v1beta2 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -2074,7 +2106,7 @@ export namespace videointelligence_v1beta2 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -2087,7 +2119,7 @@ export namespace videointelligence_v1beta2 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -2096,11 +2128,11 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -2117,7 +2149,7 @@ export namespace videointelligence_v1beta2 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -2130,7 +2162,7 @@ export namespace videointelligence_v1beta2 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -2143,7 +2175,7 @@ export namespace videointelligence_v1beta2 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -2152,7 +2184,7 @@ export namespace videointelligence_v1beta2 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -2169,15 +2201,15 @@ export namespace videointelligence_v1beta2 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -2185,11 +2217,11 @@ export namespace videointelligence_v1beta2 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -2210,7 +2242,7 @@ export namespace videointelligence_v1beta2 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -2223,6 +2255,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -2231,6 +2267,10 @@ export namespace videointelligence_v1beta2 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Speech transcription. */ @@ -2247,11 +2287,11 @@ export namespace videointelligence_v1beta2 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -2260,23 +2300,23 @@ export namespace videointelligence_v1beta2 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -2285,7 +2325,7 @@ export namespace videointelligence_v1beta2 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -2293,15 +2333,15 @@ export namespace videointelligence_v1beta2 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -2310,15 +2350,15 @@ export namespace videointelligence_v1beta2 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Videos { diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index ae46e731b53..198a10336bf 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -142,15 +142,15 @@ export namespace videointelligence_v1p1beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -168,11 +168,11 @@ export namespace videointelligence_v1p1beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -202,11 +202,11 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -215,7 +215,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -228,19 +228,19 @@ export namespace videointelligence_v1p1beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -258,11 +258,11 @@ export namespace videointelligence_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -271,7 +271,7 @@ export namespace videointelligence_v1p1beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -287,7 +287,7 @@ export namespace videointelligence_v1p1beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -300,7 +300,7 @@ export namespace videointelligence_v1p1beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -309,11 +309,11 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -330,7 +330,7 @@ export namespace videointelligence_v1p1beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -343,7 +343,7 @@ export namespace videointelligence_v1p1beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -356,7 +356,7 @@ export namespace videointelligence_v1p1beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -365,7 +365,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -382,15 +382,15 @@ export namespace videointelligence_v1p1beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -398,11 +398,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -423,7 +423,7 @@ export namespace videointelligence_v1p1beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -436,6 +436,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -444,6 +448,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Speech transcription. */ @@ -460,11 +468,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -473,23 +481,23 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -507,23 +515,23 @@ export namespace videointelligence_v1p1beta1 { /** * Requested video annotation features. */ - features?: string[]; + features?: string[] | null; /** * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ - inputContent?: string; + inputContent?: string | null; /** * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ - inputUri?: string; + inputUri?: string | null; /** * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ - locationId?: string; + locationId?: string | null; /** * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ - outputUri?: string; + outputUri?: string | null; /** * Additional video context and/or feature-specific parameters. */ @@ -545,15 +553,15 @@ export namespace videointelligence_v1p1beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -571,7 +579,7 @@ export namespace videointelligence_v1p1beta1 { /** * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for explicit content. @@ -580,11 +588,11 @@ export namespace videointelligence_v1p1beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -614,23 +622,23 @@ export namespace videointelligence_v1p1beta1 { /** * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - frameConfidenceThreshold?: number; + frameConfidenceThreshold?: number | null; /** * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ - labelDetectionMode?: string; + labelDetectionMode?: string | null; /** * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ - stationaryCamera?: boolean; + stationaryCamera?: boolean | null; /** * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - videoConfidenceThreshold?: number; + videoConfidenceThreshold?: number | null; } /** * Video frame level annotation results for label detection. @@ -639,11 +647,11 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -652,7 +660,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -665,19 +673,19 @@ export namespace videointelligence_v1p1beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -695,11 +703,11 @@ export namespace videointelligence_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -708,7 +716,7 @@ export namespace videointelligence_v1p1beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -724,7 +732,7 @@ export namespace videointelligence_v1p1beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Config for OBJECT_TRACKING. @@ -733,7 +741,7 @@ export namespace videointelligence_v1p1beta1 { /** * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -746,7 +754,7 @@ export namespace videointelligence_v1p1beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Config for SHOT_CHANGE_DETECTION. @@ -755,7 +763,7 @@ export namespace videointelligence_v1p1beta1 { /** * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -764,7 +772,7 @@ export namespace videointelligence_v1p1beta1 { /** * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ - phrases?: string[]; + phrases?: string[] | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -773,11 +781,11 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -794,7 +802,7 @@ export namespace videointelligence_v1p1beta1 { /** * 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; + languageCode?: string | null; } /** * Config for SPEECH_TRANSCRIPTION. @@ -803,35 +811,35 @@ export namespace videointelligence_v1p1beta1 { /** * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ - audioTracks?: number[]; + audioTracks?: number[] | null; /** * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ - diarizationSpeakerCount?: number; + diarizationSpeakerCount?: number | null; /** * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ - enableAutomaticPunctuation?: boolean; + enableAutomaticPunctuation?: boolean | null; /** * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ - enableSpeakerDiarization?: boolean; + enableSpeakerDiarization?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ - enableWordConfidence?: boolean; + enableWordConfidence?: boolean | null; /** * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ - filterProfanity?: boolean; + filterProfanity?: boolean | null; /** * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ - maxAlternatives?: number; + maxAlternatives?: number | null; /** * *Optional* A means to provide context to assist the speech recognition. */ @@ -848,7 +856,7 @@ export namespace videointelligence_v1p1beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Config for TEXT_DETECTION. @@ -857,11 +865,11 @@ export namespace videointelligence_v1p1beta1 { /** * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -874,7 +882,7 @@ export namespace videointelligence_v1p1beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -883,7 +891,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -900,15 +908,15 @@ export namespace videointelligence_v1p1beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -916,11 +924,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -941,7 +949,7 @@ export namespace videointelligence_v1p1beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -954,6 +962,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -962,6 +974,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1011,11 +1027,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1024,23 +1040,23 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1067,15 +1083,15 @@ export namespace videointelligence_v1p1beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1093,11 +1109,11 @@ export namespace videointelligence_v1p1beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1127,11 +1143,11 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1140,7 +1156,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1153,19 +1169,19 @@ export namespace videointelligence_v1p1beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1183,11 +1199,11 @@ export namespace videointelligence_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1196,7 +1212,7 @@ export namespace videointelligence_v1p1beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1212,7 +1228,7 @@ export namespace videointelligence_v1p1beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1225,7 +1241,7 @@ export namespace videointelligence_v1p1beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1234,11 +1250,11 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1255,7 +1271,7 @@ export namespace videointelligence_v1p1beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -1268,7 +1284,7 @@ export namespace videointelligence_v1p1beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1281,7 +1297,7 @@ export namespace videointelligence_v1p1beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1290,7 +1306,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1307,15 +1323,15 @@ export namespace videointelligence_v1p1beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1323,11 +1339,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1348,7 +1364,7 @@ export namespace videointelligence_v1p1beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -1361,6 +1377,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1369,6 +1389,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1385,11 +1409,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1398,23 +1422,23 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1441,15 +1465,15 @@ export namespace videointelligence_v1p1beta1 { /** * Detected attribute confidence. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. */ - name?: string; + name?: string | null; /** * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. */ - value?: string; + value?: string | null; } /** * Detected entity from video analysis. @@ -1458,15 +1482,15 @@ export namespace videointelligence_v1p1beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1484,11 +1508,11 @@ export namespace videointelligence_v1p1beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1518,11 +1542,11 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1531,7 +1555,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1561,19 +1585,19 @@ export namespace videointelligence_v1p1beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1591,11 +1615,11 @@ export namespace videointelligence_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1604,7 +1628,7 @@ export namespace videointelligence_v1p1beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1620,7 +1644,7 @@ export namespace videointelligence_v1p1beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1633,7 +1657,7 @@ export namespace videointelligence_v1p1beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1642,11 +1666,11 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1663,7 +1687,7 @@ export namespace videointelligence_v1p1beta1 { /** * 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; + languageCode?: string | null; } /** * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. @@ -1676,7 +1700,7 @@ export namespace videointelligence_v1p1beta1 { /** * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ - annotationResultsUri?: string; + annotationResultsUri?: string | null; /** * If set, returns a google.rpc.Status message that specifies the error for the operation. */ @@ -1714,7 +1738,7 @@ export namespace videointelligence_v1p1beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1727,7 +1751,7 @@ export namespace videointelligence_v1p1beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1736,7 +1760,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1761,7 +1785,7 @@ export namespace videointelligence_v1p1beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. */ - timeOffset?: string; + timeOffset?: string | null; } /** * A track of an object instance. @@ -1774,7 +1798,7 @@ export namespace videointelligence_v1p1beta1 { /** * Optional. The confidence score of the tracked object. */ - confidence?: number; + confidence?: number | null; /** * Video segment of a track. */ @@ -1791,15 +1815,15 @@ export namespace videointelligence_v1p1beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1807,11 +1831,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1832,7 +1856,7 @@ export namespace videointelligence_v1p1beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of logos detected, tracked and recognized in video. */ @@ -1849,6 +1873,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1857,6 +1885,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1873,11 +1905,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1886,23 +1918,23 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1929,15 +1961,15 @@ export namespace videointelligence_v1p1beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1955,11 +1987,11 @@ export namespace videointelligence_v1p1beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1989,11 +2021,11 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -2002,7 +2034,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -2015,19 +2047,19 @@ export namespace videointelligence_v1p1beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -2045,11 +2077,11 @@ export namespace videointelligence_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -2058,7 +2090,7 @@ export namespace videointelligence_v1p1beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -2074,7 +2106,7 @@ export namespace videointelligence_v1p1beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -2087,7 +2119,7 @@ export namespace videointelligence_v1p1beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -2096,11 +2128,11 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -2117,7 +2149,7 @@ export namespace videointelligence_v1p1beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -2130,7 +2162,7 @@ export namespace videointelligence_v1p1beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -2143,7 +2175,7 @@ export namespace videointelligence_v1p1beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -2152,7 +2184,7 @@ export namespace videointelligence_v1p1beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -2169,15 +2201,15 @@ export namespace videointelligence_v1p1beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -2185,11 +2217,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -2210,7 +2242,7 @@ export namespace videointelligence_v1p1beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -2223,6 +2255,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -2231,6 +2267,10 @@ export namespace videointelligence_v1p1beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Speech transcription. */ @@ -2247,11 +2287,11 @@ export namespace videointelligence_v1p1beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -2260,23 +2300,23 @@ export namespace videointelligence_v1p1beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -2285,7 +2325,7 @@ export namespace videointelligence_v1p1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -2293,15 +2333,15 @@ export namespace videointelligence_v1p1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -2310,15 +2350,15 @@ export namespace videointelligence_v1p1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Videos { diff --git a/src/apis/videointelligence/v1p2beta1.ts b/src/apis/videointelligence/v1p2beta1.ts index a15d748abb3..b4b1d091826 100644 --- a/src/apis/videointelligence/v1p2beta1.ts +++ b/src/apis/videointelligence/v1p2beta1.ts @@ -142,15 +142,15 @@ export namespace videointelligence_v1p2beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -168,11 +168,11 @@ export namespace videointelligence_v1p2beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -202,11 +202,11 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -215,7 +215,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -228,19 +228,19 @@ export namespace videointelligence_v1p2beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -258,11 +258,11 @@ export namespace videointelligence_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -271,7 +271,7 @@ export namespace videointelligence_v1p2beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -287,7 +287,7 @@ export namespace videointelligence_v1p2beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -300,7 +300,7 @@ export namespace videointelligence_v1p2beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -309,11 +309,11 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -330,7 +330,7 @@ export namespace videointelligence_v1p2beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -343,7 +343,7 @@ export namespace videointelligence_v1p2beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -356,7 +356,7 @@ export namespace videointelligence_v1p2beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -365,7 +365,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -382,15 +382,15 @@ export namespace videointelligence_v1p2beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -398,11 +398,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -423,7 +423,7 @@ export namespace videointelligence_v1p2beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -436,6 +436,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -444,6 +448,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Speech transcription. */ @@ -460,11 +468,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -473,23 +481,23 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -516,15 +524,15 @@ export namespace videointelligence_v1p2beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -542,11 +550,11 @@ export namespace videointelligence_v1p2beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -576,11 +584,11 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -589,7 +597,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -602,19 +610,19 @@ export namespace videointelligence_v1p2beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -632,11 +640,11 @@ export namespace videointelligence_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -645,7 +653,7 @@ export namespace videointelligence_v1p2beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -661,7 +669,7 @@ export namespace videointelligence_v1p2beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -674,7 +682,7 @@ export namespace videointelligence_v1p2beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -683,11 +691,11 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -704,7 +712,7 @@ export namespace videointelligence_v1p2beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -717,7 +725,7 @@ export namespace videointelligence_v1p2beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -730,7 +738,7 @@ export namespace videointelligence_v1p2beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -739,7 +747,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -756,15 +764,15 @@ export namespace videointelligence_v1p2beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -772,11 +780,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -797,7 +805,7 @@ export namespace videointelligence_v1p2beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -810,6 +818,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -818,6 +830,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -834,11 +850,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -847,23 +863,23 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -881,23 +897,23 @@ export namespace videointelligence_v1p2beta1 { /** * Requested video annotation features. */ - features?: string[]; + features?: string[] | null; /** * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ - inputContent?: string; + inputContent?: string | null; /** * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ - inputUri?: string; + inputUri?: string | null; /** * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ - locationId?: string; + locationId?: string | null; /** * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ - outputUri?: string; + outputUri?: string | null; /** * Additional video context and/or feature-specific parameters. */ @@ -919,15 +935,15 @@ export namespace videointelligence_v1p2beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -945,7 +961,7 @@ export namespace videointelligence_v1p2beta1 { /** * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for explicit content. @@ -954,11 +970,11 @@ export namespace videointelligence_v1p2beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -988,23 +1004,23 @@ export namespace videointelligence_v1p2beta1 { /** * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - frameConfidenceThreshold?: number; + frameConfidenceThreshold?: number | null; /** * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ - labelDetectionMode?: string; + labelDetectionMode?: string | null; /** * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ - stationaryCamera?: boolean; + stationaryCamera?: boolean | null; /** * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - videoConfidenceThreshold?: number; + videoConfidenceThreshold?: number | null; } /** * Video frame level annotation results for label detection. @@ -1013,11 +1029,11 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1026,7 +1042,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1039,19 +1055,19 @@ export namespace videointelligence_v1p2beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1069,11 +1085,11 @@ export namespace videointelligence_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1082,7 +1098,7 @@ export namespace videointelligence_v1p2beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1098,7 +1114,7 @@ export namespace videointelligence_v1p2beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Config for OBJECT_TRACKING. @@ -1107,7 +1123,7 @@ export namespace videointelligence_v1p2beta1 { /** * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1120,7 +1136,7 @@ export namespace videointelligence_v1p2beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Config for SHOT_CHANGE_DETECTION. @@ -1129,7 +1145,7 @@ export namespace videointelligence_v1p2beta1 { /** * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -1138,7 +1154,7 @@ export namespace videointelligence_v1p2beta1 { /** * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ - phrases?: string[]; + phrases?: string[] | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1147,11 +1163,11 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1168,7 +1184,7 @@ export namespace videointelligence_v1p2beta1 { /** * 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; + languageCode?: string | null; } /** * Config for SPEECH_TRANSCRIPTION. @@ -1177,35 +1193,35 @@ export namespace videointelligence_v1p2beta1 { /** * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ - audioTracks?: number[]; + audioTracks?: number[] | null; /** * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ - diarizationSpeakerCount?: number; + diarizationSpeakerCount?: number | null; /** * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ - enableAutomaticPunctuation?: boolean; + enableAutomaticPunctuation?: boolean | null; /** * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ - enableSpeakerDiarization?: boolean; + enableSpeakerDiarization?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ - enableWordConfidence?: boolean; + enableWordConfidence?: boolean | null; /** * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ - filterProfanity?: boolean; + filterProfanity?: boolean | null; /** * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ - maxAlternatives?: number; + maxAlternatives?: number | null; /** * *Optional* A means to provide context to assist the speech recognition. */ @@ -1222,7 +1238,7 @@ export namespace videointelligence_v1p2beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Config for TEXT_DETECTION. @@ -1231,11 +1247,11 @@ export namespace videointelligence_v1p2beta1 { /** * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1248,7 +1264,7 @@ export namespace videointelligence_v1p2beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1257,7 +1273,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1274,15 +1290,15 @@ export namespace videointelligence_v1p2beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1290,11 +1306,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1315,7 +1331,7 @@ export namespace videointelligence_v1p2beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -1328,6 +1344,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1336,6 +1356,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1385,11 +1409,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1398,23 +1422,23 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1441,15 +1465,15 @@ export namespace videointelligence_v1p2beta1 { /** * Detected attribute confidence. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. */ - name?: string; + name?: string | null; /** * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. */ - value?: string; + value?: string | null; } /** * Detected entity from video analysis. @@ -1458,15 +1482,15 @@ export namespace videointelligence_v1p2beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1484,11 +1508,11 @@ export namespace videointelligence_v1p2beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1518,11 +1542,11 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1531,7 +1555,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1561,19 +1585,19 @@ export namespace videointelligence_v1p2beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1591,11 +1615,11 @@ export namespace videointelligence_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1604,7 +1628,7 @@ export namespace videointelligence_v1p2beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1620,7 +1644,7 @@ export namespace videointelligence_v1p2beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1633,7 +1657,7 @@ export namespace videointelligence_v1p2beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1642,11 +1666,11 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1663,7 +1687,7 @@ export namespace videointelligence_v1p2beta1 { /** * 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; + languageCode?: string | null; } /** * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. @@ -1676,7 +1700,7 @@ export namespace videointelligence_v1p2beta1 { /** * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ - annotationResultsUri?: string; + annotationResultsUri?: string | null; /** * If set, returns a google.rpc.Status message that specifies the error for the operation. */ @@ -1714,7 +1738,7 @@ export namespace videointelligence_v1p2beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1727,7 +1751,7 @@ export namespace videointelligence_v1p2beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1736,7 +1760,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1761,7 +1785,7 @@ export namespace videointelligence_v1p2beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. */ - timeOffset?: string; + timeOffset?: string | null; } /** * A track of an object instance. @@ -1774,7 +1798,7 @@ export namespace videointelligence_v1p2beta1 { /** * Optional. The confidence score of the tracked object. */ - confidence?: number; + confidence?: number | null; /** * Video segment of a track. */ @@ -1791,15 +1815,15 @@ export namespace videointelligence_v1p2beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1807,11 +1831,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1832,7 +1856,7 @@ export namespace videointelligence_v1p2beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of logos detected, tracked and recognized in video. */ @@ -1849,6 +1873,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1857,6 +1885,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1873,11 +1905,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1886,23 +1918,23 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1929,15 +1961,15 @@ export namespace videointelligence_v1p2beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1955,11 +1987,11 @@ export namespace videointelligence_v1p2beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1989,11 +2021,11 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -2002,7 +2034,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -2015,19 +2047,19 @@ export namespace videointelligence_v1p2beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -2045,11 +2077,11 @@ export namespace videointelligence_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -2058,7 +2090,7 @@ export namespace videointelligence_v1p2beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -2074,7 +2106,7 @@ export namespace videointelligence_v1p2beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -2087,7 +2119,7 @@ export namespace videointelligence_v1p2beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -2096,11 +2128,11 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -2117,7 +2149,7 @@ export namespace videointelligence_v1p2beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -2130,7 +2162,7 @@ export namespace videointelligence_v1p2beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -2143,7 +2175,7 @@ export namespace videointelligence_v1p2beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -2152,7 +2184,7 @@ export namespace videointelligence_v1p2beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -2169,15 +2201,15 @@ export namespace videointelligence_v1p2beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -2185,11 +2217,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -2210,7 +2242,7 @@ export namespace videointelligence_v1p2beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -2223,6 +2255,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -2231,6 +2267,10 @@ export namespace videointelligence_v1p2beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Speech transcription. */ @@ -2247,11 +2287,11 @@ export namespace videointelligence_v1p2beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -2260,23 +2300,23 @@ export namespace videointelligence_v1p2beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -2285,7 +2325,7 @@ export namespace videointelligence_v1p2beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -2293,15 +2333,15 @@ export namespace videointelligence_v1p2beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -2310,15 +2350,15 @@ export namespace videointelligence_v1p2beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Videos { diff --git a/src/apis/videointelligence/v1p3beta1.ts b/src/apis/videointelligence/v1p3beta1.ts index ae8e91948de..0cb6c85ab6d 100644 --- a/src/apis/videointelligence/v1p3beta1.ts +++ b/src/apis/videointelligence/v1p3beta1.ts @@ -142,15 +142,15 @@ export namespace videointelligence_v1p3beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -168,11 +168,11 @@ export namespace videointelligence_v1p3beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -202,11 +202,11 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -215,7 +215,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -228,19 +228,19 @@ export namespace videointelligence_v1p3beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -258,11 +258,11 @@ export namespace videointelligence_v1p3beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -271,7 +271,7 @@ export namespace videointelligence_v1p3beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -287,7 +287,7 @@ export namespace videointelligence_v1p3beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -300,7 +300,7 @@ export namespace videointelligence_v1p3beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -309,11 +309,11 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -330,7 +330,7 @@ export namespace videointelligence_v1p3beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -343,7 +343,7 @@ export namespace videointelligence_v1p3beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -356,7 +356,7 @@ export namespace videointelligence_v1p3beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -365,7 +365,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -382,15 +382,15 @@ export namespace videointelligence_v1p3beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -398,11 +398,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -423,7 +423,7 @@ export namespace videointelligence_v1p3beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -436,6 +436,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -444,6 +448,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** * Speech transcription. */ @@ -460,11 +468,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -473,23 +481,23 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -516,15 +524,15 @@ export namespace videointelligence_v1p3beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -542,11 +550,11 @@ export namespace videointelligence_v1p3beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -576,11 +584,11 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -589,7 +597,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -602,19 +610,19 @@ export namespace videointelligence_v1p3beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -632,11 +640,11 @@ export namespace videointelligence_v1p3beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -645,7 +653,7 @@ export namespace videointelligence_v1p3beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -661,7 +669,7 @@ export namespace videointelligence_v1p3beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -674,7 +682,7 @@ export namespace videointelligence_v1p3beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -683,11 +691,11 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -704,7 +712,7 @@ export namespace videointelligence_v1p3beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -717,7 +725,7 @@ export namespace videointelligence_v1p3beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -730,7 +738,7 @@ export namespace videointelligence_v1p3beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -739,7 +747,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -756,15 +764,15 @@ export namespace videointelligence_v1p3beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -772,11 +780,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -797,7 +805,7 @@ export namespace videointelligence_v1p3beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -810,6 +818,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -818,6 +830,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -834,11 +850,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -847,23 +863,23 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -890,15 +906,15 @@ export namespace videointelligence_v1p3beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -916,11 +932,11 @@ export namespace videointelligence_v1p3beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -950,11 +966,11 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -963,7 +979,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -976,19 +992,19 @@ export namespace videointelligence_v1p3beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1006,11 +1022,11 @@ export namespace videointelligence_v1p3beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1019,7 +1035,7 @@ export namespace videointelligence_v1p3beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1035,7 +1051,7 @@ export namespace videointelligence_v1p3beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1048,7 +1064,7 @@ export namespace videointelligence_v1p3beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1057,11 +1073,11 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1078,7 +1094,7 @@ export namespace videointelligence_v1p3beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -1091,7 +1107,7 @@ export namespace videointelligence_v1p3beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1104,7 +1120,7 @@ export namespace videointelligence_v1p3beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1113,7 +1129,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1130,15 +1146,15 @@ export namespace videointelligence_v1p3beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1146,11 +1162,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1171,7 +1187,7 @@ export namespace videointelligence_v1p3beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -1184,6 +1200,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1192,6 +1212,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1208,11 +1232,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1221,23 +1245,23 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1255,23 +1279,23 @@ export namespace videointelligence_v1p3beta1 { /** * Requested video annotation features. */ - features?: string[]; + features?: string[] | null; /** * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ - inputContent?: string; + inputContent?: string | null; /** * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ - inputUri?: string; + inputUri?: string | null; /** * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ - locationId?: string; + locationId?: string | null; /** * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ - outputUri?: string; + outputUri?: string | null; /** * Additional video context and/or feature-specific parameters. */ @@ -1293,15 +1317,15 @@ export namespace videointelligence_v1p3beta1 { /** * Detected attribute confidence. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. */ - name?: string; + name?: string | null; /** * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. */ - value?: string; + value?: string | null; } /** * Detected entity from video analysis. @@ -1310,15 +1334,15 @@ export namespace videointelligence_v1p3beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1336,7 +1360,7 @@ export namespace videointelligence_v1p3beta1 { /** * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for explicit content. @@ -1345,11 +1369,11 @@ export namespace videointelligence_v1p3beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1379,23 +1403,23 @@ export namespace videointelligence_v1p3beta1 { /** * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - frameConfidenceThreshold?: number; + frameConfidenceThreshold?: number | null; /** * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ - labelDetectionMode?: string; + labelDetectionMode?: string | null; /** * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ - stationaryCamera?: boolean; + stationaryCamera?: boolean | null; /** * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ - videoConfidenceThreshold?: number; + videoConfidenceThreshold?: number | null; } /** * Video frame level annotation results for label detection. @@ -1404,11 +1428,11 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -1417,7 +1441,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -1447,19 +1471,19 @@ export namespace videointelligence_v1p3beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -1477,11 +1501,11 @@ export namespace videointelligence_v1p3beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -1490,7 +1514,7 @@ export namespace videointelligence_v1p3beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -1506,7 +1530,7 @@ export namespace videointelligence_v1p3beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Config for OBJECT_TRACKING. @@ -1515,7 +1539,7 @@ export namespace videointelligence_v1p3beta1 { /** * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -1528,7 +1552,7 @@ export namespace videointelligence_v1p3beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Config for SHOT_CHANGE_DETECTION. @@ -1537,7 +1561,7 @@ export namespace videointelligence_v1p3beta1 { /** * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -1546,7 +1570,7 @@ export namespace videointelligence_v1p3beta1 { /** * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ - phrases?: string[]; + phrases?: string[] | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -1555,11 +1579,11 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -1576,7 +1600,7 @@ export namespace videointelligence_v1p3beta1 { /** * 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; + languageCode?: string | null; } /** * Config for SPEECH_TRANSCRIPTION. @@ -1585,35 +1609,35 @@ export namespace videointelligence_v1p3beta1 { /** * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ - audioTracks?: number[]; + audioTracks?: number[] | null; /** * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ - diarizationSpeakerCount?: number; + diarizationSpeakerCount?: number | null; /** * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ - enableAutomaticPunctuation?: boolean; + enableAutomaticPunctuation?: boolean | null; /** * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ - enableSpeakerDiarization?: boolean; + enableSpeakerDiarization?: boolean | null; /** * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ - enableWordConfidence?: boolean; + enableWordConfidence?: boolean | null; /** * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ - filterProfanity?: boolean; + filterProfanity?: boolean | null; /** * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ - maxAlternatives?: number; + maxAlternatives?: number | null; /** * *Optional* A means to provide context to assist the speech recognition. */ @@ -1630,7 +1654,7 @@ export namespace videointelligence_v1p3beta1 { /** * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ - annotationResultsUri?: string; + annotationResultsUri?: string | null; /** * If set, returns a google.rpc.Status message that specifies the error for the operation. */ @@ -1668,7 +1692,7 @@ export namespace videointelligence_v1p3beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Config for TEXT_DETECTION. @@ -1677,11 +1701,11 @@ export namespace videointelligence_v1p3beta1 { /** * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1694,7 +1718,7 @@ export namespace videointelligence_v1p3beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -1703,7 +1727,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -1728,7 +1752,7 @@ export namespace videointelligence_v1p3beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. */ - timeOffset?: string; + timeOffset?: string | null; } /** * A track of an object instance. @@ -1741,7 +1765,7 @@ export namespace videointelligence_v1p3beta1 { /** * Optional. The confidence score of the tracked object. */ - confidence?: number; + confidence?: number | null; /** * Video segment of a track. */ @@ -1758,15 +1782,15 @@ export namespace videointelligence_v1p3beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -1774,11 +1798,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -1799,7 +1823,7 @@ export namespace videointelligence_v1p3beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of logos detected, tracked and recognized in video. */ @@ -1816,6 +1840,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -1824,6 +1852,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** * Speech transcription. */ @@ -1873,11 +1905,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -1886,23 +1918,23 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. @@ -1929,15 +1961,15 @@ export namespace videointelligence_v1p3beta1 { /** * Textual description, e.g. `Fixed-gear bicycle`. */ - description?: string; + description?: string | null; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - entityId?: string; + entityId?: string | null; /** * Language code for `description` in BCP-47 format. */ - languageCode?: string; + languageCode?: string | null; } /** * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. @@ -1955,11 +1987,11 @@ export namespace videointelligence_v1p3beta1 { /** * Likelihood of the pornography content.. */ - pornographyLikelihood?: string; + pornographyLikelihood?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Label annotation. @@ -1989,11 +2021,11 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for label detection. @@ -2002,7 +2034,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence that the label is accurate. Range: [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Video segment where a label was detected. */ @@ -2015,19 +2047,19 @@ export namespace videointelligence_v1p3beta1 { /** * Bottom Y coordinate. */ - bottom?: number; + bottom?: number | null; /** * Left X coordinate. */ - left?: number; + left?: number | null; /** * Right X coordinate. */ - right?: number; + right?: number | null; /** * Top Y coordinate. */ - top?: number; + top?: number | null; } /** * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. @@ -2045,11 +2077,11 @@ export namespace videointelligence_v1p3beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Annotations corresponding to one tracked object. @@ -2058,7 +2090,7 @@ export namespace videointelligence_v1p3beta1 { /** * Object category's labeling confidence of this track. */ - confidence?: number; + confidence?: number | null; /** * Entity to specify the object category that this track is labeled as. */ @@ -2074,7 +2106,7 @@ export namespace videointelligence_v1p3beta1 { /** * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ - trackId?: string; + trackId?: string | null; } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. @@ -2087,7 +2119,7 @@ export namespace videointelligence_v1p3beta1 { /** * The timestamp of the frame in microseconds. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Alternative hypotheses (a.k.a. n-best list). @@ -2096,11 +2128,11 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Transcript text representing the words that the user spoke. */ - transcript?: string; + transcript?: string | null; /** * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ @@ -2117,7 +2149,7 @@ export namespace videointelligence_v1p3beta1 { /** * 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; + languageCode?: string | null; } /** * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. @@ -2130,7 +2162,7 @@ export namespace videointelligence_v1p3beta1 { /** * The detected text. */ - text?: string; + text?: string | null; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -2143,7 +2175,7 @@ export namespace videointelligence_v1p3beta1 { /** * Timestamp of this frame. */ - timeOffset?: string; + timeOffset?: string | null; } /** * Video segment level annotation results for text detection. @@ -2152,7 +2184,7 @@ export namespace videointelligence_v1p3beta1 { /** * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ - confidence?: number; + confidence?: number | null; /** * Information related to the frames where OCR detected text appears. */ @@ -2169,15 +2201,15 @@ export namespace videointelligence_v1p3beta1 { /** * Specifies which feature is being tracked if the request contains more than one features. */ - feature?: string; + feature?: string | null; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ - progressPercent?: number; + progressPercent?: number | null; /** * Specifies which segment is being tracked if the request contains more than one segments. */ @@ -2185,11 +2217,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time when the request was received. */ - startTime?: string; + startTime?: string | null; /** * Time of the most recent update. */ - updateTime?: string; + updateTime?: string | null; } /** * Annotation results for a single video. @@ -2210,7 +2242,7 @@ export namespace videointelligence_v1p3beta1 { /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ - inputUri?: string; + inputUri?: string | null; /** * Annotations for list of objects detected and tracked in video. */ @@ -2223,6 +2255,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + */ + segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Shot annotations. Each shot is represented as a video segment. */ @@ -2231,6 +2267,10 @@ export namespace videointelligence_v1p3beta1 { * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Presence label annotations on shot level. There is exactly one element for each unique label. + */ + shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** * Speech transcription. */ @@ -2247,11 +2287,11 @@ export namespace videointelligence_v1p3beta1 { /** * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ - endTimeOffset?: string; + endTimeOffset?: string | null; /** * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ - startTimeOffset?: string; + startTimeOffset?: string | null; } /** * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. @@ -2260,23 +2300,23 @@ export namespace videointelligence_v1p3beta1 { /** * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ - confidence?: number; + confidence?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string; + endTime?: string | null; /** * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ - speakerTag?: number; + speakerTag?: number | null; /** * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string; + startTime?: string | null; /** * The word corresponding to this set of information. */ - word?: string; + word?: string | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -2285,7 +2325,7 @@ export namespace videointelligence_v1p3beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -2293,15 +2333,15 @@ export namespace videointelligence_v1p3beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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). @@ -2310,15 +2350,15 @@ export namespace videointelligence_v1p3beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } export class Resource$Videos { diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 7cddb4cd436..7bcd92e3c3b 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -132,7 +132,7 @@ export namespace vision_v1 { /** * The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ - product?: string; + product?: string | null; } /** * A request to annotate one single file, e.g. a PDF, TIFF or GIF file. @@ -153,7 +153,7 @@ export namespace vision_v1 { /** * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. */ - pages?: number[]; + pages?: number[] | null; } /** * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. @@ -174,7 +174,7 @@ export namespace vision_v1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information. @@ -291,7 +291,7 @@ export namespace vision_v1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual async file annotation requests for this batch. */ @@ -317,7 +317,7 @@ export namespace vision_v1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual image annotation requests for this batch. */ @@ -339,7 +339,7 @@ export namespace vision_v1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. */ @@ -361,7 +361,7 @@ export namespace vision_v1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual image annotation requests for this batch. */ @@ -383,15 +383,15 @@ export namespace vision_v1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -400,7 +400,7 @@ export namespace vision_v1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -408,7 +408,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -442,19 +442,19 @@ export namespace vision_v1 { /** * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ - alpha?: number; + alpha?: number | null; /** * The amount of blue in the color as a value in the interval [0, 1]. */ - blue?: number; + blue?: number | null; /** * The amount of green in the color as a value in the interval [0, 1]. */ - green?: number; + green?: number | null; /** * The amount of red in the color as a value in the interval [0, 1]. */ - red?: number; + red?: number | null; } /** * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. @@ -467,11 +467,11 @@ export namespace vision_v1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -484,11 +484,11 @@ export namespace vision_v1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -506,7 +506,7 @@ export namespace vision_v1 { /** * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ - aspectRatios?: number[]; + aspectRatios?: number[] | null; } /** * Detected start or end of a structural component. @@ -515,11 +515,11 @@ export namespace vision_v1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -528,11 +528,11 @@ export namespace vision_v1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Set of dominant colors and their corresponding scores. @@ -558,15 +558,15 @@ export namespace vision_v1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -574,7 +574,7 @@ export namespace vision_v1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -582,11 +582,11 @@ export namespace vision_v1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -595,11 +595,11 @@ export namespace vision_v1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -607,7 +607,7 @@ export namespace vision_v1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -615,15 +615,15 @@ export namespace vision_v1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -631,27 +631,27 @@ export namespace vision_v1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. @@ -660,15 +660,15 @@ export namespace vision_v1 { /** * Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. */ - maxResults?: number; + maxResults?: number | null; /** * Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * The feature type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -677,7 +677,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -686,7 +686,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. @@ -707,7 +707,7 @@ export namespace vision_v1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -795,7 +795,7 @@ export namespace vision_v1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -803,7 +803,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -837,11 +837,11 @@ export namespace vision_v1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -854,11 +854,11 @@ export namespace vision_v1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -889,15 +889,15 @@ export namespace vision_v1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -905,7 +905,7 @@ export namespace vision_v1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -913,11 +913,11 @@ export namespace vision_v1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -926,11 +926,11 @@ export namespace vision_v1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -938,7 +938,7 @@ export namespace vision_v1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -946,15 +946,15 @@ export namespace vision_v1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -962,27 +962,27 @@ export namespace vision_v1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -995,7 +995,7 @@ export namespace vision_v1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -1004,7 +1004,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -1013,7 +1013,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -1022,11 +1022,11 @@ export namespace vision_v1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -1044,7 +1044,7 @@ export namespace vision_v1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -1052,7 +1052,7 @@ export namespace vision_v1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -1065,19 +1065,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -1095,11 +1095,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -1108,15 +1108,15 @@ export namespace vision_v1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -1125,7 +1125,7 @@ export namespace vision_v1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -1142,11 +1142,11 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -1154,7 +1154,7 @@ export namespace vision_v1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -1167,7 +1167,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -1184,15 +1184,15 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -1201,19 +1201,19 @@ export namespace vision_v1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -1226,11 +1226,11 @@ export namespace vision_v1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -1239,7 +1239,7 @@ export namespace vision_v1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -1273,19 +1273,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -1294,7 +1294,7 @@ export namespace vision_v1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -1302,7 +1302,7 @@ export namespace vision_v1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -1311,15 +1311,15 @@ export namespace vision_v1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -1328,23 +1328,23 @@ export namespace vision_v1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -1357,7 +1357,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -1365,7 +1365,7 @@ export namespace vision_v1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -1378,7 +1378,7 @@ export namespace vision_v1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -1387,11 +1387,11 @@ export namespace vision_v1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -1400,11 +1400,11 @@ export namespace vision_v1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -1426,11 +1426,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -1468,15 +1468,15 @@ export namespace vision_v1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -1485,11 +1485,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -1498,11 +1498,11 @@ export namespace vision_v1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -1515,7 +1515,7 @@ export namespace vision_v1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -1523,11 +1523,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -1540,7 +1540,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -1569,7 +1569,7 @@ export namespace vision_v1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -1657,7 +1657,7 @@ export namespace vision_v1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -1665,7 +1665,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -1699,11 +1699,11 @@ export namespace vision_v1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -1716,11 +1716,11 @@ export namespace vision_v1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -1751,15 +1751,15 @@ export namespace vision_v1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -1767,7 +1767,7 @@ export namespace vision_v1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -1775,11 +1775,11 @@ export namespace vision_v1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -1788,11 +1788,11 @@ export namespace vision_v1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -1800,7 +1800,7 @@ export namespace vision_v1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -1808,15 +1808,15 @@ export namespace vision_v1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -1824,27 +1824,27 @@ export namespace vision_v1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -1857,7 +1857,7 @@ export namespace vision_v1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -1866,7 +1866,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -1875,7 +1875,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -1884,11 +1884,11 @@ export namespace vision_v1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -1906,7 +1906,7 @@ export namespace vision_v1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -1914,7 +1914,7 @@ export namespace vision_v1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -1927,19 +1927,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -1957,11 +1957,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -1970,15 +1970,15 @@ export namespace vision_v1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -1987,7 +1987,7 @@ export namespace vision_v1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -2004,11 +2004,11 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -2016,7 +2016,7 @@ export namespace vision_v1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -2029,7 +2029,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -2046,15 +2046,15 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -2063,19 +2063,19 @@ export namespace vision_v1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -2088,11 +2088,11 @@ export namespace vision_v1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -2101,7 +2101,7 @@ export namespace vision_v1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -2135,19 +2135,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -2156,7 +2156,7 @@ export namespace vision_v1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -2164,7 +2164,7 @@ export namespace vision_v1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -2173,15 +2173,15 @@ export namespace vision_v1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -2190,23 +2190,23 @@ export namespace vision_v1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -2219,7 +2219,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -2227,7 +2227,7 @@ export namespace vision_v1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -2240,7 +2240,7 @@ export namespace vision_v1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -2249,11 +2249,11 @@ export namespace vision_v1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -2262,11 +2262,11 @@ export namespace vision_v1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -2288,11 +2288,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -2330,15 +2330,15 @@ export namespace vision_v1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -2347,11 +2347,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -2360,11 +2360,11 @@ export namespace vision_v1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -2377,7 +2377,7 @@ export namespace vision_v1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -2385,11 +2385,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -2402,7 +2402,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -2431,7 +2431,7 @@ export namespace vision_v1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -2519,15 +2519,15 @@ export namespace vision_v1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -2536,7 +2536,7 @@ export namespace vision_v1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -2544,7 +2544,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -2578,11 +2578,11 @@ export namespace vision_v1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -2595,11 +2595,11 @@ export namespace vision_v1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -2630,15 +2630,15 @@ export namespace vision_v1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -2646,7 +2646,7 @@ export namespace vision_v1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -2654,11 +2654,11 @@ export namespace vision_v1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -2667,11 +2667,11 @@ export namespace vision_v1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -2679,7 +2679,7 @@ export namespace vision_v1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -2687,15 +2687,15 @@ export namespace vision_v1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -2703,27 +2703,27 @@ export namespace vision_v1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -2736,7 +2736,7 @@ export namespace vision_v1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -2745,7 +2745,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -2754,7 +2754,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -2763,11 +2763,11 @@ export namespace vision_v1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -2798,7 +2798,7 @@ export namespace vision_v1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -2806,7 +2806,7 @@ export namespace vision_v1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -2819,19 +2819,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -2849,11 +2849,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -2862,15 +2862,15 @@ export namespace vision_v1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -2879,7 +2879,7 @@ export namespace vision_v1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -2896,11 +2896,11 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -2908,7 +2908,7 @@ export namespace vision_v1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -2921,7 +2921,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -2938,15 +2938,15 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -2955,19 +2955,19 @@ export namespace vision_v1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -2980,11 +2980,11 @@ export namespace vision_v1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -2993,7 +2993,7 @@ export namespace vision_v1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -3027,19 +3027,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -3048,7 +3048,7 @@ export namespace vision_v1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -3056,7 +3056,7 @@ export namespace vision_v1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -3065,15 +3065,15 @@ export namespace vision_v1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -3086,11 +3086,11 @@ export namespace vision_v1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -3099,23 +3099,23 @@ export namespace vision_v1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -3128,7 +3128,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -3136,7 +3136,7 @@ export namespace vision_v1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -3149,7 +3149,7 @@ export namespace vision_v1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -3158,11 +3158,11 @@ export namespace vision_v1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -3171,11 +3171,11 @@ export namespace vision_v1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -3197,11 +3197,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -3239,15 +3239,15 @@ export namespace vision_v1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -3256,11 +3256,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -3269,11 +3269,11 @@ export namespace vision_v1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -3286,7 +3286,7 @@ export namespace vision_v1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -3294,11 +3294,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -3311,7 +3311,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -3340,7 +3340,7 @@ export namespace vision_v1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -3454,15 +3454,15 @@ export namespace vision_v1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -3471,7 +3471,7 @@ export namespace vision_v1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -3479,7 +3479,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -3513,11 +3513,11 @@ export namespace vision_v1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -3530,11 +3530,11 @@ export namespace vision_v1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -3565,15 +3565,15 @@ export namespace vision_v1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -3581,7 +3581,7 @@ export namespace vision_v1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -3589,11 +3589,11 @@ export namespace vision_v1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -3602,11 +3602,11 @@ export namespace vision_v1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -3614,7 +3614,7 @@ export namespace vision_v1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -3622,15 +3622,15 @@ export namespace vision_v1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -3638,27 +3638,27 @@ export namespace vision_v1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -3671,7 +3671,7 @@ export namespace vision_v1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -3680,7 +3680,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -3689,7 +3689,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -3698,11 +3698,11 @@ export namespace vision_v1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -3720,7 +3720,7 @@ export namespace vision_v1 { /** * A score representing the aesthetic/technical quality of the image. The score is in range [0, 1]. Higher value corresponds to more professional looking photos. 0 means the image looks very bad, 1 means the image with very high quality. */ - qualityScore?: number; + qualityScore?: number | null; } /** * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. @@ -3742,7 +3742,7 @@ export namespace vision_v1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -3750,7 +3750,7 @@ export namespace vision_v1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -3763,19 +3763,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -3793,11 +3793,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -3806,15 +3806,15 @@ export namespace vision_v1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -3823,7 +3823,7 @@ export namespace vision_v1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -3840,11 +3840,11 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -3852,7 +3852,7 @@ export namespace vision_v1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -3865,7 +3865,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -3882,15 +3882,15 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -3899,19 +3899,19 @@ export namespace vision_v1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -3924,11 +3924,11 @@ export namespace vision_v1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -3937,7 +3937,7 @@ export namespace vision_v1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -3971,19 +3971,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -3992,7 +3992,7 @@ export namespace vision_v1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -4000,7 +4000,7 @@ export namespace vision_v1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -4009,15 +4009,15 @@ export namespace vision_v1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Stores enhanced image bytes. @@ -4026,15 +4026,15 @@ export namespace vision_v1 { /** * Optimized image bytes. */ - image?: string; + image?: string | null; /** * Mime type of the output image. */ - mimeType?: string; + mimeType?: string | null; /** * Required optimization type. */ - qualityOptimizationType?: string; + qualityOptimizationType?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -4047,11 +4047,11 @@ export namespace vision_v1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -4060,47 +4060,47 @@ export namespace vision_v1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * A single symbol representation. @@ -4113,7 +4113,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -4121,7 +4121,7 @@ export namespace vision_v1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -4134,7 +4134,7 @@ export namespace vision_v1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -4143,11 +4143,11 @@ export namespace vision_v1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -4156,11 +4156,11 @@ export namespace vision_v1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -4182,11 +4182,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -4224,15 +4224,15 @@ export namespace vision_v1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -4241,11 +4241,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -4254,11 +4254,11 @@ export namespace vision_v1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -4271,7 +4271,7 @@ export namespace vision_v1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -4279,11 +4279,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -4296,7 +4296,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -4325,7 +4325,7 @@ export namespace vision_v1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -4431,15 +4431,15 @@ export namespace vision_v1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -4448,7 +4448,7 @@ export namespace vision_v1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -4456,7 +4456,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ @@ -4464,7 +4464,7 @@ export namespace vision_v1 { /** * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. */ - mergedText?: string; + mergedText?: string | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -4502,11 +4502,11 @@ export namespace vision_v1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -4519,11 +4519,11 @@ export namespace vision_v1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -4554,15 +4554,15 @@ export namespace vision_v1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -4570,7 +4570,7 @@ export namespace vision_v1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -4578,11 +4578,11 @@ export namespace vision_v1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -4591,11 +4591,11 @@ export namespace vision_v1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -4603,7 +4603,7 @@ export namespace vision_v1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -4611,15 +4611,15 @@ export namespace vision_v1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -4627,27 +4627,27 @@ export namespace vision_v1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -4660,7 +4660,7 @@ export namespace vision_v1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -4669,7 +4669,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -4678,7 +4678,7 @@ export namespace vision_v1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -4687,11 +4687,11 @@ export namespace vision_v1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -4722,7 +4722,7 @@ export namespace vision_v1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -4730,7 +4730,7 @@ export namespace vision_v1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Proto for a key value pair. @@ -4739,7 +4739,7 @@ export namespace vision_v1 { /** * The key string value. */ - key?: string; + key?: string | null; /** * Key block of the pair containing the normalized bounding box and key text. */ @@ -4747,7 +4747,7 @@ export namespace vision_v1 { /** * Optional. The translation of key text if the text is not in English. */ - normalizedKey?: string; + normalizedKey?: string | null; /** * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. */ @@ -4755,7 +4755,7 @@ export namespace vision_v1 { /** * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. */ - valueType?: string; + valueType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -4768,19 +4768,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -4798,11 +4798,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -4811,15 +4811,15 @@ export namespace vision_v1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -4828,7 +4828,7 @@ export namespace vision_v1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -4845,15 +4845,15 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected on the page. */ @@ -4861,7 +4861,7 @@ export namespace vision_v1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -4874,11 +4874,11 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected for the paragraph. */ @@ -4895,15 +4895,15 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -4912,19 +4912,19 @@ export namespace vision_v1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -4937,11 +4937,11 @@ export namespace vision_v1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -4950,7 +4950,7 @@ export namespace vision_v1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -4984,19 +4984,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -5005,7 +5005,7 @@ export namespace vision_v1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -5013,7 +5013,7 @@ export namespace vision_v1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -5022,15 +5022,15 @@ export namespace vision_v1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -5043,11 +5043,11 @@ export namespace vision_v1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -5056,47 +5056,47 @@ export namespace vision_v1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * A single symbol representation. @@ -5109,7 +5109,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -5117,7 +5117,7 @@ export namespace vision_v1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * A table representation similar to HTML table structure. @@ -5139,15 +5139,15 @@ export namespace vision_v1 { /** * How many columns this cell spans. */ - colSpan?: number; + colSpan?: number | null; /** * How many rows this cell spans. */ - rowSpan?: number; + rowSpan?: number | null; /** * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. */ - text?: string; + text?: string | null; /** * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. */ @@ -5173,7 +5173,7 @@ export namespace vision_v1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -5182,11 +5182,11 @@ export namespace vision_v1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -5195,11 +5195,11 @@ export namespace vision_v1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -5221,11 +5221,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -5263,15 +5263,15 @@ export namespace vision_v1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -5280,11 +5280,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -5293,11 +5293,11 @@ export namespace vision_v1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -5310,7 +5310,7 @@ export namespace vision_v1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -5318,11 +5318,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -5335,11 +5335,11 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected for the word. */ @@ -5373,7 +5373,7 @@ export namespace vision_v1 { /** * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ - content?: string; + content?: string | null; /** * Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request. */ @@ -5386,11 +5386,11 @@ export namespace vision_v1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Image context and/or feature-specific parameters. @@ -5403,7 +5403,7 @@ export namespace vision_v1 { /** * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Not used. */ @@ -5433,11 +5433,11 @@ export namespace vision_v1 { /** * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ - gcsImageUri?: string; + gcsImageUri?: string | null; /** * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ - imageUri?: string; + imageUri?: string | null; } /** * The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line. @@ -5446,7 +5446,7 @@ export namespace vision_v1 { /** * The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to display_name, the `product-category` column refers to product_category, and the `labels` column refers to product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: "key_1=value_1,key_2=value_2,...,key_n=value_n" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP). */ - csvFileUri?: string; + csvFileUri?: string | null; } /** * The input content for the `ImportProductSets` method. @@ -5486,7 +5486,7 @@ export namespace vision_v1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -5494,7 +5494,7 @@ export namespace vision_v1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * A product label represented as a key-value pair. @@ -5503,11 +5503,11 @@ export namespace vision_v1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -5520,7 +5520,7 @@ export namespace vision_v1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -5529,11 +5529,11 @@ export namespace vision_v1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Rectangle determined by min and max `LatLng` pairs. @@ -5555,7 +5555,7 @@ export namespace vision_v1 { /** * The standard List next-page token. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * A list of operations that matches the specified filter in the request. */ @@ -5568,7 +5568,7 @@ export namespace vision_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of ProductSets. */ @@ -5581,7 +5581,7 @@ export namespace vision_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of Products. */ @@ -5594,7 +5594,7 @@ export namespace vision_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * List of products. */ @@ -5607,11 +5607,11 @@ export namespace vision_v1 { /** * The next_page_token returned from a previous List request, if any. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The maximum number of items to return. Default 10, maximum 100. */ - pageSize?: number; + pageSize?: number | null; /** * The list of reference images. */ @@ -5628,19 +5628,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -5658,11 +5658,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Prediction for what the object in the bounding box is. @@ -5671,19 +5671,19 @@ export namespace vision_v1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -5692,7 +5692,7 @@ export namespace vision_v1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -5700,15 +5700,15 @@ export namespace vision_v1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -5717,15 +5717,15 @@ export namespace vision_v1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -5734,7 +5734,7 @@ export namespace vision_v1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -5751,11 +5751,11 @@ export namespace vision_v1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -5763,7 +5763,7 @@ export namespace vision_v1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -5776,7 +5776,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -5793,15 +5793,15 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -5810,19 +5810,19 @@ export namespace vision_v1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -5839,15 +5839,15 @@ export namespace vision_v1 { /** * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ - filter?: string; + filter?: string | null; /** * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ - productCategories?: string[]; + productCategories?: string[] | null; /** * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ - productSet?: string; + productSet?: string | null; } /** * Results for a product search request. @@ -5856,7 +5856,7 @@ export namespace vision_v1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -5873,7 +5873,7 @@ export namespace vision_v1 { /** * The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet. */ @@ -5881,11 +5881,11 @@ export namespace vision_v1 { /** * Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. */ - indexTime?: string; + indexTime?: string | null; /** * The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. */ - name?: string; + name?: string | null; } /** * Config to control which ProductSet contains the Products to be deleted. @@ -5894,7 +5894,7 @@ export namespace vision_v1 { /** * The ProductSet that contains the Products to delete. If a Product is a member of product_set_id in addition to other ProductSets, the Product will still be deleted. */ - productSetId?: string; + productSetId?: string | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -5903,15 +5903,15 @@ export namespace vision_v1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Request message for the `PurgeProducts` method. @@ -5920,11 +5920,11 @@ export namespace vision_v1 { /** * If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted. */ - deleteOrphanProducts?: boolean; + deleteOrphanProducts?: boolean | null; /** * The default value is false. Override this value to true to actually perform the purge. */ - force?: boolean; + force?: boolean | null; /** * Specify which ProductSet contains the Products to be deleted. */ @@ -5941,11 +5941,11 @@ export namespace vision_v1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Request message for the `RemoveProductFromProductSet` method. @@ -5954,7 +5954,7 @@ export namespace vision_v1 { /** * The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ - product?: string; + product?: string | null; } /** * Information about a product. @@ -5963,7 +5963,7 @@ export namespace vision_v1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -5971,7 +5971,7 @@ export namespace vision_v1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -5980,47 +5980,47 @@ export namespace vision_v1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -6029,15 +6029,15 @@ export namespace vision_v1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A single symbol representation. @@ -6050,7 +6050,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -6058,7 +6058,7 @@ export namespace vision_v1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -6071,7 +6071,7 @@ export namespace vision_v1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Additional information detected on the structural component. @@ -6093,11 +6093,11 @@ export namespace vision_v1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -6135,7 +6135,7 @@ export namespace vision_v1 { /** * Whether to include results derived from the geo information in the image. */ - includeGeoResults?: boolean; + includeGeoResults?: boolean | null; } /** * Entity deduced from similar images on the Internet. @@ -6144,15 +6144,15 @@ export namespace vision_v1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -6161,11 +6161,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -6174,11 +6174,11 @@ export namespace vision_v1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -6191,7 +6191,7 @@ export namespace vision_v1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -6199,11 +6199,11 @@ export namespace vision_v1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -6216,7 +6216,7 @@ export namespace vision_v1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 5261f7bea50..ab78d345513 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -140,7 +140,7 @@ export namespace vision_v1p1beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -246,15 +246,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -263,7 +263,7 @@ export namespace vision_v1p1beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -271,7 +271,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -301,19 +301,19 @@ export namespace vision_v1p1beta1 { /** * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ - alpha?: number; + alpha?: number | null; /** * The amount of blue in the color as a value in the interval [0, 1]. */ - blue?: number; + blue?: number | null; /** * The amount of green in the color as a value in the interval [0, 1]. */ - green?: number; + green?: number | null; /** * The amount of red in the color as a value in the interval [0, 1]. */ - red?: number; + red?: number | null; } /** * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. @@ -326,11 +326,11 @@ export namespace vision_v1p1beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -343,11 +343,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -365,11 +365,11 @@ export namespace vision_v1p1beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -378,11 +378,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Set of dominant colors and their corresponding scores. @@ -404,15 +404,15 @@ export namespace vision_v1p1beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -420,7 +420,7 @@ export namespace vision_v1p1beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -428,11 +428,11 @@ export namespace vision_v1p1beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -441,11 +441,11 @@ export namespace vision_v1p1beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -453,7 +453,7 @@ export namespace vision_v1p1beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -461,15 +461,15 @@ export namespace vision_v1p1beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -477,27 +477,27 @@ export namespace vision_v1p1beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -506,7 +506,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -515,7 +515,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * A request to annotate one single file, e.g. a PDF, TIFF or GIF file. @@ -536,7 +536,7 @@ export namespace vision_v1p1beta1 { /** * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. */ - pages?: number[]; + pages?: number[] | null; } /** * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. @@ -557,7 +557,7 @@ export namespace vision_v1p1beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information. @@ -674,7 +674,7 @@ export namespace vision_v1p1beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual async file annotation requests for this batch. */ @@ -700,7 +700,7 @@ export namespace vision_v1p1beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual image annotation requests for this batch. */ @@ -713,7 +713,7 @@ export namespace vision_v1p1beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. */ @@ -735,7 +735,7 @@ export namespace vision_v1p1beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual image annotation requests for this batch. */ @@ -757,7 +757,7 @@ export namespace vision_v1p1beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -765,7 +765,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -799,11 +799,11 @@ export namespace vision_v1p1beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -816,11 +816,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -838,7 +838,7 @@ export namespace vision_v1p1beta1 { /** * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ - aspectRatios?: number[]; + aspectRatios?: number[] | null; } /** * Set of dominant colors and their corresponding scores. @@ -860,15 +860,15 @@ export namespace vision_v1p1beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -876,7 +876,7 @@ export namespace vision_v1p1beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -884,11 +884,11 @@ export namespace vision_v1p1beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -897,11 +897,11 @@ export namespace vision_v1p1beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -909,7 +909,7 @@ export namespace vision_v1p1beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -917,15 +917,15 @@ export namespace vision_v1p1beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -933,27 +933,27 @@ export namespace vision_v1p1beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -966,7 +966,7 @@ export namespace vision_v1p1beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. @@ -975,15 +975,15 @@ export namespace vision_v1p1beta1 { /** * Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. */ - maxResults?: number; + maxResults?: number | null; /** * Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * The feature type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -992,7 +992,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -1001,7 +1001,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * Client image to perform Google Cloud Vision API tasks over. @@ -1010,7 +1010,7 @@ export namespace vision_v1p1beta1 { /** * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ - content?: string; + content?: string | null; /** * Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request. */ @@ -1023,11 +1023,11 @@ export namespace vision_v1p1beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Image context and/or feature-specific parameters. @@ -1040,7 +1040,7 @@ export namespace vision_v1p1beta1 { /** * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Not used. */ @@ -1070,11 +1070,11 @@ export namespace vision_v1p1beta1 { /** * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ - gcsImageUri?: string; + gcsImageUri?: string | null; /** * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ - imageUri?: string; + imageUri?: string | null; } /** * The desired input location and metadata. @@ -1083,7 +1083,7 @@ export namespace vision_v1p1beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -1091,7 +1091,7 @@ export namespace vision_v1p1beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Rectangle determined by min and max `LatLng` pairs. @@ -1117,19 +1117,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -1147,11 +1147,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -1160,15 +1160,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -1177,7 +1177,7 @@ export namespace vision_v1p1beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -1194,11 +1194,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -1206,7 +1206,7 @@ export namespace vision_v1p1beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -1219,7 +1219,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -1236,15 +1236,15 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -1253,19 +1253,19 @@ export namespace vision_v1p1beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -1278,11 +1278,11 @@ export namespace vision_v1p1beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Parameters for a product search request. @@ -1295,15 +1295,15 @@ export namespace vision_v1p1beta1 { /** * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ - filter?: string; + filter?: string | null; /** * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ - productCategories?: string[]; + productCategories?: string[] | null; /** * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ - productSet?: string; + productSet?: string | null; } /** * Results for a product search request. @@ -1312,7 +1312,7 @@ export namespace vision_v1p1beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -1346,19 +1346,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -1367,7 +1367,7 @@ export namespace vision_v1p1beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -1375,7 +1375,7 @@ export namespace vision_v1p1beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -1384,15 +1384,15 @@ export namespace vision_v1p1beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -1401,23 +1401,23 @@ export namespace vision_v1p1beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -1430,7 +1430,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -1438,7 +1438,7 @@ export namespace vision_v1p1beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -1451,7 +1451,7 @@ export namespace vision_v1p1beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -1460,11 +1460,11 @@ export namespace vision_v1p1beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -1473,11 +1473,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -1499,11 +1499,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -1541,7 +1541,7 @@ export namespace vision_v1p1beta1 { /** * Whether to include results derived from the geo information in the image. */ - includeGeoResults?: boolean; + includeGeoResults?: boolean | null; } /** * Entity deduced from similar images on the Internet. @@ -1550,15 +1550,15 @@ export namespace vision_v1p1beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -1567,11 +1567,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -1580,11 +1580,11 @@ export namespace vision_v1p1beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -1597,7 +1597,7 @@ export namespace vision_v1p1beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -1605,11 +1605,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -1622,7 +1622,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -1651,7 +1651,7 @@ export namespace vision_v1p1beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -1739,7 +1739,7 @@ export namespace vision_v1p1beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -1747,7 +1747,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -1781,11 +1781,11 @@ export namespace vision_v1p1beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -1798,11 +1798,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -1833,15 +1833,15 @@ export namespace vision_v1p1beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -1849,7 +1849,7 @@ export namespace vision_v1p1beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -1857,11 +1857,11 @@ export namespace vision_v1p1beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -1870,11 +1870,11 @@ export namespace vision_v1p1beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -1882,7 +1882,7 @@ export namespace vision_v1p1beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -1890,15 +1890,15 @@ export namespace vision_v1p1beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -1906,27 +1906,27 @@ export namespace vision_v1p1beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -1939,7 +1939,7 @@ export namespace vision_v1p1beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -1948,7 +1948,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -1957,7 +1957,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -1966,11 +1966,11 @@ export namespace vision_v1p1beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -1988,7 +1988,7 @@ export namespace vision_v1p1beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -1996,7 +1996,7 @@ export namespace vision_v1p1beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -2009,19 +2009,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -2039,11 +2039,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -2052,15 +2052,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -2069,7 +2069,7 @@ export namespace vision_v1p1beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -2086,11 +2086,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -2098,7 +2098,7 @@ export namespace vision_v1p1beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -2111,7 +2111,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -2128,15 +2128,15 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -2145,19 +2145,19 @@ export namespace vision_v1p1beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -2170,11 +2170,11 @@ export namespace vision_v1p1beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -2183,7 +2183,7 @@ export namespace vision_v1p1beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -2217,19 +2217,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -2238,7 +2238,7 @@ export namespace vision_v1p1beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -2246,7 +2246,7 @@ export namespace vision_v1p1beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -2255,15 +2255,15 @@ export namespace vision_v1p1beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -2272,23 +2272,23 @@ export namespace vision_v1p1beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -2301,7 +2301,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -2309,7 +2309,7 @@ export namespace vision_v1p1beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -2322,7 +2322,7 @@ export namespace vision_v1p1beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -2331,11 +2331,11 @@ export namespace vision_v1p1beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -2344,11 +2344,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -2370,11 +2370,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -2412,15 +2412,15 @@ export namespace vision_v1p1beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -2429,11 +2429,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -2442,11 +2442,11 @@ export namespace vision_v1p1beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -2459,7 +2459,7 @@ export namespace vision_v1p1beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -2467,11 +2467,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -2484,7 +2484,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -2513,7 +2513,7 @@ export namespace vision_v1p1beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -2601,15 +2601,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -2618,7 +2618,7 @@ export namespace vision_v1p1beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -2626,7 +2626,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -2660,11 +2660,11 @@ export namespace vision_v1p1beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -2677,11 +2677,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -2712,15 +2712,15 @@ export namespace vision_v1p1beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -2728,7 +2728,7 @@ export namespace vision_v1p1beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -2736,11 +2736,11 @@ export namespace vision_v1p1beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -2749,11 +2749,11 @@ export namespace vision_v1p1beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -2761,7 +2761,7 @@ export namespace vision_v1p1beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -2769,15 +2769,15 @@ export namespace vision_v1p1beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -2785,27 +2785,27 @@ export namespace vision_v1p1beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -2818,7 +2818,7 @@ export namespace vision_v1p1beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -2827,7 +2827,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -2836,7 +2836,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -2845,11 +2845,11 @@ export namespace vision_v1p1beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -2880,7 +2880,7 @@ export namespace vision_v1p1beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -2888,7 +2888,7 @@ export namespace vision_v1p1beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -2901,19 +2901,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -2931,11 +2931,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -2944,15 +2944,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -2961,7 +2961,7 @@ export namespace vision_v1p1beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -2978,11 +2978,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -2990,7 +2990,7 @@ export namespace vision_v1p1beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -3003,7 +3003,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -3020,15 +3020,15 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -3037,19 +3037,19 @@ export namespace vision_v1p1beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -3062,11 +3062,11 @@ export namespace vision_v1p1beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -3075,7 +3075,7 @@ export namespace vision_v1p1beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -3109,19 +3109,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -3130,7 +3130,7 @@ export namespace vision_v1p1beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -3138,7 +3138,7 @@ export namespace vision_v1p1beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -3147,15 +3147,15 @@ export namespace vision_v1p1beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -3168,11 +3168,11 @@ export namespace vision_v1p1beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -3181,23 +3181,23 @@ export namespace vision_v1p1beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -3210,7 +3210,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -3218,7 +3218,7 @@ export namespace vision_v1p1beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -3231,7 +3231,7 @@ export namespace vision_v1p1beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -3240,11 +3240,11 @@ export namespace vision_v1p1beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -3253,11 +3253,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -3279,11 +3279,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -3321,15 +3321,15 @@ export namespace vision_v1p1beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -3338,11 +3338,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -3351,11 +3351,11 @@ export namespace vision_v1p1beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -3368,7 +3368,7 @@ export namespace vision_v1p1beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -3376,11 +3376,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -3393,7 +3393,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -3422,7 +3422,7 @@ export namespace vision_v1p1beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -3536,15 +3536,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -3553,7 +3553,7 @@ export namespace vision_v1p1beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -3561,7 +3561,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -3595,11 +3595,11 @@ export namespace vision_v1p1beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -3612,11 +3612,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -3647,15 +3647,15 @@ export namespace vision_v1p1beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -3663,7 +3663,7 @@ export namespace vision_v1p1beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -3671,11 +3671,11 @@ export namespace vision_v1p1beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -3684,11 +3684,11 @@ export namespace vision_v1p1beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -3696,7 +3696,7 @@ export namespace vision_v1p1beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -3704,15 +3704,15 @@ export namespace vision_v1p1beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -3720,27 +3720,27 @@ export namespace vision_v1p1beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -3753,7 +3753,7 @@ export namespace vision_v1p1beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -3762,7 +3762,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -3771,7 +3771,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -3780,11 +3780,11 @@ export namespace vision_v1p1beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -3802,7 +3802,7 @@ export namespace vision_v1p1beta1 { /** * A score representing the aesthetic/technical quality of the image. The score is in range [0, 1]. Higher value corresponds to more professional looking photos. 0 means the image looks very bad, 1 means the image with very high quality. */ - qualityScore?: number; + qualityScore?: number | null; } /** * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. @@ -3824,7 +3824,7 @@ export namespace vision_v1p1beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -3832,7 +3832,7 @@ export namespace vision_v1p1beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -3845,19 +3845,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -3875,11 +3875,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -3888,15 +3888,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -3905,7 +3905,7 @@ export namespace vision_v1p1beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -3922,11 +3922,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -3934,7 +3934,7 @@ export namespace vision_v1p1beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -3947,7 +3947,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -3964,15 +3964,15 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -3981,19 +3981,19 @@ export namespace vision_v1p1beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -4006,11 +4006,11 @@ export namespace vision_v1p1beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -4019,7 +4019,7 @@ export namespace vision_v1p1beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -4053,19 +4053,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -4074,7 +4074,7 @@ export namespace vision_v1p1beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -4082,7 +4082,7 @@ export namespace vision_v1p1beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -4091,15 +4091,15 @@ export namespace vision_v1p1beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Stores enhanced image bytes. @@ -4108,15 +4108,15 @@ export namespace vision_v1p1beta1 { /** * Optimized image bytes. */ - image?: string; + image?: string | null; /** * Mime type of the output image. */ - mimeType?: string; + mimeType?: string | null; /** * Required optimization type. */ - qualityOptimizationType?: string; + qualityOptimizationType?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -4129,11 +4129,11 @@ export namespace vision_v1p1beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -4142,47 +4142,47 @@ export namespace vision_v1p1beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * A single symbol representation. @@ -4195,7 +4195,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -4203,7 +4203,7 @@ export namespace vision_v1p1beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -4216,7 +4216,7 @@ export namespace vision_v1p1beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -4225,11 +4225,11 @@ export namespace vision_v1p1beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -4238,11 +4238,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -4264,11 +4264,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -4306,15 +4306,15 @@ export namespace vision_v1p1beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -4323,11 +4323,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -4336,11 +4336,11 @@ export namespace vision_v1p1beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -4353,7 +4353,7 @@ export namespace vision_v1p1beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -4361,11 +4361,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -4378,7 +4378,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -4407,7 +4407,7 @@ export namespace vision_v1p1beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -4513,15 +4513,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -4530,7 +4530,7 @@ export namespace vision_v1p1beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -4538,7 +4538,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ @@ -4546,7 +4546,7 @@ export namespace vision_v1p1beta1 { /** * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. */ - mergedText?: string; + mergedText?: string | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -4584,11 +4584,11 @@ export namespace vision_v1p1beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -4601,11 +4601,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -4636,15 +4636,15 @@ export namespace vision_v1p1beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -4652,7 +4652,7 @@ export namespace vision_v1p1beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -4660,11 +4660,11 @@ export namespace vision_v1p1beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -4673,11 +4673,11 @@ export namespace vision_v1p1beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -4685,7 +4685,7 @@ export namespace vision_v1p1beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -4693,15 +4693,15 @@ export namespace vision_v1p1beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -4709,27 +4709,27 @@ export namespace vision_v1p1beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -4742,7 +4742,7 @@ export namespace vision_v1p1beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -4751,7 +4751,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -4760,7 +4760,7 @@ export namespace vision_v1p1beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -4769,11 +4769,11 @@ export namespace vision_v1p1beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -4804,7 +4804,7 @@ export namespace vision_v1p1beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -4812,7 +4812,7 @@ export namespace vision_v1p1beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Proto for a key value pair. @@ -4821,7 +4821,7 @@ export namespace vision_v1p1beta1 { /** * The key string value. */ - key?: string; + key?: string | null; /** * Key block of the pair containing the normalized bounding box and key text. */ @@ -4829,7 +4829,7 @@ export namespace vision_v1p1beta1 { /** * Optional. The translation of key text if the text is not in English. */ - normalizedKey?: string; + normalizedKey?: string | null; /** * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. */ @@ -4837,7 +4837,7 @@ export namespace vision_v1p1beta1 { /** * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. */ - valueType?: string; + valueType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -4850,19 +4850,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -4880,11 +4880,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -4893,15 +4893,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -4910,7 +4910,7 @@ export namespace vision_v1p1beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -4927,15 +4927,15 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected on the page. */ @@ -4943,7 +4943,7 @@ export namespace vision_v1p1beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -4956,11 +4956,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected for the paragraph. */ @@ -4977,15 +4977,15 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -4994,19 +4994,19 @@ export namespace vision_v1p1beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -5019,11 +5019,11 @@ export namespace vision_v1p1beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -5032,7 +5032,7 @@ export namespace vision_v1p1beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -5066,19 +5066,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -5087,7 +5087,7 @@ export namespace vision_v1p1beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -5095,7 +5095,7 @@ export namespace vision_v1p1beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -5104,15 +5104,15 @@ export namespace vision_v1p1beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -5125,11 +5125,11 @@ export namespace vision_v1p1beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -5138,47 +5138,47 @@ export namespace vision_v1p1beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * A single symbol representation. @@ -5191,7 +5191,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -5199,7 +5199,7 @@ export namespace vision_v1p1beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * A table representation similar to HTML table structure. @@ -5221,15 +5221,15 @@ export namespace vision_v1p1beta1 { /** * How many columns this cell spans. */ - colSpan?: number; + colSpan?: number | null; /** * How many rows this cell spans. */ - rowSpan?: number; + rowSpan?: number | null; /** * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. */ - text?: string; + text?: string | null; /** * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. */ @@ -5255,7 +5255,7 @@ export namespace vision_v1p1beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -5264,11 +5264,11 @@ export namespace vision_v1p1beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -5277,11 +5277,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -5303,11 +5303,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -5345,15 +5345,15 @@ export namespace vision_v1p1beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -5362,11 +5362,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -5375,11 +5375,11 @@ export namespace vision_v1p1beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -5392,7 +5392,7 @@ export namespace vision_v1p1beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -5400,11 +5400,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -5417,11 +5417,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected for the word. */ @@ -5455,11 +5455,11 @@ export namespace vision_v1p1beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -5490,7 +5490,7 @@ export namespace vision_v1p1beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -5498,7 +5498,7 @@ export namespace vision_v1p1beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * A product label represented as a key-value pair. @@ -5507,11 +5507,11 @@ export namespace vision_v1p1beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -5524,7 +5524,7 @@ export namespace vision_v1p1beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -5533,11 +5533,11 @@ export namespace vision_v1p1beta1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Set of detected objects with bounding boxes. @@ -5550,19 +5550,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -5580,11 +5580,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Prediction for what the object in the bounding box is. @@ -5593,19 +5593,19 @@ export namespace vision_v1p1beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -5614,7 +5614,7 @@ export namespace vision_v1p1beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -5622,15 +5622,15 @@ export namespace vision_v1p1beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -5639,15 +5639,15 @@ export namespace vision_v1p1beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -5656,7 +5656,7 @@ export namespace vision_v1p1beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -5673,11 +5673,11 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -5685,7 +5685,7 @@ export namespace vision_v1p1beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -5698,7 +5698,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -5715,15 +5715,15 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -5732,19 +5732,19 @@ export namespace vision_v1p1beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -5757,7 +5757,7 @@ export namespace vision_v1p1beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -5774,15 +5774,15 @@ export namespace vision_v1p1beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -5795,11 +5795,11 @@ export namespace vision_v1p1beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Information about a product. @@ -5808,7 +5808,7 @@ export namespace vision_v1p1beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -5816,7 +5816,7 @@ export namespace vision_v1p1beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -5825,47 +5825,47 @@ export namespace vision_v1p1beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -5874,15 +5874,15 @@ export namespace vision_v1p1beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A single symbol representation. @@ -5895,7 +5895,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -5903,7 +5903,7 @@ export namespace vision_v1p1beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -5916,7 +5916,7 @@ export namespace vision_v1p1beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Additional information detected on the structural component. @@ -5938,11 +5938,11 @@ export namespace vision_v1p1beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -5980,15 +5980,15 @@ export namespace vision_v1p1beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -5997,11 +5997,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -6010,11 +6010,11 @@ export namespace vision_v1p1beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -6027,7 +6027,7 @@ export namespace vision_v1p1beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -6035,11 +6035,11 @@ export namespace vision_v1p1beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -6052,7 +6052,7 @@ export namespace vision_v1p1beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index b00eae03f8f..9db2106f015 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -140,7 +140,7 @@ export namespace vision_v1p2beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -246,15 +246,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -263,7 +263,7 @@ export namespace vision_v1p2beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -271,7 +271,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -301,19 +301,19 @@ export namespace vision_v1p2beta1 { /** * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ - alpha?: number; + alpha?: number | null; /** * The amount of blue in the color as a value in the interval [0, 1]. */ - blue?: number; + blue?: number | null; /** * The amount of green in the color as a value in the interval [0, 1]. */ - green?: number; + green?: number | null; /** * The amount of red in the color as a value in the interval [0, 1]. */ - red?: number; + red?: number | null; } /** * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. @@ -326,11 +326,11 @@ export namespace vision_v1p2beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -343,11 +343,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -365,11 +365,11 @@ export namespace vision_v1p2beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -378,11 +378,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Set of dominant colors and their corresponding scores. @@ -404,15 +404,15 @@ export namespace vision_v1p2beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -420,7 +420,7 @@ export namespace vision_v1p2beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -428,11 +428,11 @@ export namespace vision_v1p2beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -441,11 +441,11 @@ export namespace vision_v1p2beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -453,7 +453,7 @@ export namespace vision_v1p2beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -461,15 +461,15 @@ export namespace vision_v1p2beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -477,27 +477,27 @@ export namespace vision_v1p2beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -506,7 +506,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -515,7 +515,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. @@ -536,7 +536,7 @@ export namespace vision_v1p2beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -624,7 +624,7 @@ export namespace vision_v1p2beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -632,7 +632,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -666,11 +666,11 @@ export namespace vision_v1p2beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -683,11 +683,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -718,15 +718,15 @@ export namespace vision_v1p2beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -734,7 +734,7 @@ export namespace vision_v1p2beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -742,11 +742,11 @@ export namespace vision_v1p2beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -755,11 +755,11 @@ export namespace vision_v1p2beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -767,7 +767,7 @@ export namespace vision_v1p2beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -775,15 +775,15 @@ export namespace vision_v1p2beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -791,27 +791,27 @@ export namespace vision_v1p2beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -824,7 +824,7 @@ export namespace vision_v1p2beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -833,7 +833,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -842,7 +842,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -851,11 +851,11 @@ export namespace vision_v1p2beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -873,7 +873,7 @@ export namespace vision_v1p2beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -881,7 +881,7 @@ export namespace vision_v1p2beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -894,19 +894,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -924,11 +924,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -937,15 +937,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -954,7 +954,7 @@ export namespace vision_v1p2beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -971,11 +971,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -983,7 +983,7 @@ export namespace vision_v1p2beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -996,7 +996,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -1013,15 +1013,15 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -1030,19 +1030,19 @@ export namespace vision_v1p2beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -1055,11 +1055,11 @@ export namespace vision_v1p2beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -1068,7 +1068,7 @@ export namespace vision_v1p2beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -1102,19 +1102,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -1123,7 +1123,7 @@ export namespace vision_v1p2beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -1131,7 +1131,7 @@ export namespace vision_v1p2beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -1140,15 +1140,15 @@ export namespace vision_v1p2beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -1157,23 +1157,23 @@ export namespace vision_v1p2beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -1186,7 +1186,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -1194,7 +1194,7 @@ export namespace vision_v1p2beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -1207,7 +1207,7 @@ export namespace vision_v1p2beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -1216,11 +1216,11 @@ export namespace vision_v1p2beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -1229,11 +1229,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -1255,11 +1255,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -1297,15 +1297,15 @@ export namespace vision_v1p2beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -1314,11 +1314,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -1327,11 +1327,11 @@ export namespace vision_v1p2beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -1344,7 +1344,7 @@ export namespace vision_v1p2beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -1352,11 +1352,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -1369,7 +1369,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -1398,7 +1398,7 @@ export namespace vision_v1p2beta1 { /** * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. */ - pages?: number[]; + pages?: number[] | null; } /** * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. @@ -1419,7 +1419,7 @@ export namespace vision_v1p2beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information. @@ -1536,7 +1536,7 @@ export namespace vision_v1p2beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual async file annotation requests for this batch. */ @@ -1562,7 +1562,7 @@ export namespace vision_v1p2beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual image annotation requests for this batch. */ @@ -1575,7 +1575,7 @@ export namespace vision_v1p2beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. */ @@ -1597,7 +1597,7 @@ export namespace vision_v1p2beta1 { /** * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ - parent?: string; + parent?: string | null; /** * Individual image annotation requests for this batch. */ @@ -1619,7 +1619,7 @@ export namespace vision_v1p2beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -1627,7 +1627,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -1661,11 +1661,11 @@ export namespace vision_v1p2beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -1678,11 +1678,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -1700,7 +1700,7 @@ export namespace vision_v1p2beta1 { /** * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ - aspectRatios?: number[]; + aspectRatios?: number[] | null; } /** * Set of dominant colors and their corresponding scores. @@ -1722,15 +1722,15 @@ export namespace vision_v1p2beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -1738,7 +1738,7 @@ export namespace vision_v1p2beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -1746,11 +1746,11 @@ export namespace vision_v1p2beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -1759,11 +1759,11 @@ export namespace vision_v1p2beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -1771,7 +1771,7 @@ export namespace vision_v1p2beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -1779,15 +1779,15 @@ export namespace vision_v1p2beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -1795,27 +1795,27 @@ export namespace vision_v1p2beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -1828,7 +1828,7 @@ export namespace vision_v1p2beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. @@ -1837,15 +1837,15 @@ export namespace vision_v1p2beta1 { /** * Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. */ - maxResults?: number; + maxResults?: number | null; /** * Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ - model?: string; + model?: string | null; /** * The feature type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -1854,7 +1854,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -1863,7 +1863,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * Client image to perform Google Cloud Vision API tasks over. @@ -1872,7 +1872,7 @@ export namespace vision_v1p2beta1 { /** * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ - content?: string; + content?: string | null; /** * Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request. */ @@ -1885,11 +1885,11 @@ export namespace vision_v1p2beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Image context and/or feature-specific parameters. @@ -1902,7 +1902,7 @@ export namespace vision_v1p2beta1 { /** * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). */ - languageHints?: string[]; + languageHints?: string[] | null; /** * Not used. */ @@ -1932,11 +1932,11 @@ export namespace vision_v1p2beta1 { /** * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ - gcsImageUri?: string; + gcsImageUri?: string | null; /** * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ - imageUri?: string; + imageUri?: string | null; } /** * The desired input location and metadata. @@ -1945,7 +1945,7 @@ export namespace vision_v1p2beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -1953,7 +1953,7 @@ export namespace vision_v1p2beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Rectangle determined by min and max `LatLng` pairs. @@ -1979,19 +1979,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -2009,11 +2009,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -2022,15 +2022,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -2039,7 +2039,7 @@ export namespace vision_v1p2beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -2056,11 +2056,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -2068,7 +2068,7 @@ export namespace vision_v1p2beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -2081,7 +2081,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -2098,15 +2098,15 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -2115,19 +2115,19 @@ export namespace vision_v1p2beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -2140,11 +2140,11 @@ export namespace vision_v1p2beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Parameters for a product search request. @@ -2157,15 +2157,15 @@ export namespace vision_v1p2beta1 { /** * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ - filter?: string; + filter?: string | null; /** * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ - productCategories?: string[]; + productCategories?: string[] | null; /** * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ - productSet?: string; + productSet?: string | null; } /** * Results for a product search request. @@ -2174,7 +2174,7 @@ export namespace vision_v1p2beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -2208,19 +2208,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -2229,7 +2229,7 @@ export namespace vision_v1p2beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -2237,7 +2237,7 @@ export namespace vision_v1p2beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -2246,15 +2246,15 @@ export namespace vision_v1p2beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -2263,23 +2263,23 @@ export namespace vision_v1p2beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -2292,7 +2292,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -2300,7 +2300,7 @@ export namespace vision_v1p2beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -2313,7 +2313,7 @@ export namespace vision_v1p2beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -2322,11 +2322,11 @@ export namespace vision_v1p2beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -2335,11 +2335,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -2361,11 +2361,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -2403,7 +2403,7 @@ export namespace vision_v1p2beta1 { /** * Whether to include results derived from the geo information in the image. */ - includeGeoResults?: boolean; + includeGeoResults?: boolean | null; } /** * Entity deduced from similar images on the Internet. @@ -2412,15 +2412,15 @@ export namespace vision_v1p2beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -2429,11 +2429,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -2442,11 +2442,11 @@ export namespace vision_v1p2beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -2459,7 +2459,7 @@ export namespace vision_v1p2beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -2467,11 +2467,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -2484,7 +2484,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -2513,7 +2513,7 @@ export namespace vision_v1p2beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -2601,15 +2601,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -2618,7 +2618,7 @@ export namespace vision_v1p2beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -2626,7 +2626,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -2660,11 +2660,11 @@ export namespace vision_v1p2beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -2677,11 +2677,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -2712,15 +2712,15 @@ export namespace vision_v1p2beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -2728,7 +2728,7 @@ export namespace vision_v1p2beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -2736,11 +2736,11 @@ export namespace vision_v1p2beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -2749,11 +2749,11 @@ export namespace vision_v1p2beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -2761,7 +2761,7 @@ export namespace vision_v1p2beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -2769,15 +2769,15 @@ export namespace vision_v1p2beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -2785,27 +2785,27 @@ export namespace vision_v1p2beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -2818,7 +2818,7 @@ export namespace vision_v1p2beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -2827,7 +2827,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -2836,7 +2836,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -2845,11 +2845,11 @@ export namespace vision_v1p2beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -2880,7 +2880,7 @@ export namespace vision_v1p2beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -2888,7 +2888,7 @@ export namespace vision_v1p2beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -2901,19 +2901,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -2931,11 +2931,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -2944,15 +2944,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -2961,7 +2961,7 @@ export namespace vision_v1p2beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -2978,11 +2978,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -2990,7 +2990,7 @@ export namespace vision_v1p2beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -3003,7 +3003,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -3020,15 +3020,15 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -3037,19 +3037,19 @@ export namespace vision_v1p2beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -3062,11 +3062,11 @@ export namespace vision_v1p2beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -3075,7 +3075,7 @@ export namespace vision_v1p2beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -3109,19 +3109,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -3130,7 +3130,7 @@ export namespace vision_v1p2beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -3138,7 +3138,7 @@ export namespace vision_v1p2beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -3147,15 +3147,15 @@ export namespace vision_v1p2beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -3168,11 +3168,11 @@ export namespace vision_v1p2beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -3181,23 +3181,23 @@ export namespace vision_v1p2beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; } /** * A single symbol representation. @@ -3210,7 +3210,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -3218,7 +3218,7 @@ export namespace vision_v1p2beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -3231,7 +3231,7 @@ export namespace vision_v1p2beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -3240,11 +3240,11 @@ export namespace vision_v1p2beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -3253,11 +3253,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -3279,11 +3279,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -3321,15 +3321,15 @@ export namespace vision_v1p2beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -3338,11 +3338,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -3351,11 +3351,11 @@ export namespace vision_v1p2beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -3368,7 +3368,7 @@ export namespace vision_v1p2beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -3376,11 +3376,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -3393,7 +3393,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -3422,7 +3422,7 @@ export namespace vision_v1p2beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -3536,15 +3536,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -3553,7 +3553,7 @@ export namespace vision_v1p2beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -3561,7 +3561,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -3595,11 +3595,11 @@ export namespace vision_v1p2beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -3612,11 +3612,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -3647,15 +3647,15 @@ export namespace vision_v1p2beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -3663,7 +3663,7 @@ export namespace vision_v1p2beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -3671,11 +3671,11 @@ export namespace vision_v1p2beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -3684,11 +3684,11 @@ export namespace vision_v1p2beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -3696,7 +3696,7 @@ export namespace vision_v1p2beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -3704,15 +3704,15 @@ export namespace vision_v1p2beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -3720,27 +3720,27 @@ export namespace vision_v1p2beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -3753,7 +3753,7 @@ export namespace vision_v1p2beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -3762,7 +3762,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -3771,7 +3771,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -3780,11 +3780,11 @@ export namespace vision_v1p2beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -3802,7 +3802,7 @@ export namespace vision_v1p2beta1 { /** * A score representing the aesthetic/technical quality of the image. The score is in range [0, 1]. Higher value corresponds to more professional looking photos. 0 means the image looks very bad, 1 means the image with very high quality. */ - qualityScore?: number; + qualityScore?: number | null; } /** * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. @@ -3824,7 +3824,7 @@ export namespace vision_v1p2beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -3832,7 +3832,7 @@ export namespace vision_v1p2beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -3845,19 +3845,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -3875,11 +3875,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -3888,15 +3888,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -3905,7 +3905,7 @@ export namespace vision_v1p2beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -3922,11 +3922,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -3934,7 +3934,7 @@ export namespace vision_v1p2beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -3947,7 +3947,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -3964,15 +3964,15 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -3981,19 +3981,19 @@ export namespace vision_v1p2beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -4006,11 +4006,11 @@ export namespace vision_v1p2beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -4019,7 +4019,7 @@ export namespace vision_v1p2beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -4053,19 +4053,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -4074,7 +4074,7 @@ export namespace vision_v1p2beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -4082,7 +4082,7 @@ export namespace vision_v1p2beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -4091,15 +4091,15 @@ export namespace vision_v1p2beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * Stores enhanced image bytes. @@ -4108,15 +4108,15 @@ export namespace vision_v1p2beta1 { /** * Optimized image bytes. */ - image?: string; + image?: string | null; /** * Mime type of the output image. */ - mimeType?: string; + mimeType?: string | null; /** * Required optimization type. */ - qualityOptimizationType?: string; + qualityOptimizationType?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -4129,11 +4129,11 @@ export namespace vision_v1p2beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -4142,47 +4142,47 @@ export namespace vision_v1p2beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * A single symbol representation. @@ -4195,7 +4195,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -4203,7 +4203,7 @@ export namespace vision_v1p2beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -4216,7 +4216,7 @@ export namespace vision_v1p2beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -4225,11 +4225,11 @@ export namespace vision_v1p2beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -4238,11 +4238,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -4264,11 +4264,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -4306,15 +4306,15 @@ export namespace vision_v1p2beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -4323,11 +4323,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -4336,11 +4336,11 @@ export namespace vision_v1p2beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -4353,7 +4353,7 @@ export namespace vision_v1p2beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -4361,11 +4361,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -4378,7 +4378,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ @@ -4407,7 +4407,7 @@ export namespace vision_v1p2beta1 { /** * This field gives the total number of pages in the file. */ - totalPages?: number; + totalPages?: number | null; } /** * Response to an image annotation request. @@ -4513,15 +4513,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - endTime?: string; + endTime?: string | null; /** * The current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the batch request was submitted to the server. */ - submitTime?: string; + submitTime?: string | null; } /** * Logical element on the page. @@ -4530,7 +4530,7 @@ export namespace vision_v1p2beta1 { /** * Detected block type (text, image etc) for this block. */ - blockType?: string; + blockType?: string | null; /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ @@ -4538,7 +4538,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the block. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ @@ -4546,7 +4546,7 @@ export namespace vision_v1p2beta1 { /** * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. */ - mergedText?: string; + mergedText?: string | null; /** * List of paragraphs in this block (if this blocks is of type text). */ @@ -4584,11 +4584,11 @@ export namespace vision_v1p2beta1 { /** * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - pixelFraction?: number; + pixelFraction?: number | null; /** * Image-specific score for this color. Value in range [0, 1]. */ - score?: number; + score?: number | null; } /** * Single crop hint that is used to generate a new crop when serving an image. @@ -4601,11 +4601,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of this being a salient region. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Fraction of importance of this salient region with respect to the original image. */ - importanceFraction?: number; + importanceFraction?: number | null; } /** * Set of crop hints that are used to generate new crops when serving images. @@ -4636,15 +4636,15 @@ export namespace vision_v1p2beta1 { /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Entity textual description, expressed in its `locale` language. */ - description?: string; + description?: string | null; /** * The language code for the locale in which the entity textual `description` is expressed. */ - locale?: string; + locale?: string | null; /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ @@ -4652,7 +4652,7 @@ export namespace vision_v1p2beta1 { /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ - mid?: string; + mid?: string | null; /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ @@ -4660,11 +4660,11 @@ export namespace vision_v1p2beta1 { /** * Overall score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; /** * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ - topicality?: number; + topicality?: number | null; } /** * A face annotation object contains the results of face detection. @@ -4673,11 +4673,11 @@ export namespace vision_v1p2beta1 { /** * Anger likelihood. */ - angerLikelihood?: string; + angerLikelihood?: string | null; /** * Blurred likelihood. */ - blurredLikelihood?: string; + blurredLikelihood?: string | null; /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ @@ -4685,7 +4685,7 @@ export namespace vision_v1p2beta1 { /** * Detection confidence. Range [0, 1]. */ - detectionConfidence?: number; + detectionConfidence?: number | null; /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ @@ -4693,15 +4693,15 @@ export namespace vision_v1p2beta1 { /** * Headwear likelihood. */ - headwearLikelihood?: string; + headwearLikelihood?: string | null; /** * Joy likelihood. */ - joyLikelihood?: string; + joyLikelihood?: string | null; /** * Face landmarking confidence. Range [0, 1]. */ - landmarkingConfidence?: number; + landmarkingConfidence?: number | null; /** * Detected face landmarks. */ @@ -4709,27 +4709,27 @@ export namespace vision_v1p2beta1 { /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ - panAngle?: number; + panAngle?: number | null; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ - rollAngle?: number; + rollAngle?: number | null; /** * Sorrow likelihood. */ - sorrowLikelihood?: string; + sorrowLikelihood?: string | null; /** * Surprise likelihood. */ - surpriseLikelihood?: string; + surpriseLikelihood?: string | null; /** * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ - tiltAngle?: number; + tiltAngle?: number | null; /** * Under-exposed likelihood. */ - underExposedLikelihood?: string; + underExposedLikelihood?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -4742,7 +4742,7 @@ export namespace vision_v1p2beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * The Google Cloud Storage location where the output will be written to. @@ -4751,7 +4751,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ - uri?: string; + uri?: string | null; } /** * The Google Cloud Storage location where the input will be read from. @@ -4760,7 +4760,7 @@ export namespace vision_v1p2beta1 { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ - uri?: string; + uri?: string | null; } /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. @@ -4769,11 +4769,11 @@ export namespace vision_v1p2beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -4804,7 +4804,7 @@ export namespace vision_v1p2beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -4812,7 +4812,7 @@ export namespace vision_v1p2beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * Proto for a key value pair. @@ -4821,7 +4821,7 @@ export namespace vision_v1p2beta1 { /** * The key string value. */ - key?: string; + key?: string | null; /** * Key block of the pair containing the normalized bounding box and key text. */ @@ -4829,7 +4829,7 @@ export namespace vision_v1p2beta1 { /** * Optional. The translation of key text if the text is not in English. */ - normalizedKey?: string; + normalizedKey?: string | null; /** * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. */ @@ -4837,7 +4837,7 @@ export namespace vision_v1p2beta1 { /** * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. */ - valueType?: string; + valueType?: string | null; } /** * Set of detected objects with bounding boxes. @@ -4850,19 +4850,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -4880,11 +4880,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -4893,15 +4893,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -4910,7 +4910,7 @@ export namespace vision_v1p2beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -4927,15 +4927,15 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected on the page. */ @@ -4943,7 +4943,7 @@ export namespace vision_v1p2beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -4956,11 +4956,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected for the paragraph. */ @@ -4977,15 +4977,15 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -4994,19 +4994,19 @@ export namespace vision_v1p2beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -5019,11 +5019,11 @@ export namespace vision_v1p2beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * Results for a product search request. @@ -5032,7 +5032,7 @@ export namespace vision_v1p2beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -5066,19 +5066,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Information about a product. @@ -5087,7 +5087,7 @@ export namespace vision_v1p2beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -5095,7 +5095,7 @@ export namespace vision_v1p2beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * A `Property` consists of a user-supplied name/value pair. @@ -5104,15 +5104,15 @@ export namespace vision_v1p2beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -5125,11 +5125,11 @@ export namespace vision_v1p2beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -5138,47 +5138,47 @@ export namespace vision_v1p2beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * A single symbol representation. @@ -5191,7 +5191,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -5199,7 +5199,7 @@ export namespace vision_v1p2beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * A table representation similar to HTML table structure. @@ -5221,15 +5221,15 @@ export namespace vision_v1p2beta1 { /** * How many columns this cell spans. */ - colSpan?: number; + colSpan?: number | null; /** * How many rows this cell spans. */ - rowSpan?: number; + rowSpan?: number | null; /** * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. */ - text?: string; + text?: string | null; /** * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. */ @@ -5255,7 +5255,7 @@ export namespace vision_v1p2beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Detected start or end of a structural component. @@ -5264,11 +5264,11 @@ export namespace vision_v1p2beta1 { /** * True if break prepends the element. */ - isPrefix?: boolean; + isPrefix?: boolean | null; /** * Detected break type. */ - type?: string; + type?: string | null; } /** * Detected language for a structural component. @@ -5277,11 +5277,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of detected language. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Additional information detected on the structural component. @@ -5303,11 +5303,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -5345,15 +5345,15 @@ export namespace vision_v1p2beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -5362,11 +5362,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -5375,11 +5375,11 @@ export namespace vision_v1p2beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -5392,7 +5392,7 @@ export namespace vision_v1p2beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -5400,11 +5400,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -5417,11 +5417,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. */ - mergedText?: string; + mergedText?: string | null; /** * Additional information detected for the word. */ @@ -5455,11 +5455,11 @@ export namespace vision_v1p2beta1 { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ - pageNumber?: number; + pageNumber?: number | null; /** * The URI of the file used to produce the image. */ - uri?: string; + uri?: string | null; } /** * Stores image properties, such as dominant colors. @@ -5490,7 +5490,7 @@ export namespace vision_v1p2beta1 { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ - content?: string; + content?: string | null; /** * The Google Cloud Storage location to read the input from. */ @@ -5498,7 +5498,7 @@ export namespace vision_v1p2beta1 { /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ - mimeType?: string; + mimeType?: string | null; } /** * A product label represented as a key-value pair. @@ -5507,11 +5507,11 @@ export namespace vision_v1p2beta1 { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - key?: string; + key?: string | null; /** * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ - value?: string; + value?: string | null; } /** * A face-specific landmark (for example, a face feature). @@ -5524,7 +5524,7 @@ export namespace vision_v1p2beta1 { /** * Face landmark type. */ - type?: string; + type?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -5533,11 +5533,11 @@ export namespace vision_v1p2beta1 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } /** * Set of detected objects with bounding boxes. @@ -5550,19 +5550,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * Detected entity location information. @@ -5580,11 +5580,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Prediction for what the object in the bounding box is. @@ -5593,19 +5593,19 @@ export namespace vision_v1p2beta1 { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; /** * Object ID that should align with EntityAnnotation mid. */ - mid?: string; + mid?: string | null; /** * Object name, expressed in its `language_code` language. */ - name?: string; + name?: string | null; /** * Score of the result. Range [0, 1]. */ - score?: number; + score?: number | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -5614,7 +5614,7 @@ export namespace vision_v1p2beta1 { /** * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ - done?: boolean; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -5622,15 +5622,15 @@ export namespace vision_v1p2beta1 { /** * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ - metadata?: {[key: string]: any}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -5639,15 +5639,15 @@ export namespace vision_v1p2beta1 { /** * The time when the batch request was received. */ - createTime?: string; + createTime?: string | null; /** * Current state of the batch operation. */ - state?: string; + state?: string | null; /** * The time when the operation result was last updated. */ - updateTime?: string; + updateTime?: string | null; } /** * The desired output location and metadata. @@ -5656,7 +5656,7 @@ export namespace vision_v1p2beta1 { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ - batchSize?: number; + batchSize?: number | null; /** * The Google Cloud Storage location to write the output(s) to. */ @@ -5673,11 +5673,11 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results on the page. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - height?: number; + height?: number | null; /** * Additional information detected on the page. */ @@ -5685,7 +5685,7 @@ export namespace vision_v1p2beta1 { /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ - width?: number; + width?: number | null; } /** * Structural unit of text representing a number of words in certain order. @@ -5698,7 +5698,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the paragraph. */ @@ -5715,15 +5715,15 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; /** * Z coordinate (or depth). */ - z?: number; + z?: number | null; } /** * A Product contains ReferenceImages. @@ -5732,19 +5732,19 @@ export namespace vision_v1p2beta1 { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ - description?: string; + description?: string | null; /** * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ - displayName?: string; + displayName?: string | null; /** * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ - name?: string; + name?: string | null; /** * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ - productCategory?: string; + productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ @@ -5757,7 +5757,7 @@ export namespace vision_v1p2beta1 { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ - indexTime?: string; + indexTime?: string | null; /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ @@ -5774,15 +5774,15 @@ export namespace vision_v1p2beta1 { /** * Name of the property. */ - name?: string; + name?: string | null; /** * Value of numeric properties. */ - uint64Value?: string; + uint64Value?: string | null; /** * Value of the property. */ - value?: string; + value?: string | null; } /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. @@ -5795,11 +5795,11 @@ export namespace vision_v1p2beta1 { /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ - name?: string; + name?: string | null; /** * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ - uri?: string; + uri?: string | null; } /** * Information about a product. @@ -5808,7 +5808,7 @@ export namespace vision_v1p2beta1 { /** * The resource name of the image from the product that is the closest match to the query. */ - image?: string; + image?: string | null; /** * The Product. */ @@ -5816,7 +5816,7 @@ export namespace vision_v1p2beta1 { /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ - score?: number; + score?: number | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). @@ -5825,47 +5825,47 @@ export namespace vision_v1p2beta1 { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ - adult?: string; + adult?: string | null; /** * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - adultConfidence?: number; + adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ - medical?: string; + medical?: string | null; /** * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - medicalConfidence?: number; + medicalConfidence?: number | null; /** * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - nsfwConfidence?: number; + nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ - racy?: string; + racy?: string | null; /** * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - racyConfidence?: number; + racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ - spoof?: string; + spoof?: string | null; /** * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - spoofConfidence?: number; + spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ - violence?: string; + violence?: string | null; /** * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. */ - violenceConfidence?: number; + violenceConfidence?: number | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -5874,15 +5874,15 @@ export namespace vision_v1p2beta1 { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Array<{[key: string]: any}>; + details?: Array<{[key: string]: any}> | null; /** * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ - message?: string; + message?: string | null; } /** * A single symbol representation. @@ -5895,7 +5895,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the symbol. */ @@ -5903,7 +5903,7 @@ export namespace vision_v1p2beta1 { /** * The actual UTF-8 representation of the symbol. */ - text?: string; + text?: string | null; } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. @@ -5916,7 +5916,7 @@ export namespace vision_v1p2beta1 { /** * UTF-8 text detected on the pages. */ - text?: string; + text?: string | null; } /** * Additional information detected on the structural component. @@ -5938,11 +5938,11 @@ export namespace vision_v1p2beta1 { /** * X coordinate. */ - x?: number; + x?: number | null; /** * Y coordinate. */ - y?: number; + y?: number | null; } /** * Relevant information for the image from the Internet. @@ -5980,15 +5980,15 @@ export namespace vision_v1p2beta1 { /** * Canonical description of the entity, in English. */ - description?: string; + description?: string | null; /** * Opaque entity ID. */ - entityId?: string; + entityId?: string | null; /** * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ - score?: number; + score?: number | null; } /** * Metadata for online images. @@ -5997,11 +5997,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the image. */ - score?: number; + score?: number | null; /** * The result image URL. */ - url?: string; + url?: string | null; } /** * Label to provide extra metadata for the web detection. @@ -6010,11 +6010,11 @@ export namespace vision_v1p2beta1 { /** * Label for extra metadata. */ - label?: string; + label?: string | null; /** * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ - languageCode?: string; + languageCode?: string | null; } /** * Metadata for web pages. @@ -6027,7 +6027,7 @@ export namespace vision_v1p2beta1 { /** * Title for the web page, may contain HTML markups. */ - pageTitle?: string; + pageTitle?: string | null; /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ @@ -6035,11 +6035,11 @@ export namespace vision_v1p2beta1 { /** * (Deprecated) Overall relevancy score for the web page. */ - score?: number; + score?: number | null; /** * The result web page URL. */ - url?: string; + url?: string | null; } /** * A word representation. @@ -6052,7 +6052,7 @@ export namespace vision_v1p2beta1 { /** * Confidence of the OCR results for the word. Range [0, 1]. */ - confidence?: number; + confidence?: number | null; /** * Additional information detected for the word. */ diff --git a/src/apis/webfonts/v1.ts b/src/apis/webfonts/v1.ts index ba44c660d3b..57870af52b5 100644 --- a/src/apis/webfonts/v1.ts +++ b/src/apis/webfonts/v1.ts @@ -105,35 +105,35 @@ export namespace webfonts_v1 { /** * The category of the font. */ - category?: string; + category?: string | null; /** * The name of the font. */ - family?: string; + family?: string | null; /** * The font files (with all supported scripts) for each one of the available variants, as a key : value map. */ - files?: {[key: string]: string}; + files?: {[key: string]: string} | null; /** * This kind represents a webfont object in the webfonts service. */ - kind?: string; + kind?: string | null; /** * The date (format "yyyy-MM-dd") the font was modified for the last time. */ - lastModified?: string; + lastModified?: string | null; /** * The scripts supported by the font. */ - subsets?: string[]; + subsets?: string[] | null; /** * The available variants for the font. */ - variants?: string[]; + variants?: string[] | null; /** * The font version. */ - version?: string; + version?: string | null; } export interface Schema$WebfontList { /** @@ -143,7 +143,7 @@ export namespace webfonts_v1 { /** * This kind represents a list of webfont objects in the webfonts service. */ - kind?: string; + kind?: string | null; } export class Resource$Webfonts { diff --git a/src/apis/webmasters/v3.ts b/src/apis/webmasters/v3.ts index 9eea38bbf3a..a4a880e2805 100644 --- a/src/apis/webmasters/v3.ts +++ b/src/apis/webmasters/v3.ts @@ -106,26 +106,26 @@ export namespace webmasters_v3 { } export interface Schema$ApiDataRow { - clicks?: number; - ctr?: number; - impressions?: number; - keys?: string[]; - position?: number; + clicks?: number | null; + ctr?: number | null; + impressions?: number | null; + keys?: string[] | null; + position?: number | null; } export interface Schema$ApiDimensionFilter { - dimension?: string; - expression?: string; - operator?: string; + dimension?: string | null; + expression?: string | null; + operator?: string | null; } export interface Schema$ApiDimensionFilterGroup { filters?: Schema$ApiDimensionFilter[]; - groupType?: string; + groupType?: string | null; } export interface Schema$SearchAnalyticsQueryRequest { /** * [Optional; Default is "auto"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. Note: If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid. */ - aggregationType?: string; + aggregationType?: string | null; /** * [Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains "buy"' to see only data where the query string contains the substring "buy" (not case-sensitive). You can filter by a dimension without grouping by it. */ @@ -133,27 +133,27 @@ export namespace webmasters_v3 { /** * [Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions. */ - dimensions?: string[]; + dimensions?: string[] | null; /** * [Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range. */ - endDate?: string; + endDate?: string | null; /** * [Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive). */ - rowLimit?: number; + rowLimit?: number | null; /** * [Optional; Default is "web"] The search type to filter for. */ - searchType?: string; + searchType?: string | null; /** * [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range. */ - startDate?: string; + startDate?: string | null; /** * [Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number. */ - startRow?: number; + startRow?: number | null; } /** * A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter. @@ -162,7 +162,7 @@ export namespace webmasters_v3 { /** * How the results were aggregated. */ - responseAggregationType?: string; + responseAggregationType?: string | null; /** * A list of rows grouped by the key values in the order given in the query. */ @@ -193,11 +193,11 @@ export namespace webmasters_v3 { /** * The user's permission level for the site. */ - permissionLevel?: string; + permissionLevel?: string | null; /** * The URL of the site. */ - siteUrl?: string; + siteUrl?: string | null; } /** * Contains detailed information about a specific URL submitted as a sitemap. @@ -210,35 +210,35 @@ export namespace webmasters_v3 { /** * Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly. */ - errors?: string; + errors?: string | null; /** * If true, the sitemap has not been processed. */ - isPending?: boolean; + isPending?: boolean | null; /** * If true, the sitemap is a collection of sitemaps. */ - isSitemapsIndex?: boolean; + isSitemapsIndex?: boolean | null; /** * Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd). */ - lastDownloaded?: string; + lastDownloaded?: string | null; /** * Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd). */ - lastSubmitted?: string; + lastSubmitted?: string | null; /** * The url of the sitemap. */ - path?: string; + path?: string | null; /** * The type of the sitemap. For example: rssFeed. */ - type?: string; + type?: string | null; /** * Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps. */ - warnings?: string; + warnings?: string | null; } /** * Information about the various content types in the sitemap. @@ -247,15 +247,15 @@ export namespace webmasters_v3 { /** * The number of URLs from the sitemap that were indexed (of the content type). */ - indexed?: string; + indexed?: string | null; /** * The number of URLs in the sitemap (of the content type). */ - submitted?: string; + submitted?: string | null; /** * The specific type of content in this sitemap. For example: web. */ - type?: string; + type?: string | null; } export class Resource$Searchanalytics { diff --git a/src/apis/websecurityscanner/v1.ts b/src/apis/websecurityscanner/v1.ts index 29907843e79..dc04a717a8c 100644 --- a/src/apis/websecurityscanner/v1.ts +++ b/src/apis/websecurityscanner/v1.ts @@ -137,15 +137,15 @@ export namespace websecurityscanner_v1 { /** * Output only. The body of the request that was used to visit the URL. */ - body?: string; + body?: string | null; /** * Output only. The http method of the request that was used to visit the URL, in uppercase. */ - httpMethod?: string; + httpMethod?: string | null; /** * Output only. The URL that was crawled. */ - url?: string; + url?: string | null; } /** * Describes authentication configuration that uses a custom account. @@ -154,15 +154,15 @@ export namespace websecurityscanner_v1 { /** * Required. The login form URL of the website. */ - loginUrl?: string; + loginUrl?: string | null; /** * Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ - password?: string; + password?: string | null; /** * Required. The user name of the custom account. */ - username?: string; + username?: 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 `{}`. @@ -175,19 +175,19 @@ export namespace websecurityscanner_v1 { /** * Output only. The body of the request that triggered the vulnerability. */ - body?: string; + body?: string | null; /** * Output only. The description of the vulnerability. */ - description?: string; + description?: string | null; /** * Output only. The URL where the browser lands when the vulnerability is detected. */ - finalUrl?: string; + finalUrl?: string | null; /** * Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-scanner/docs/scan-result-details */ - findingType?: string; + findingType?: string | null; /** * Output only. An addon containing information reported for a vulnerability with an HTML form, if any. */ @@ -195,19 +195,19 @@ export namespace websecurityscanner_v1 { /** * Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */ - frameUrl?: string; + frameUrl?: string | null; /** * Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */ - fuzzedUrl?: string; + fuzzedUrl?: string | null; /** * Output only. The http method of the request that triggered the vulnerability, in uppercase. */ - httpMethod?: string; + httpMethod?: string | null; /** * Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */ - name?: string; + name?: string | null; /** * Output only. An addon containing information about outdated libraries. */ @@ -215,11 +215,11 @@ export namespace websecurityscanner_v1 { /** * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ - reproductionUrl?: string; + reproductionUrl?: string | null; /** * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ - trackingId?: string; + trackingId?: string | null; /** * Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ @@ -244,11 +244,11 @@ export namespace websecurityscanner_v1 { /** * Output only. The count of findings belonging to this finding type. */ - findingCount?: number; + findingCount?: number | null; /** * Output only. The finding type associated with the stats. */ - findingType?: string; + findingType?: string | null; } /** * ! Information about a vulnerability with an HTML. @@ -257,11 +257,11 @@ export namespace websecurityscanner_v1 { /** * ! The URI where to send the form when it's submitted. */ - actionUri?: string; + actionUri?: string | null; /** * ! The names of form fields related to the vulnerability. */ - fields?: string[]; + fields?: string[] | null; } /** * Describes authentication configuration that uses a Google account. @@ -270,11 +270,11 @@ export namespace websecurityscanner_v1 { /** * Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ - password?: string; + password?: string | null; /** * Required. The user name of the Google account. */ - username?: string; + username?: string | null; } /** * Describes a HTTP Header. @@ -283,11 +283,11 @@ export namespace websecurityscanner_v1 { /** * Header name. */ - name?: string; + name?: string | null; /** * Header value. */ - value?: string; + value?: string | null; } /** * Response for the `ListCrawledUrls` method. @@ -300,7 +300,7 @@ export namespace websecurityscanner_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for the `ListFindings` method. @@ -313,7 +313,7 @@ export namespace websecurityscanner_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for the `ListFindingTypeStats` method. @@ -331,7 +331,7 @@ export namespace websecurityscanner_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of ScanConfigs returned. */ @@ -344,7 +344,7 @@ export namespace websecurityscanner_v1 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of ScanRuns returned. */ @@ -357,15 +357,15 @@ export namespace websecurityscanner_v1 { /** * URLs to learn more information about the vulnerabilities in the library. */ - learnMoreUrls?: string[]; + learnMoreUrls?: string[] | null; /** * The name of the outdated library. */ - libraryName?: string; + libraryName?: string | null; /** * The version number. */ - version?: string; + version?: string | null; } /** * A ScanConfig resource contains the configurations to launch a scan. @@ -378,27 +378,27 @@ export namespace websecurityscanner_v1 { /** * The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls */ - blacklistPatterns?: string[]; + blacklistPatterns?: string[] | null; /** * Required. The user provided display name of the ScanConfig. */ - displayName?: string; + displayName?: string | null; /** * Controls export of scan configurations and results to Cloud Security Command Center. */ - exportToSecurityCommandCenter?: string; + exportToSecurityCommandCenter?: string | 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. */ - maxQps?: number; + maxQps?: number | null; /** * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ - name?: string; + name?: string | null; /** * The risk level selected for the scan */ - riskLevel?: string; + riskLevel?: string | null; /** * The schedule of the ScanConfig. */ @@ -406,11 +406,11 @@ export namespace websecurityscanner_v1 { /** * Required. The starting URLs from which the scanner finds site pages. */ - startingUrls?: string[]; + startingUrls?: string[] | null; /** * The user agent used during scanning. */ - userAgent?: string; + userAgent?: string | null; } /** * Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. @@ -419,11 +419,11 @@ export namespace websecurityscanner_v1 { /** * Output only. Indicates the reason code for a configuration failure. */ - code?: string; + code?: string | null; /** * Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. */ - fieldName?: string; + fieldName?: string | null; } /** * A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 @@ -432,7 +432,7 @@ export namespace websecurityscanner_v1 { /** * Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */ - endTime?: string; + endTime?: string | null; /** * Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. */ @@ -440,35 +440,35 @@ export namespace websecurityscanner_v1 { /** * Output only. The execution state of the ScanRun. */ - executionState?: string; + executionState?: string | null; /** * Output only. Whether the scan run has found any vulnerabilities. */ - hasVulnerabilities?: boolean; + hasVulnerabilities?: boolean | null; /** * Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */ - name?: string; + name?: string | null; /** * Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */ - progressPercent?: number; + progressPercent?: number | null; /** * Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */ - resultState?: string; + resultState?: string | null; /** * Output only. The time at which the ScanRun started. */ - startTime?: string; + startTime?: string | null; /** * Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */ - urlsCrawledCount?: string; + urlsCrawledCount?: string | null; /** * Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */ - urlsTestedCount?: string; + urlsTestedCount?: string | null; /** * Output only. A list of warnings, if such are encountered during this scan run. */ @@ -481,11 +481,11 @@ export namespace websecurityscanner_v1 { /** * Output only. Indicates the error reason code. */ - code?: string; + code?: string | null; /** * Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. */ - mostCommonHttpErrorCode?: number; + mostCommonHttpErrorCode?: number | null; /** * Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. */ @@ -498,7 +498,7 @@ export namespace websecurityscanner_v1 { /** * Output only. Indicates the warning code. */ - code?: string; + code?: string | null; } /** * Scan schedule configuration. @@ -507,11 +507,11 @@ export namespace websecurityscanner_v1 { /** * Required. The duration of time between executions in days. */ - intervalDurationDays?: number; + intervalDurationDays?: number | null; /** * A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Request for the `StartScanRun` method. @@ -528,11 +528,11 @@ export namespace websecurityscanner_v1 { /** * The MIME type of this resource. */ - contentType?: string; + contentType?: string | null; /** * URL of this violating resource. */ - resourceUrl?: string; + resourceUrl?: string | null; } /** * Information about vulnerable or missing HTTP Headers. @@ -554,7 +554,7 @@ export namespace websecurityscanner_v1 { /** * The vulnerable parameter names. */ - parameterNames?: string[]; + parameterNames?: string[] | null; } /** * Information reported for an XSS. @@ -563,19 +563,19 @@ export namespace websecurityscanner_v1 { /** * The attack vector of the payload triggering this XSS. */ - attackVector?: string; + attackVector?: string | null; /** * An error message generated by a javascript breakage. */ - errorMessage?: string; + errorMessage?: string | null; /** * Stack traces leading to the point where the XSS occurred. */ - stackTraces?: string[]; + stackTraces?: string[] | null; /** * The reproduction url for the seeding POST request of a Stored XSS. */ - storedXssSeedingUrl?: string; + storedXssSeedingUrl?: string | null; } export class Resource$Projects { diff --git a/src/apis/websecurityscanner/v1alpha.ts b/src/apis/websecurityscanner/v1alpha.ts index d0a35ddb315..a85f3c48061 100644 --- a/src/apis/websecurityscanner/v1alpha.ts +++ b/src/apis/websecurityscanner/v1alpha.ts @@ -137,15 +137,15 @@ export namespace websecurityscanner_v1alpha { /** * Output only. The body of the request that was used to visit the URL. */ - body?: string; + body?: string | null; /** * Output only. The http method of the request that was used to visit the URL, in uppercase. */ - httpMethod?: string; + httpMethod?: string | null; /** * Output only. The URL that was crawled. */ - url?: string; + url?: string | null; } /** * Describes authentication configuration that uses a custom account. @@ -154,15 +154,15 @@ export namespace websecurityscanner_v1alpha { /** * Required. The login form URL of the website. */ - loginUrl?: string; + loginUrl?: string | null; /** * Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ - password?: string; + password?: string | null; /** * Required. The user name of the custom account. */ - username?: string; + username?: 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 `{}`. @@ -175,35 +175,35 @@ export namespace websecurityscanner_v1alpha { /** * Output only. The body of the request that triggered the vulnerability. */ - body?: string; + body?: string | null; /** * Output only. The description of the vulnerability. */ - description?: string; + description?: string | null; /** * Output only. The URL where the browser lands when the vulnerability is detected. */ - finalUrl?: string; + finalUrl?: string | null; /** * Output only. The type of the Finding. */ - findingType?: string; + findingType?: string | null; /** * Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */ - frameUrl?: string; + frameUrl?: string | null; /** * Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */ - fuzzedUrl?: string; + fuzzedUrl?: string | null; /** * Output only. The http method of the request that triggered the vulnerability, in uppercase. */ - httpMethod?: string; + httpMethod?: string | null; /** * Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */ - name?: string; + name?: string | null; /** * Output only. An addon containing information about outdated libraries. */ @@ -211,11 +211,11 @@ export namespace websecurityscanner_v1alpha { /** * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ - reproductionUrl?: string; + reproductionUrl?: string | null; /** * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ - trackingId?: string; + trackingId?: string | null; /** * Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ @@ -240,11 +240,11 @@ export namespace websecurityscanner_v1alpha { /** * Output only. The count of findings belonging to this finding type. */ - findingCount?: number; + findingCount?: number | null; /** * Output only. The finding type associated with the stats. */ - findingType?: string; + findingType?: string | null; } /** * Describes authentication configuration that uses a Google account. @@ -253,11 +253,11 @@ export namespace websecurityscanner_v1alpha { /** * Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ - password?: string; + password?: string | null; /** * Required. The user name of the Google account. */ - username?: string; + username?: string | null; } /** * Describes a HTTP Header. @@ -266,11 +266,11 @@ export namespace websecurityscanner_v1alpha { /** * Header name. */ - name?: string; + name?: string | null; /** * Header value. */ - value?: string; + value?: string | null; } /** * Response for the `ListCrawledUrls` method. @@ -283,7 +283,7 @@ export namespace websecurityscanner_v1alpha { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for the `ListFindings` method. @@ -296,7 +296,7 @@ export namespace websecurityscanner_v1alpha { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for the `ListFindingTypeStats` method. @@ -314,7 +314,7 @@ export namespace websecurityscanner_v1alpha { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of ScanConfigs returned. */ @@ -327,7 +327,7 @@ export namespace websecurityscanner_v1alpha { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of ScanRuns returned. */ @@ -340,15 +340,15 @@ export namespace websecurityscanner_v1alpha { /** * URLs to learn more information about the vulnerabilities in the library. */ - learnMoreUrls?: string[]; + learnMoreUrls?: string[] | null; /** * The name of the outdated library. */ - libraryName?: string; + libraryName?: string | null; /** * The version number. */ - version?: string; + version?: string | null; } /** * A ScanConfig resource contains the configurations to launch a scan. next id: 12 @@ -361,11 +361,11 @@ export namespace websecurityscanner_v1alpha { /** * The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls */ - blacklistPatterns?: string[]; + blacklistPatterns?: string[] | null; /** * Required. The user provided display name of the ScanConfig. */ - displayName?: string; + displayName?: string | null; /** * Latest ScanRun if available. */ @@ -373,11 +373,11 @@ export namespace websecurityscanner_v1alpha { /** * 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. */ - maxQps?: number; + maxQps?: number | null; /** * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ - name?: string; + name?: string | null; /** * The schedule of the ScanConfig. */ @@ -385,15 +385,15 @@ export namespace websecurityscanner_v1alpha { /** * Required. The starting URLs from which the scanner finds site pages. */ - startingUrls?: string[]; + startingUrls?: string[] | null; /** * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */ - targetPlatforms?: string[]; + targetPlatforms?: string[] | null; /** * The user agent used during scanning. */ - userAgent?: string; + userAgent?: string | null; } /** * A ScanRun is a output-only resource representing an actual run of the scan. @@ -402,39 +402,39 @@ export namespace websecurityscanner_v1alpha { /** * Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */ - endTime?: string; + endTime?: string | null; /** * Output only. The execution state of the ScanRun. */ - executionState?: string; + executionState?: string | null; /** * Output only. Whether the scan run has found any vulnerabilities. */ - hasVulnerabilities?: boolean; + hasVulnerabilities?: boolean | null; /** * Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */ - name?: string; + name?: string | null; /** * Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */ - progressPercent?: number; + progressPercent?: number | null; /** * Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */ - resultState?: string; + resultState?: string | null; /** * Output only. The time at which the ScanRun started. */ - startTime?: string; + startTime?: string | null; /** * Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */ - urlsCrawledCount?: string; + urlsCrawledCount?: string | null; /** * Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */ - urlsTestedCount?: string; + urlsTestedCount?: string | null; } /** * Scan schedule configuration. @@ -443,11 +443,11 @@ export namespace websecurityscanner_v1alpha { /** * Required. The duration of time between executions in days. */ - intervalDurationDays?: number; + intervalDurationDays?: number | null; /** * A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Request for the `StartScanRun` method. @@ -464,11 +464,11 @@ export namespace websecurityscanner_v1alpha { /** * The MIME type of this resource. */ - contentType?: string; + contentType?: string | null; /** * URL of this violating resource. */ - resourceUrl?: string; + resourceUrl?: string | null; } /** * Information about vulnerable or missing HTTP Headers. @@ -490,7 +490,7 @@ export namespace websecurityscanner_v1alpha { /** * The vulnerable parameter names. */ - parameterNames?: string[]; + parameterNames?: string[] | null; } /** * Information reported for an XSS. @@ -499,11 +499,11 @@ export namespace websecurityscanner_v1alpha { /** * An error message generated by a javascript breakage. */ - errorMessage?: string; + errorMessage?: string | null; /** * Stack traces leading to the point where the XSS occurred. */ - stackTraces?: string[]; + stackTraces?: string[] | null; } export class Resource$Projects { diff --git a/src/apis/websecurityscanner/v1beta.ts b/src/apis/websecurityscanner/v1beta.ts index 03cc5197878..0d56285055f 100644 --- a/src/apis/websecurityscanner/v1beta.ts +++ b/src/apis/websecurityscanner/v1beta.ts @@ -137,15 +137,15 @@ export namespace websecurityscanner_v1beta { /** * Output only. The body of the request that was used to visit the URL. */ - body?: string; + body?: string | null; /** * Output only. The http method of the request that was used to visit the URL, in uppercase. */ - httpMethod?: string; + httpMethod?: string | null; /** * Output only. The URL that was crawled. */ - url?: string; + url?: string | null; } /** * Describes authentication configuration that uses a custom account. @@ -154,15 +154,15 @@ export namespace websecurityscanner_v1beta { /** * Required. The login form URL of the website. */ - loginUrl?: string; + loginUrl?: string | null; /** * Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ - password?: string; + password?: string | null; /** * Required. The user name of the custom account. */ - username?: string; + username?: 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 `{}`. @@ -175,19 +175,19 @@ export namespace websecurityscanner_v1beta { /** * Output only. The body of the request that triggered the vulnerability. */ - body?: string; + body?: string | null; /** * Output only. The description of the vulnerability. */ - description?: string; + description?: string | null; /** * Output only. The URL where the browser lands when the vulnerability is detected. */ - finalUrl?: string; + finalUrl?: string | null; /** * Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-scanner/docs/scan-result-details */ - findingType?: string; + findingType?: string | null; /** * Output only. An addon containing information reported for a vulnerability with an HTML form, if any. */ @@ -195,19 +195,19 @@ export namespace websecurityscanner_v1beta { /** * Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */ - frameUrl?: string; + frameUrl?: string | null; /** * Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */ - fuzzedUrl?: string; + fuzzedUrl?: string | null; /** * Output only. The http method of the request that triggered the vulnerability, in uppercase. */ - httpMethod?: string; + httpMethod?: string | null; /** * Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */ - name?: string; + name?: string | null; /** * Output only. An addon containing information about outdated libraries. */ @@ -215,11 +215,11 @@ export namespace websecurityscanner_v1beta { /** * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ - reproductionUrl?: string; + reproductionUrl?: string | null; /** * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ - trackingId?: string; + trackingId?: string | null; /** * Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ @@ -244,11 +244,11 @@ export namespace websecurityscanner_v1beta { /** * Output only. The count of findings belonging to this finding type. */ - findingCount?: number; + findingCount?: number | null; /** * Output only. The finding type associated with the stats. */ - findingType?: string; + findingType?: string | null; } /** * ! Information about a vulnerability with an HTML. @@ -257,11 +257,11 @@ export namespace websecurityscanner_v1beta { /** * ! The URI where to send the form when it's submitted. */ - actionUri?: string; + actionUri?: string | null; /** * ! The names of form fields related to the vulnerability. */ - fields?: string[]; + fields?: string[] | null; } /** * Describes authentication configuration that uses a Google account. @@ -270,11 +270,11 @@ export namespace websecurityscanner_v1beta { /** * Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ - password?: string; + password?: string | null; /** * Required. The user name of the Google account. */ - username?: string; + username?: string | null; } /** * Describes a HTTP Header. @@ -283,11 +283,11 @@ export namespace websecurityscanner_v1beta { /** * Header name. */ - name?: string; + name?: string | null; /** * Header value. */ - value?: string; + value?: string | null; } /** * Response for the `ListCrawledUrls` method. @@ -300,7 +300,7 @@ export namespace websecurityscanner_v1beta { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for the `ListFindings` method. @@ -313,7 +313,7 @@ export namespace websecurityscanner_v1beta { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response for the `ListFindingTypeStats` method. @@ -331,7 +331,7 @@ export namespace websecurityscanner_v1beta { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of ScanConfigs returned. */ @@ -344,7 +344,7 @@ export namespace websecurityscanner_v1beta { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of ScanRuns returned. */ @@ -357,15 +357,15 @@ export namespace websecurityscanner_v1beta { /** * URLs to learn more information about the vulnerabilities in the library. */ - learnMoreUrls?: string[]; + learnMoreUrls?: string[] | null; /** * The name of the outdated library. */ - libraryName?: string; + libraryName?: string | null; /** * The version number. */ - version?: string; + version?: string | null; } /** * A ScanConfig resource contains the configurations to launch a scan. @@ -378,15 +378,15 @@ export namespace websecurityscanner_v1beta { /** * The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls */ - blacklistPatterns?: string[]; + blacklistPatterns?: string[] | null; /** * Required. The user provided display name of the ScanConfig. */ - displayName?: string; + displayName?: string | null; /** * Controls export of scan configurations and results to Cloud Security Command Center. */ - exportToSecurityCommandCenter?: string; + exportToSecurityCommandCenter?: string | null; /** * Latest ScanRun if available. */ @@ -394,15 +394,15 @@ export namespace websecurityscanner_v1beta { /** * 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. */ - maxQps?: number; + maxQps?: number | null; /** * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ - name?: string; + name?: string | null; /** * The risk level selected for the scan */ - riskLevel?: string; + riskLevel?: string | null; /** * The schedule of the ScanConfig. */ @@ -410,15 +410,15 @@ export namespace websecurityscanner_v1beta { /** * Required. The starting URLs from which the scanner finds site pages. */ - startingUrls?: string[]; + startingUrls?: string[] | null; /** * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */ - targetPlatforms?: string[]; + targetPlatforms?: string[] | null; /** * The user agent used during scanning. */ - userAgent?: string; + userAgent?: string | null; } /** * Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. @@ -427,11 +427,11 @@ export namespace websecurityscanner_v1beta { /** * Output only. Indicates the reason code for a configuration failure. */ - code?: string; + code?: string | null; /** * Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. */ - fieldName?: string; + fieldName?: string | null; } /** * A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 @@ -440,7 +440,7 @@ export namespace websecurityscanner_v1beta { /** * Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */ - endTime?: string; + endTime?: string | null; /** * Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. */ @@ -448,35 +448,35 @@ export namespace websecurityscanner_v1beta { /** * Output only. The execution state of the ScanRun. */ - executionState?: string; + executionState?: string | null; /** * Output only. Whether the scan run has found any vulnerabilities. */ - hasVulnerabilities?: boolean; + hasVulnerabilities?: boolean | null; /** * Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */ - name?: string; + name?: string | null; /** * Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */ - progressPercent?: number; + progressPercent?: number | null; /** * Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */ - resultState?: string; + resultState?: string | null; /** * Output only. The time at which the ScanRun started. */ - startTime?: string; + startTime?: string | null; /** * Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */ - urlsCrawledCount?: string; + urlsCrawledCount?: string | null; /** * Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */ - urlsTestedCount?: string; + urlsTestedCount?: string | null; /** * Output only. A list of warnings, if such are encountered during this scan run. */ @@ -489,11 +489,11 @@ export namespace websecurityscanner_v1beta { /** * Output only. Indicates the error reason code. */ - code?: string; + code?: string | null; /** * Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. */ - mostCommonHttpErrorCode?: number; + mostCommonHttpErrorCode?: number | null; /** * Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. */ @@ -506,7 +506,7 @@ export namespace websecurityscanner_v1beta { /** * Output only. Indicates the warning code. */ - code?: string; + code?: string | null; } /** * Scan schedule configuration. @@ -515,11 +515,11 @@ export namespace websecurityscanner_v1beta { /** * Required. The duration of time between executions in days. */ - intervalDurationDays?: number; + intervalDurationDays?: number | null; /** * A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. */ - scheduleTime?: string; + scheduleTime?: string | null; } /** * Request for the `StartScanRun` method. @@ -536,11 +536,11 @@ export namespace websecurityscanner_v1beta { /** * The MIME type of this resource. */ - contentType?: string; + contentType?: string | null; /** * URL of this violating resource. */ - resourceUrl?: string; + resourceUrl?: string | null; } /** * Information about vulnerable or missing HTTP Headers. @@ -562,7 +562,7 @@ export namespace websecurityscanner_v1beta { /** * The vulnerable parameter names. */ - parameterNames?: string[]; + parameterNames?: string[] | null; } /** * Information reported for an XSS. @@ -571,11 +571,11 @@ export namespace websecurityscanner_v1beta { /** * An error message generated by a javascript breakage. */ - errorMessage?: string; + errorMessage?: string | null; /** * Stack traces leading to the point where the XSS occurred. */ - stackTraces?: string[]; + stackTraces?: string[] | null; } export class Resource$Projects { diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 722dd264bb6..dcb3cfa1f20 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -164,11 +164,11 @@ export namespace youtube_v3 { /** * The value of allowed indicates whether the access to the policy is allowed or denied by default. */ - allowed?: boolean; + allowed?: boolean | null; /** * A list of region codes that identify countries where the default policy do not apply. */ - exception?: string[]; + exception?: string[] | null; } /** * An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded. @@ -181,15 +181,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the activity. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#activity". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the activity, including the activity's type and group ID. */ @@ -296,11 +296,11 @@ export namespace youtube_v3 { /** * The value that YouTube uses to uniquely identify the playlist. */ - playlistId?: string; + playlistId?: string | null; /** * ID of the item within the playlist. */ - playlistItemId?: string; + playlistItemId?: string | null; /** * The resourceId object contains information about the resource that was added to the playlist. */ @@ -313,43 +313,43 @@ export namespace youtube_v3 { /** * The URL the client should fetch to request a promoted item. */ - adTag?: string; + adTag?: string | null; /** * The URL the client should ping to indicate that the user clicked through on this promoted item. */ - clickTrackingUrl?: string; + clickTrackingUrl?: string | null; /** * The URL the client should ping to indicate that the user was shown this promoted item. */ - creativeViewUrl?: string; + creativeViewUrl?: string | null; /** * The type of call-to-action, a message to the user indicating action that can be taken. */ - ctaType?: string; + ctaType?: string | null; /** * The custom call-to-action button text. If specified, it will override the default button text for the cta_type. */ - customCtaButtonText?: string; + customCtaButtonText?: string | null; /** * The text description to accompany the promoted item. */ - descriptionText?: string; + descriptionText?: string | null; /** * The URL the client should direct the user to, if the user chooses to visit the advertiser's website. */ - destinationUrl?: string; + destinationUrl?: string | null; /** * The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown. */ - forecastingUrl?: string[]; + forecastingUrl?: string[] | null; /** * The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item. */ - impressionUrl?: string[]; + impressionUrl?: string[] | null; /** * The ID that YouTube uses to uniquely identify the promoted video. */ - videoId?: string; + videoId?: string | null; } /** * Information that identifies the recommended resource. @@ -358,7 +358,7 @@ export namespace youtube_v3 { /** * The reason that the resource is recommended to the user. */ - reason?: string; + reason?: string | null; /** * The resourceId object contains information that identifies the recommended resource. */ @@ -375,15 +375,15 @@ export namespace youtube_v3 { /** * The author of the social network post. */ - author?: string; + author?: string | null; /** * An image of the post's author. */ - imageUrl?: string; + imageUrl?: string | null; /** * The URL of the social network post. */ - referenceUrl?: string; + referenceUrl?: string | null; /** * The resourceId object encapsulates information that identifies the resource associated with a social network post. */ @@ -391,7 +391,7 @@ export namespace youtube_v3 { /** * The name of the social network. */ - type?: string; + type?: string | null; } /** * Information about a channel that a user subscribed to. @@ -409,17 +409,17 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the uploaded video. */ - videoId?: string; + videoId?: string | null; } export interface Schema$ActivityListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of activities, or events, that match the request criteria. */ @@ -427,21 +427,21 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#activityListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about an activity, including title, description, thumbnails, activity type and group. @@ -450,23 +450,23 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the channel associated with the activity. */ - channelId?: string; + channelId?: string | null; /** * Channel title for the channel responsible for this activity */ - channelTitle?: string; + channelTitle?: string | null; /** * The description of the resource primarily associated with the activity. */ - description?: string; + description?: string | null; /** * The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value. */ - groupId?: string; + groupId?: string | null; /** * The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ @@ -474,11 +474,11 @@ export namespace youtube_v3 { /** * The title of the resource primarily associated with the activity. */ - title?: string; + title?: string | null; /** * The type of activity that the resource describes. */ - type?: string; + type?: string | null; } /** * A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video. @@ -487,15 +487,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the caption track. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#caption". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the caption. */ @@ -505,11 +505,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of captions that match the request criteria. */ @@ -517,11 +517,11 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about a caption track, such as its language and name. @@ -530,55 +530,55 @@ export namespace youtube_v3 { /** * The type of audio track associated with the caption track. */ - audioTrackType?: string; + audioTrackType?: string | null; /** * The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed. */ - failureReason?: string; + failureReason?: string | null; /** * Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions. */ - isAutoSynced?: boolean; + isAutoSynced?: boolean | null; /** * Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false. */ - isCC?: boolean; + isCC?: boolean | null; /** * Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. */ - isDraft?: boolean; + isDraft?: boolean | null; /** * Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false. */ - isEasyReader?: boolean; + isEasyReader?: boolean | null; /** * Indicates whether the caption track uses large text for the vision-impaired. The default value is false. */ - isLarge?: boolean; + isLarge?: boolean | null; /** * The language of the caption track. The property value is a BCP-47 language tag. */ - language?: string; + language?: string | null; /** * The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - lastUpdated?: string; + lastUpdated?: string | null; /** * The name of the caption track. The name is intended to be visible to the user as an option during playback. */ - name?: string; + name?: string | null; /** * The caption track's status. */ - status?: string; + status?: string | null; /** * The caption track's type. */ - trackKind?: string; + trackKind?: string | null; /** * The ID that YouTube uses to uniquely identify the video associated with the caption track. */ - videoId?: string; + videoId?: string | null; } /** * Brief description of the live stream cdn settings. @@ -587,11 +587,11 @@ export namespace youtube_v3 { /** * The format of the video stream that you are sending to Youtube. */ - format?: string; + format?: string | null; /** * The frame rate of the inbound video data. */ - frameRate?: string; + frameRate?: string | null; /** * The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube. */ @@ -599,11 +599,11 @@ export namespace youtube_v3 { /** * The method or protocol used to transmit the video stream. */ - ingestionType?: string; + ingestionType?: string | null; /** * The resolution of the inbound video data. */ - resolution?: string; + resolution?: string | null; } /** * A channel resource contains information about a YouTube channel. @@ -632,11 +632,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the channel. */ - id?: string; + id?: string | null; /** * The invideoPromotion object encapsulates information about promotion campaign associated with the channel. */ @@ -644,11 +644,11 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channel". */ - kind?: string; + kind?: string | null; /** * Localizations for different languages */ - localizations?: {[key: string]: Schema$ChannelLocalization}; + localizations?: {[key: string]: Schema$ChannelLocalization} | null; /** * The snippet object contains basic details about the channel, such as its title, description, and thumbnail images. */ @@ -673,15 +673,15 @@ export namespace youtube_v3 { /** * Whether or not the channel respects the community guidelines. */ - communityGuidelinesGoodStanding?: boolean; + communityGuidelinesGoodStanding?: boolean | null; /** * Whether or not the channel has any unresolved claims. */ - contentIdClaimsGoodStanding?: boolean; + contentIdClaimsGoodStanding?: boolean | null; /** * Whether or not the channel has any copyright strikes. */ - copyrightStrikesGoodStanding?: boolean; + copyrightStrikesGoodStanding?: boolean | null; } /** * A channel banner returned as the response to a channel_banner.insert call. @@ -690,15 +690,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource". */ - kind?: string; + kind?: string | null; /** * The URL of this banner image. */ - url?: string; + url?: string | null; } /** * Branding properties of a YouTube channel. @@ -731,7 +731,7 @@ export namespace youtube_v3 { uploads?: string; watchHistory?: string; watchLater?: string; - }; + } | null; } /** * The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. @@ -740,11 +740,11 @@ export namespace youtube_v3 { /** * The ID of the content owner linked to the channel. */ - contentOwner?: string; + contentOwner?: string | null; /** * The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - timeLinked?: string; + timeLinked?: string | null; } /** * Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. @@ -753,11 +753,11 @@ export namespace youtube_v3 { /** * Defines the context of the ping. */ - context?: string; + context?: string | null; /** * The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. */ - conversionUrl?: string; + conversionUrl?: string | null; } /** * The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. @@ -772,11 +772,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of channels that match the request criteria. */ @@ -784,21 +784,21 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Channel localization setting @@ -807,29 +807,29 @@ export namespace youtube_v3 { /** * The localized strings for channel's description. */ - description?: string; + description?: string | null; /** * The localized strings for channel's title. */ - title?: string; + title?: string | null; } export interface Schema$ChannelProfileDetails { /** * The YouTube channel ID. */ - channelId?: string; + channelId?: string | null; /** * The channel's URL. */ - channelUrl?: string; + channelUrl?: string | null; /** * The channel's display name. */ - displayName?: string; + displayName?: string | null; /** * The channels's avatar URL. */ - profileImageUrl?: string; + profileImageUrl?: string | null; } export interface Schema$ChannelSection { /** @@ -839,19 +839,19 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the channel section. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". */ - kind?: string; + kind?: string | null; /** * Localizations for different languages */ - localizations?: {[key: string]: Schema$ChannelSectionLocalization}; + localizations?: {[key: string]: Schema$ChannelSectionLocalization} | null; /** * The snippet object contains basic details about the channel section, such as its type, style and title. */ @@ -868,21 +868,21 @@ export namespace youtube_v3 { /** * The channel ids for type multiple_channels. */ - channels?: string[]; + channels?: string[] | null; /** * The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. */ - playlists?: string[]; + playlists?: string[] | null; } export interface Schema$ChannelSectionListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of ChannelSections that match the request criteria. */ @@ -890,11 +890,11 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * ChannelSection localization setting @@ -903,7 +903,7 @@ export namespace youtube_v3 { /** * The localized strings for channel section's title. */ - title?: string; + title?: string | null; } /** * Basic details about a channel section, including title, style and position. @@ -912,11 +912,11 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the channel that published the channel section. */ - channelId?: string; + channelId?: string | null; /** * The language of the channel section's default title and description. */ - defaultLanguage?: string; + defaultLanguage?: string | null; /** * Localized title, read-only. */ @@ -924,19 +924,19 @@ export namespace youtube_v3 { /** * The position of the channel section in the channel. */ - position?: number; + position?: number | null; /** * The style of the channel section. */ - style?: string; + style?: string | null; /** * The channel section's title for multiple_playlists and multiple_channels. */ - title?: string; + title?: string | null; /** * The type of the channel section. */ - type?: string; + type?: string | null; } /** * ChannelSection targeting setting. @@ -945,15 +945,15 @@ export namespace youtube_v3 { /** * The country the channel section is targeting. */ - countries?: string[]; + countries?: string[] | null; /** * The language the channel section is targeting. */ - languages?: string[]; + languages?: string[] | null; /** * The region the channel section is targeting. */ - regions?: string[]; + regions?: string[] | null; } /** * Branding properties for the channel view. @@ -962,56 +962,56 @@ export namespace youtube_v3 { /** * The country of the channel. */ - country?: string; - defaultLanguage?: string; + country?: string | null; + defaultLanguage?: string | null; /** * Which content tab users should see when viewing the channel. */ - defaultTab?: string; + defaultTab?: string | null; /** * Specifies the channel description. */ - description?: string; + description?: string | null; /** * Title for the featured channels tab. */ - featuredChannelsTitle?: string; + featuredChannelsTitle?: string | null; /** * The list of featured channels. */ - featuredChannelsUrls?: string[]; + featuredChannelsUrls?: string[] | null; /** * Lists keywords associated with the channel, comma-separated. */ - keywords?: string; + keywords?: string | null; /** * Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. */ - moderateComments?: boolean; + moderateComments?: boolean | null; /** * A prominent color that can be rendered on this channel page. */ - profileColor?: string; + profileColor?: string | null; /** * Whether the tab to browse the videos should be displayed. */ - showBrowseView?: boolean; + showBrowseView?: boolean | null; /** * Whether related channels should be proposed. */ - showRelatedChannels?: boolean; + showRelatedChannels?: boolean | null; /** * Specifies the channel title. */ - title?: string; + title?: string | null; /** * The ID for a Google Analytics account to track and measure traffic to the channels. */ - trackingAnalyticsAccountId?: string; + trackingAnalyticsAccountId?: string | null; /** * The trailer of the channel, for users that are not subscribers. */ - unsubscribedTrailer?: string; + unsubscribedTrailer?: string | null; } /** * Basic details about a channel, including title, description and thumbnails. @@ -1020,19 +1020,19 @@ export namespace youtube_v3 { /** * The country of the channel. */ - country?: string; + country?: string | null; /** * The custom url of the channel. */ - customUrl?: string; + customUrl?: string | null; /** * The language of the channel's default title and description. */ - defaultLanguage?: string; + defaultLanguage?: string | null; /** * The description of the channel. */ - description?: string; + description?: string | null; /** * Localized title and description, read-only. */ @@ -1040,7 +1040,7 @@ export namespace youtube_v3 { /** * The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response. Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain. */ @@ -1048,7 +1048,7 @@ export namespace youtube_v3 { /** * The channel's title. */ - title?: string; + title?: string | null; } /** * Statistics about a channel: number of subscribers, number of videos in the channel, etc. @@ -1057,23 +1057,23 @@ export namespace youtube_v3 { /** * The number of comments for the channel. */ - commentCount?: string; + commentCount?: string | null; /** * Whether or not the number of subscribers is shown for this user. */ - hiddenSubscriberCount?: boolean; + hiddenSubscriberCount?: boolean | null; /** * The number of subscribers that the channel has. */ - subscriberCount?: string; + subscriberCount?: string | null; /** * The number of videos uploaded to the channel. */ - videoCount?: string; + videoCount?: string | null; /** * The number of times the channel has been viewed. */ - viewCount?: string; + viewCount?: string | null; } /** * JSON template for the status part of a channel. @@ -1082,15 +1082,15 @@ export namespace youtube_v3 { /** * If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity. */ - isLinked?: boolean; + isLinked?: boolean | null; /** * The long uploads status of this channel. See */ - longUploadsStatus?: string; + longUploadsStatus?: string | null; /** * Privacy status of the channel. */ - privacyStatus?: string; + privacyStatus?: string | null; } /** * Freebase topic information related to the channel. @@ -1099,11 +1099,11 @@ export namespace youtube_v3 { /** * A list of Wikipedia URLs that describe the channel's content. */ - topicCategories?: string[]; + topicCategories?: string[] | null; /** * A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API. */ - topicIds?: string[]; + topicIds?: string[] | null; } /** * A comment represents a single YouTube comment. @@ -1112,15 +1112,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the comment. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#comment". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the comment. */ @@ -1130,11 +1130,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of comments that match the request criteria. */ @@ -1142,17 +1142,17 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about a comment, such as its author and text. @@ -1161,63 +1161,63 @@ export namespace youtube_v3 { /** * The id of the author's YouTube channel, if any. */ - authorChannelId?: any; + authorChannelId?: any | null; /** * Link to the author's YouTube channel, if any. */ - authorChannelUrl?: string; + authorChannelUrl?: string | null; /** * The name of the user who posted the comment. */ - authorDisplayName?: string; + authorDisplayName?: string | null; /** * The URL for the avatar of the user who posted the comment. */ - authorProfileImageUrl?: string; + authorProfileImageUrl?: string | null; /** * Whether the current viewer can rate this comment. */ - canRate?: boolean; + canRate?: boolean | null; /** * The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel. */ - channelId?: string; + channelId?: string | null; /** * The total number of likes this comment has received. */ - likeCount?: number; + likeCount?: number | null; /** * The comment's moderation status. Will not be set if the comments were requested through the id filter. */ - moderationStatus?: string; + moderationStatus?: string | null; /** * The unique id of the parent comment, only set for replies. */ - parentId?: string; + parentId?: string | null; /** * The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc. */ - textDisplay?: string; + textDisplay?: string | null; /** * The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author. */ - textOriginal?: string; + textOriginal?: string | null; /** * The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - updatedAt?: string; + updatedAt?: string | null; /** * The ID of the video the comment refers to, if any. */ - videoId?: string; + videoId?: string | null; /** * The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future. */ - viewerRating?: string; + viewerRating?: string | null; } /** * A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies. @@ -1226,15 +1226,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the comment thread. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". */ - kind?: string; + kind?: string | null; /** * The replies object contains a limited number of replies (if any) to the top level comment found in the snippet. */ @@ -1248,11 +1248,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of comment threads that match the request criteria. */ @@ -1260,17 +1260,17 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Comments written in (direct or indirect) reply to the top level comment. @@ -1288,15 +1288,15 @@ export namespace youtube_v3 { /** * Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field. */ - canReply?: boolean; + canReply?: boolean | null; /** * The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself. */ - channelId?: string; + channelId?: string | null; /** * Whether the thread (and therefore all its comments) is visible to all YouTube users. */ - isPublic?: boolean; + isPublic?: boolean | null; /** * The top level comment of this thread. */ @@ -1304,11 +1304,11 @@ export namespace youtube_v3 { /** * The total number of replies (not including the top level comment). */ - totalReplyCount?: number; + totalReplyCount?: number | null; /** * The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. */ - videoId?: string; + videoId?: string | null; } /** * Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 72 @@ -1317,284 +1317,284 @@ export namespace youtube_v3 { /** * The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. */ - acbRating?: string; + acbRating?: string | null; /** * The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). */ - agcomRating?: string; + agcomRating?: string | null; /** * The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. */ - anatelRating?: string; + anatelRating?: string | null; /** * The video's British Board of Film Classification (BBFC) rating. */ - bbfcRating?: string; + bbfcRating?: string | null; /** * The video's rating from Thailand's Board of Film and Video Censors. */ - bfvcRating?: string; + bfvcRating?: string | null; /** * The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). */ - bmukkRating?: string; + bmukkRating?: string | null; /** * The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. */ - catvfrRating?: string; + catvfrRating?: string | null; /** * Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. */ - catvRating?: string; + catvRating?: string | null; /** * The video's Central Board of Film Certification (CBFC - India) rating. */ - cbfcRating?: string; + cbfcRating?: string | null; /** * The video's Consejo de Calificación Cinematográfica (Chile) rating. */ - cccRating?: string; + cccRating?: string | null; /** * The video's rating from Portugal's Comissão de Classificação de Espect´culos. */ - cceRating?: string; + cceRating?: string | null; /** * The video's rating in Switzerland. */ - chfilmRating?: string; + chfilmRating?: string | null; /** * The video's Canadian Home Video Rating System (CHVRS) rating. */ - chvrsRating?: string; + chvrsRating?: string | null; /** * The video's rating from the Commission de Contrôle des Films (Belgium). */ - cicfRating?: string; + cicfRating?: string | null; /** * The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). */ - cnaRating?: string; + cnaRating?: string | null; /** * Rating system in France - Commission de classification cinematographique */ - cncRating?: string; + cncRating?: string | null; /** * The video's rating from France's Conseil supérieur de l?audiovisuel, which rates broadcast content. */ - csaRating?: string; + csaRating?: string | null; /** * The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). */ - cscfRating?: string; + cscfRating?: string | null; /** * The video's rating in the Czech Republic. */ - czfilmRating?: string; + czfilmRating?: string | null; /** * The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. */ - djctqRating?: string; + djctqRating?: string | null; /** * Reasons that explain why the video received its DJCQT (Brazil) rating. */ - djctqRatingReasons?: string[]; + djctqRatingReasons?: string[] | null; /** * Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism */ - ecbmctRating?: string; + ecbmctRating?: string | null; /** * The video's rating in Estonia. */ - eefilmRating?: string; + eefilmRating?: string | null; /** * The video's rating in Egypt. */ - egfilmRating?: string; + egfilmRating?: string | null; /** * The video's Eirin (映倫) rating. Eirin is the Japanese rating system. */ - eirinRating?: string; + eirinRating?: string | null; /** * The video's rating from Malaysia's Film Censorship Board. */ - fcbmRating?: string; + fcbmRating?: string | null; /** * The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. */ - fcoRating?: string; + fcoRating?: string | null; /** * This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. */ - fmocRating?: string; + fmocRating?: string | null; /** * The video's rating from South Africa's Film and Publication Board. */ - fpbRating?: string; + fpbRating?: string | null; /** * Reasons that explain why the video received its FPB (South Africa) rating. */ - fpbRatingReasons?: string[]; + fpbRatingReasons?: string[] | null; /** * The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. */ - fskRating?: string; + fskRating?: string | null; /** * The video's rating in Greece. */ - grfilmRating?: string; + grfilmRating?: string | null; /** * The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. */ - icaaRating?: string; + icaaRating?: string | null; /** * The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. */ - ifcoRating?: string; + ifcoRating?: string | null; /** * The video's rating in Israel. */ - ilfilmRating?: string; + ilfilmRating?: string | null; /** * The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. */ - incaaRating?: string; + incaaRating?: string | null; /** * The video's rating from the Kenya Film Classification Board. */ - kfcbRating?: string; + kfcbRating?: string | null; /** * voor de Classificatie van Audiovisuele Media (Netherlands). */ - kijkwijzerRating?: string; + kijkwijzerRating?: string | null; /** * The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. */ - kmrbRating?: string; + kmrbRating?: string | null; /** * The video's rating from Indonesia's Lembaga Sensor Film. */ - lsfRating?: string; + lsfRating?: string | null; /** * The video's rating from Malta's Film Age-Classification Board. */ - mccaaRating?: string; + mccaaRating?: string | null; /** * The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. */ - mccypRating?: string; + mccypRating?: string | null; /** * The video's rating system for Vietnam - MCST */ - mcstRating?: string; + mcstRating?: string | null; /** * The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). */ - mdaRating?: string; + mdaRating?: string | null; /** * The video's rating from Medietilsynet, the Norwegian Media Authority. */ - medietilsynetRating?: string; + medietilsynetRating?: string | null; /** * The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). */ - mekuRating?: string; + mekuRating?: string | null; /** * The rating system for MENA countries, a clone of MPAA. It is needed to */ - menaMpaaRating?: string; + menaMpaaRating?: string | null; /** * The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). */ - mibacRating?: string; + mibacRating?: string | null; /** * The video's Ministerio de Cultura (Colombia) rating. */ - mocRating?: string; + mocRating?: string | null; /** * The video's rating from Taiwan's Ministry of Culture (文化部). */ - moctwRating?: string; + moctwRating?: string | null; /** * The video's Motion Picture Association of America (MPAA) rating. */ - mpaaRating?: string; + mpaaRating?: string | null; /** * The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. */ - mpaatRating?: string; + mpaatRating?: string | null; /** * The video's rating from the Movie and Television Review and Classification Board (Philippines). */ - mtrcbRating?: string; + mtrcbRating?: string | null; /** * The video's rating in Poland. */ - nbcplRating?: string; + nbcplRating?: string | null; /** * The video's rating from the Maldives National Bureau of Classification. */ - nbcRating?: string; + nbcRating?: string | null; /** * The video's rating from the Bulgarian National Film Center. */ - nfrcRating?: string; + nfrcRating?: string | null; /** * The video's rating from Nigeria's National Film and Video Censors Board. */ - nfvcbRating?: string; + nfvcbRating?: string | null; /** * The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). */ - nkclvRating?: string; - nmcRating?: string; + nkclvRating?: string | null; + nmcRating?: string | null; /** * The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. */ - oflcRating?: string; + oflcRating?: string | null; /** * The video's rating in Peru. */ - pefilmRating?: string; + pefilmRating?: string | null; /** * The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film. */ - rcnofRating?: string; + rcnofRating?: string | null; /** * The video's rating in Venezuela. */ - resorteviolenciaRating?: string; + resorteviolenciaRating?: string | null; /** * The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. */ - rtcRating?: string; + rtcRating?: string | null; /** * The video's rating from Ireland's Raidió Teilifís Éireann. */ - rteRating?: string; + rteRating?: string | null; /** * The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. */ - russiaRating?: string; + russiaRating?: string | null; /** * The video's rating in Slovakia. */ - skfilmRating?: string; + skfilmRating?: string | null; /** * The video's rating in Iceland. */ - smaisRating?: string; + smaisRating?: string | null; /** * The video's rating from Statens medieråd (Sweden's National Media Council). */ - smsaRating?: string; + smsaRating?: string | null; /** * The video's TV Parental Guidelines (TVPG) rating. */ - tvpgRating?: string; + tvpgRating?: string | null; /** * A rating that YouTube uses to identify age-restricted content. */ - ytRating?: string; + ytRating?: string | null; } /** * Geographical coordinates of a point, in WGS84. @@ -1603,15 +1603,15 @@ export namespace youtube_v3 { /** * Altitude above the reference ellipsoid, in meters. */ - altitude?: number; + altitude?: number | null; /** * Latitude in degrees. */ - latitude?: number; + latitude?: number | null; /** * Longitude in degrees. */ - longitude?: number; + longitude?: number | null; } /** * A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category. @@ -1620,15 +1620,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the guide category. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategory". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the category, such as its title. */ @@ -1638,11 +1638,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of categories that can be associated with YouTube channels. In this map, the category ID is the map key, and its value is the corresponding guideCategory resource. */ @@ -1650,31 +1650,31 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategoryListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about a guide category. */ export interface Schema$GuideCategorySnippet { - channelId?: string; + channelId?: string | null; /** * Description of the guide category. */ - title?: string; + title?: string | null; } /** * An i18nLanguage resource identifies a UI language currently supported by YouTube. @@ -1683,15 +1683,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the i18n language. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguage". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the i18n language, such as language code and human-readable name. */ @@ -1701,11 +1701,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of supported i18n languages. In this map, the i18n language ID is the map key, and its value is the corresponding i18nLanguage resource. */ @@ -1713,11 +1713,11 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguageListResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about an i18n language, such as language code and human-readable name. @@ -1726,11 +1726,11 @@ export namespace youtube_v3 { /** * A short BCP-47 code that uniquely identifies a language. */ - hl?: string; + hl?: string | null; /** * The human-readable name of the language in the language itself. */ - name?: string; + name?: string | null; } /** * A i18nRegion resource identifies a region where YouTube is available. @@ -1739,15 +1739,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the i18n region. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegion". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the i18n region, such as region code and human-readable name. */ @@ -1757,11 +1757,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of regions where YouTube is available. In this map, the i18n region ID is the map key, and its value is the corresponding i18nRegion resource. */ @@ -1769,11 +1769,11 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegionListResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about an i18n region, such as region code and human-readable name. @@ -1782,11 +1782,11 @@ export namespace youtube_v3 { /** * The region code as a 2-letter ISO country code. */ - gl?: string; + gl?: string | null; /** * The human-readable name of the region. */ - name?: string; + name?: string | null; } /** * Branding properties for images associated with the channel. @@ -1799,63 +1799,63 @@ export namespace youtube_v3 { /** * This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs. */ - bannerExternalUrl?: string; + bannerExternalUrl?: string | null; /** * Banner image. Desktop size (1060x175). */ - bannerImageUrl?: string; + bannerImageUrl?: string | null; /** * Banner image. Mobile size high resolution (1440x395). */ - bannerMobileExtraHdImageUrl?: string; + bannerMobileExtraHdImageUrl?: string | null; /** * Banner image. Mobile size high resolution (1280x360). */ - bannerMobileHdImageUrl?: string; + bannerMobileHdImageUrl?: string | null; /** * Banner image. Mobile size (640x175). */ - bannerMobileImageUrl?: string; + bannerMobileImageUrl?: string | null; /** * Banner image. Mobile size low resolution (320x88). */ - bannerMobileLowImageUrl?: string; + bannerMobileLowImageUrl?: string | null; /** * Banner image. Mobile size medium/high resolution (960x263). */ - bannerMobileMediumHdImageUrl?: string; + bannerMobileMediumHdImageUrl?: string | null; /** * Banner image. Tablet size extra high resolution (2560x424). */ - bannerTabletExtraHdImageUrl?: string; + bannerTabletExtraHdImageUrl?: string | null; /** * Banner image. Tablet size high resolution (2276x377). */ - bannerTabletHdImageUrl?: string; + bannerTabletHdImageUrl?: string | null; /** * Banner image. Tablet size (1707x283). */ - bannerTabletImageUrl?: string; + bannerTabletImageUrl?: string | null; /** * Banner image. Tablet size low resolution (1138x188). */ - bannerTabletLowImageUrl?: string; + bannerTabletLowImageUrl?: string | null; /** * Banner image. TV size high resolution (1920x1080). */ - bannerTvHighImageUrl?: string; + bannerTvHighImageUrl?: string | null; /** * Banner image. TV size extra high resolution (2120x1192). */ - bannerTvImageUrl?: string; + bannerTvImageUrl?: string | null; /** * Banner image. TV size low resolution (854x480). */ - bannerTvLowImageUrl?: string; + bannerTvLowImageUrl?: string | null; /** * Banner image. TV size medium resolution (1280x720). */ - bannerTvMediumImageUrl?: string; + bannerTvMediumImageUrl?: string | null; /** * The image map script for the large banner image. */ @@ -1875,11 +1875,11 @@ export namespace youtube_v3 { /** * The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages. */ - trackingImageUrl?: string; + trackingImageUrl?: string | null; /** * The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels. */ - watchIconImageUrl?: string; + watchIconImageUrl?: string | null; } /** * Describes information necessary for ingesting an RTMP or an HTTP stream. @@ -1888,21 +1888,21 @@ export namespace youtube_v3 { /** * The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL. */ - backupIngestionAddress?: string; + backupIngestionAddress?: string | null; /** * The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format: STREAM_URL/STREAM_NAME */ - ingestionAddress?: string; + ingestionAddress?: string | null; /** * The HTTP or RTMP stream name that YouTube assigns to the video stream. */ - streamName?: string; + streamName?: string | null; } export interface Schema$InvideoBranding { - imageBytes?: string; - imageUrl?: string; + imageBytes?: string | null; + imageUrl?: string | null; position?: Schema$InvideoPosition; - targetChannelId?: string; + targetChannelId?: string | null; timing?: Schema$InvideoTiming; } /** @@ -1912,11 +1912,11 @@ export namespace youtube_v3 { /** * Describes in which corner of the video the visual widget will appear. */ - cornerPosition?: string; + cornerPosition?: string | null; /** * Defines the position type. */ - type?: string; + type?: string | null; } /** * Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. @@ -1937,7 +1937,7 @@ export namespace youtube_v3 { /** * Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video. */ - useSmartTiming?: boolean; + useSmartTiming?: boolean | null; } /** * Describes a temporal position of a visual widget inside a video. @@ -1946,21 +1946,21 @@ export namespace youtube_v3 { /** * Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default. */ - durationMs?: string; + durationMs?: string | null; /** * Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds. */ - offsetMs?: string; + offsetMs?: string | null; /** * Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video. */ - type?: string; + type?: string | null; } export interface Schema$LanguageTag { - value?: string; + value?: string | null; } export interface Schema$LevelDetails { - displayName?: string; + displayName?: string | null; } /** * A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube. @@ -1973,15 +1973,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the broadcast. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the event, including its title, description, start time, and end time. */ @@ -2002,41 +2002,41 @@ export namespace youtube_v3 { /** * This value uniquely identifies the live stream bound to the broadcast. */ - boundStreamId?: string; + boundStreamId?: string | null; /** * The date and time that the live stream referenced by boundStreamId was last updated. */ - boundStreamLastUpdateTimeMs?: string; - closedCaptionsType?: string; + boundStreamLastUpdateTimeMs?: string | null; + closedCaptionsType?: string | null; /** * This setting indicates whether auto start is enabled for this broadcast. */ - enableAutoStart?: boolean; + enableAutoStart?: boolean | null; /** * This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. */ - enableClosedCaptions?: boolean; + enableClosedCaptions?: boolean | null; /** * This setting indicates whether YouTube should enable content encryption for the broadcast. */ - enableContentEncryption?: boolean; + enableContentEncryption?: boolean | null; /** * This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends. */ - enableDvr?: boolean; + enableDvr?: boolean | null; /** * This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. */ - enableEmbed?: boolean; + enableEmbed?: boolean | null; /** * Indicates whether this broadcast has low latency enabled. */ - enableLowLatency?: boolean; + enableLowLatency?: boolean | null; /** * If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted. */ - latencyPreference?: string; - mesh?: string; + latencyPreference?: string | null; + mesh?: string | null; /** * The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly. */ @@ -2044,26 +2044,26 @@ export namespace youtube_v3 { /** * The projection format of this broadcast. This defaults to rectangular. */ - projection?: string; + projection?: string | null; /** * Automatically start recording after the event goes live. The default value for this property is true. Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback. */ - recordFromStart?: boolean; + recordFromStart?: boolean | null; /** * This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. */ - startWithSlate?: boolean; - stereoLayout?: string; + startWithSlate?: boolean | null; + stereoLayout?: string | null; } export interface Schema$LiveBroadcastListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of broadcasts that match the request criteria. */ @@ -2071,57 +2071,57 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$LiveBroadcastSnippet { /** * The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - actualEndTime?: string; + actualEndTime?: string | null; /** * The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - actualStartTime?: string; - broadcastType?: string; + actualStartTime?: string | null; + broadcastType?: string | null; /** * The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast. */ - channelId?: string; + channelId?: string | null; /** * The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource. */ - description?: string; - isDefaultBroadcast?: boolean; + description?: string | null; + isDefaultBroadcast?: boolean | null; /** * The id of the live chat for this broadcast. */ - liveChatId?: string; + liveChatId?: string | null; /** * The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - scheduledEndTime?: string; + scheduledEndTime?: string | null; /** * The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - scheduledStartTime?: string; + scheduledStartTime?: string | null; /** * A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ @@ -2129,7 +2129,7 @@ export namespace youtube_v3 { /** * The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource. */ - title?: string; + title?: string | null; } /** * Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. @@ -2138,29 +2138,29 @@ export namespace youtube_v3 { /** * The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. */ - concurrentViewers?: string; + concurrentViewers?: string | null; /** * The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. */ - totalChatCount?: string; + totalChatCount?: string | null; } export interface Schema$LiveBroadcastStatus { /** * The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method. */ - lifeCycleStatus?: string; + lifeCycleStatus?: string | null; /** * Priority of the live broadcast event (internal state). */ - liveBroadcastPriority?: string; + liveBroadcastPriority?: string | 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. */ - privacyStatus?: string; + privacyStatus?: string | null; /** * The broadcast's recording status. */ - recordingStatus?: string; + recordingStatus?: string | null; } /** * A liveChatBan resource represents a ban for a YouTube live chat. @@ -2169,15 +2169,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the ban. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the ban. */ @@ -2187,34 +2187,34 @@ export namespace youtube_v3 { /** * The duration of a ban, only filled if the ban has type TEMPORARY. */ - banDurationSeconds?: string; + banDurationSeconds?: string | null; bannedUserDetails?: Schema$ChannelProfileDetails; /** * The chat this ban is pertinent to. */ - liveChatId?: string; + liveChatId?: string | null; /** * The type of ban. */ - type?: string; + type?: string | null; } export interface Schema$LiveChatFanFundingEventDetails { /** * A rendered string that displays the fund amount and currency to the user. */ - amountDisplayString?: string; + amountDisplayString?: string | null; /** * The amount of the fund. */ - amountMicros?: string; + amountMicros?: string | null; /** * The currency in which the fund was made. */ - currency?: string; + currency?: string | null; /** * The comment added by the user to this fan funding event. */ - userComment?: string; + userComment?: string | null; } /** * A liveChatMessage resource represents a chat message in a YouTube Live Chat. @@ -2227,15 +2227,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the message. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the message. */ @@ -2245,48 +2245,48 @@ export namespace youtube_v3 { /** * The YouTube channel ID. */ - channelId?: string; + channelId?: string | null; /** * The channel's URL. */ - channelUrl?: string; + channelUrl?: string | null; /** * The channel's display name. */ - displayName?: string; + displayName?: string | null; /** * Whether the author is a moderator of the live chat. */ - isChatModerator?: boolean; + isChatModerator?: boolean | null; /** * Whether the author is the owner of the live chat. */ - isChatOwner?: boolean; + isChatOwner?: boolean | null; /** * Whether the author is a sponsor of the live chat. */ - isChatSponsor?: boolean; + isChatSponsor?: boolean | null; /** * Whether the author's identity has been verified by YouTube. */ - isVerified?: boolean; + isVerified?: boolean | null; /** * The channels's avatar URL. */ - profileImageUrl?: string; + profileImageUrl?: string | null; } export interface Schema$LiveChatMessageDeletedDetails { - deletedMessageId?: string; + deletedMessageId?: string | null; } export interface Schema$LiveChatMessageListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of live chat messages. */ @@ -2294,38 +2294,38 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The date and time when the underlying stream went offline. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - offlineAt?: string; + offlineAt?: string | null; pageInfo?: Schema$PageInfo; /** * The amount of time the client should wait before polling again. */ - pollingIntervalMillis?: number; + pollingIntervalMillis?: number | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$LiveChatMessageRetractedDetails { - retractedMessageId?: string; + retractedMessageId?: string | null; } export interface Schema$LiveChatMessageSnippet { /** * The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase */ - authorChannelId?: string; + authorChannelId?: string | null; /** * Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. */ - displayMessage?: string; + displayMessage?: string | null; /** * Details about the funding event, this is only set if the type is 'fanFundingEvent'. */ @@ -2333,8 +2333,8 @@ export namespace youtube_v3 { /** * Whether the message has display content that should be displayed to users. */ - hasDisplayContent?: boolean; - liveChatId?: string; + hasDisplayContent?: boolean | null; + liveChatId?: string | null; messageDeletedDetails?: Schema$LiveChatMessageDeletedDetails; messageRetractedDetails?: Schema$LiveChatMessageRetractedDetails; pollClosedDetails?: Schema$LiveChatPollClosedDetails; @@ -2344,7 +2344,7 @@ export namespace youtube_v3 { /** * The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * Details about the Super Chat event, this is only set if the type is 'superChatEvent'. */ @@ -2360,7 +2360,7 @@ export namespace youtube_v3 { /** * The type of message, this will always be present, it determines the contents of the message as well as which fields will be present. */ - type?: string; + type?: string | null; userBannedDetails?: Schema$LiveChatUserBannedMessageDetails; } /** @@ -2370,15 +2370,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the moderator. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the moderator. */ @@ -2388,11 +2388,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of moderators that match the request criteria. */ @@ -2400,27 +2400,27 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$LiveChatModeratorSnippet { /** * The ID of the live chat this moderator can act on. */ - liveChatId?: string; + liveChatId?: string | null; /** * Details about the moderator. */ @@ -2430,70 +2430,70 @@ export namespace youtube_v3 { /** * The id of the poll that was closed. */ - pollId?: string; + pollId?: string | null; } export interface Schema$LiveChatPollEditedDetails { - id?: string; + id?: string | null; items?: Schema$LiveChatPollItem[]; - prompt?: string; + prompt?: string | null; } export interface Schema$LiveChatPollItem { /** * Plain text description of the item. */ - description?: string; - itemId?: string; + description?: string | null; + itemId?: string | null; } export interface Schema$LiveChatPollOpenedDetails { - id?: string; + id?: string | null; items?: Schema$LiveChatPollItem[]; - prompt?: string; + prompt?: string | null; } export interface Schema$LiveChatPollVotedDetails { /** * The poll item the user chose. */ - itemId?: string; + itemId?: string | null; /** * The poll the user voted on. */ - pollId?: string; + pollId?: string | null; } export interface Schema$LiveChatSuperChatDetails { /** * A rendered string that displays the fund amount and currency to the user. */ - amountDisplayString?: string; + amountDisplayString?: string | null; /** * The amount purchased by the user, in micros (1,750,000 micros = 1.75). */ - amountMicros?: string; + amountMicros?: string | null; /** * The currency in which the purchase was made. */ - currency?: string; + currency?: string | null; /** * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. */ - tier?: number; + tier?: number | null; /** * The comment added by the user to this Super Chat event. */ - userComment?: string; + userComment?: string | null; } export interface Schema$LiveChatSuperStickerDetails { /** * A rendered string that displays the fund amount and currency to the user. */ - amountDisplayString?: string; + amountDisplayString?: string | null; /** * The amount purchased by the user, in micros (1,750,000 micros = 1.75). */ - amountMicros?: string; + amountMicros?: string | null; /** * The currency in which the purchase was made. */ - currency?: string; + currency?: string | null; /** * Information about the Super Sticker. */ @@ -2501,19 +2501,19 @@ export namespace youtube_v3 { /** * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. */ - tier?: number; + tier?: number | null; } export interface Schema$LiveChatTextMessageDetails { /** * The user's message. */ - messageText?: string; + messageText?: string | null; } export interface Schema$LiveChatUserBannedMessageDetails { /** * The duration of the ban. This property is only present if the banType is temporary. */ - banDurationSeconds?: string; + banDurationSeconds?: string | null; /** * The details of the user that was banned. */ @@ -2521,7 +2521,7 @@ export namespace youtube_v3 { /** * The type of ban. */ - banType?: string; + banType?: string | null; } /** * A live stream describes a live ingestion point. @@ -2538,15 +2538,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the stream. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the stream, including its channel, title, and description. */ @@ -2560,19 +2560,19 @@ export namespace youtube_v3 { /** * The long-form description of the issue and how to resolve it. */ - description?: string; + description?: string | null; /** * The short-form reason for this issue. */ - reason?: string; + reason?: string | null; /** * How severe this issue is to the stream. */ - severity?: string; + severity?: string | null; /** * The kind of error happening. */ - type?: string; + type?: string | null; } /** * Detailed settings of a stream. @@ -2581,11 +2581,11 @@ export namespace youtube_v3 { /** * The ingestion URL where the closed captions of this stream are sent. */ - closedCaptionsIngestionUrl?: string; + closedCaptionsIngestionUrl?: string | null; /** * Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times. If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream. */ - isReusable?: boolean; + isReusable?: boolean | null; } export interface Schema$LiveStreamHealthStatus { /** @@ -2595,21 +2595,21 @@ export namespace youtube_v3 { /** * The last time this status was updated (in seconds) */ - lastUpdateTimeSeconds?: string; + lastUpdateTimeSeconds?: string | null; /** * The status code of this stream */ - status?: string; + status?: string | null; } export interface Schema$LiveStreamListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of live streams that match the request criteria. */ @@ -2617,40 +2617,40 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$LiveStreamSnippet { /** * The ID that YouTube uses to uniquely identify the channel that is transmitting the stream. */ - channelId?: string; + channelId?: string | null; /** * The stream's description. The value cannot be longer than 10000 characters. */ - description?: string; - isDefaultStream?: boolean; + description?: string | null; + isDefaultStream?: boolean | null; /** * The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * The stream's title. The value must be between 1 and 128 characters long. */ - title?: string; + title?: string | null; } /** * Brief description of the live stream status. @@ -2660,10 +2660,10 @@ export namespace youtube_v3 { * The health status of the stream. */ healthStatus?: Schema$LiveStreamHealthStatus; - streamStatus?: string; + streamStatus?: string | null; } export interface Schema$LocalizedProperty { - default?: string; + default?: string | null; /** * The language of the default property. */ @@ -2671,8 +2671,8 @@ export namespace youtube_v3 { localized?: Schema$LocalizedString[]; } export interface Schema$LocalizedString { - language?: string; - value?: string; + language?: string | null; + value?: string | null; } /** * A member resource represents a member for a YouTube channel. A member provides recurring monetary support to a creator and receives special benefits. @@ -2681,15 +2681,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the member. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#member". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the member. */ @@ -2699,11 +2699,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of members that match the request criteria. */ @@ -2711,43 +2711,43 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#memberListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } 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. */ - accessibleLevels?: string[]; + accessibleLevels?: string[] | null; /** * The date and time when the user became a continuous member across all levels. */ - memberSince?: string; + memberSince?: string | null; /** * The date and time when the user started to continuously have access to the currently highest level. */ - memberSinceCurrentLevel?: string; + memberSinceCurrentLevel?: string | null; /** * The cumulative time the user has been a member across all levels in complete months (the time is rounded down to the nearest integer). */ - memberTotalDuration?: number; + memberTotalDuration?: number | null; /** * The cumulative time the user has had access to the currently highest level in complete months (the time is rounded down to the nearest integer). */ - memberTotalDurationCurrentLevel?: number; + memberTotalDurationCurrentLevel?: number | null; /** * The highest level the user has access to at the moment. */ - purchasedLevel?: string; + purchasedLevel?: string | null; } /** * A membershipsLevel resource represents an offer made by YouTube creators for their fans. Users can become members of the channel by joining one of the available levels. They will provide recurring monetary support and receives special benefits. @@ -2756,15 +2756,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the memberships level. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#membershipsLevel". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the level. */ @@ -2774,11 +2774,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of pricing levels offered by a creator to the fans. */ @@ -2786,24 +2786,24 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#membershipsLevelListResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$MembershipsLevelSnippet { /** * The id of the channel that's offering channel memberships. */ - creatorChannelId?: string; + creatorChannelId?: string | null; levelDetails?: Schema$LevelDetails; } export interface Schema$MemberSnippet { /** * The id of the channel that's offering memberships. */ - creatorChannelId?: string; + creatorChannelId?: string | null; /** * Details about the member. */ @@ -2820,15 +2820,15 @@ export namespace youtube_v3 { /** * If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay. */ - broadcastStreamDelayMs?: number; + broadcastStreamDelayMs?: number | null; /** * HTML code that embeds a player that plays the monitor stream. */ - embedHtml?: string; + embedHtml?: string | null; /** * This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. Note: This property cannot be updated once the broadcast is in the testing or live state. */ - enableMonitorStream?: boolean; + enableMonitorStream?: boolean | null; } /** * Nonprofit information. @@ -2841,10 +2841,10 @@ export namespace youtube_v3 { /** * Legal name of the nonprofit. */ - nonprofitLegalName?: string; + nonprofitLegalName?: string | null; } export interface Schema$NonprofitId { - value?: string; + value?: string | null; } /** * Paging details for lists of resources, including total number of items available and number of resources returned in a single page. @@ -2853,11 +2853,11 @@ export namespace youtube_v3 { /** * The number of results included in the API response. */ - resultsPerPage?: number; + resultsPerPage?: number | null; /** * The total number of results in the result set. */ - totalResults?: number; + totalResults?: number | null; } /** * A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private. YouTube also uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. @@ -2870,19 +2870,19 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the playlist. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#playlist". */ - kind?: string; + kind?: string | null; /** * Localizations for different languages */ - localizations?: {[key: string]: Schema$PlaylistLocalization}; + localizations?: {[key: string]: Schema$PlaylistLocalization} | null; /** * The player object contains information that you would use to play the playlist in an embedded player. */ @@ -2900,7 +2900,7 @@ export namespace youtube_v3 { /** * The number of videos in the playlist. */ - itemCount?: number; + itemCount?: number | null; } /** * A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel. @@ -2913,15 +2913,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the playlist item. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the playlist item, such as its title and position in the playlist. */ @@ -2935,33 +2935,33 @@ export namespace youtube_v3 { /** * The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video. */ - endAt?: string; + endAt?: string | null; /** * A user-generated note for this item. */ - note?: string; + note?: string | null; /** * The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0. */ - startAt?: string; + startAt?: string | null; /** * The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request. */ - videoId?: string; + videoId?: string | null; /** * The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - videoPublishedAt?: string; + videoPublishedAt?: string | null; } export interface Schema$PlaylistItemListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of playlist items that match the request criteria. */ @@ -2969,21 +2969,21 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItemListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about a playlist, including title, description and thumbnails. @@ -2992,27 +2992,27 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the user that added the item to the playlist. */ - channelId?: string; + channelId?: string | null; /** * Channel title for the channel that the playlist item belongs to. */ - channelTitle?: string; + channelTitle?: string | null; /** * The item's description. */ - description?: string; + description?: string | null; /** * The ID that YouTube uses to uniquely identify the playlist that the playlist item is in. */ - playlistId?: string; + playlistId?: string | null; /** * The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth. */ - position?: number; + position?: number | null; /** * The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item. */ @@ -3024,7 +3024,7 @@ export namespace youtube_v3 { /** * The item's title. */ - title?: string; + title?: string | null; } /** * Information about the playlist item's privacy status. @@ -3033,17 +3033,17 @@ export namespace youtube_v3 { /** * This resource's privacy status. */ - privacyStatus?: string; + privacyStatus?: string | null; } export interface Schema$PlaylistListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of playlists that match the request criteria. */ @@ -3051,21 +3051,21 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#playlistListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Playlist localization setting @@ -3074,17 +3074,17 @@ export namespace youtube_v3 { /** * The localized strings for playlist's description. */ - description?: string; + description?: string | null; /** * The localized strings for playlist's title. */ - title?: string; + title?: string | null; } export interface Schema$PlaylistPlayer { /** * An <iframe> tag that embeds a player that will play the playlist. */ - embedHtml?: string; + embedHtml?: string | null; } /** * Basic details about a playlist, including title, description and thumbnails. @@ -3093,19 +3093,19 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the channel that published the playlist. */ - channelId?: string; + channelId?: string | null; /** * The channel title of the channel that the video belongs to. */ - channelTitle?: string; + channelTitle?: string | null; /** * The language of the playlist's default title and description. */ - defaultLanguage?: string; + defaultLanguage?: string | null; /** * The playlist's description. */ - description?: string; + description?: string | null; /** * Localized title and description, read-only. */ @@ -3113,11 +3113,11 @@ export namespace youtube_v3 { /** * The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * Keyword tags associated with the playlist. */ - tags?: string[]; + tags?: string[] | null; /** * A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ @@ -3125,13 +3125,13 @@ export namespace youtube_v3 { /** * The playlist's title. */ - title?: string; + title?: string | null; } export interface Schema$PlaylistStatus { /** * The playlist's privacy status. */ - privacyStatus?: string; + privacyStatus?: string | null; } /** * Describes a single promoted item. @@ -3140,7 +3140,7 @@ export namespace youtube_v3 { /** * A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website. */ - customMessage?: string; + customMessage?: string | null; /** * Identifies the promoted item. */ @@ -3148,7 +3148,7 @@ export namespace youtube_v3 { /** * If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner. */ - promotedByContentOwner?: boolean; + promotedByContentOwner?: boolean | null; /** * The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing. */ @@ -3161,19 +3161,19 @@ export namespace youtube_v3 { /** * If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set. */ - recentlyUploadedBy?: string; + recentlyUploadedBy?: string | null; /** * Describes the type of the promoted item. */ - type?: string; + type?: string | null; /** * If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video. */ - videoId?: string; + videoId?: string | null; /** * If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website. */ - websiteUrl?: string; + websiteUrl?: string | null; } /** * A pair Property / Value. @@ -3182,11 +3182,11 @@ export namespace youtube_v3 { /** * A property. */ - property?: string; + property?: string | null; /** * The property's value. */ - value?: string; + value?: string | null; } /** * A resource id is a generic reference that points to another YouTube resource. @@ -3195,29 +3195,29 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel. */ - channelId?: string; + channelId?: string | null; /** * The type of the API resource. */ - kind?: string; + kind?: string | null; /** * The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist. */ - playlistId?: string; + playlistId?: string | null; /** * The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video. */ - videoId?: string; + videoId?: string | null; } export interface Schema$SearchListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of results that match the search criteria. */ @@ -3225,22 +3225,22 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; - regionCode?: string; + prevPageToken?: string | null; + regionCode?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data. @@ -3249,7 +3249,7 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The id object contains information that can be used to uniquely identify the resource that matches the search request. */ @@ -3257,7 +3257,7 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description. */ @@ -3270,23 +3270,23 @@ export namespace youtube_v3 { /** * The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies. */ - channelId?: string; + channelId?: string | null; /** * The title of the channel that published the resource that the search result identifies. */ - channelTitle?: string; + channelTitle?: string | null; /** * A description of the search result. */ - description?: string; + description?: string | null; /** * It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts. */ - liveBroadcastContent?: string; + liveBroadcastContent?: string | null; /** * The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ @@ -3294,7 +3294,7 @@ export namespace youtube_v3 { /** * The title of the search result. */ - title?: string; + title?: string | null; } /** * A sponsor resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits. @@ -3303,11 +3303,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#sponsor". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the sponsor. */ @@ -3317,11 +3317,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of sponsors that match the request criteria. */ @@ -3329,27 +3329,27 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#sponsorListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$SponsorSnippet { /** * The id of the channel being sponsored. */ - channelId?: string; + channelId?: string | null; /** * The cumulative time a user has been a sponsor in months. */ - cumulativeDurationMonths?: number; + cumulativeDurationMonths?: number | null; /** * Details about the sponsor. */ @@ -3357,7 +3357,7 @@ export namespace youtube_v3 { /** * The date and time when the user became a sponsor. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - sponsorSince?: string; + sponsorSince?: string | null; } /** * A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video. @@ -3370,15 +3370,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the subscription. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#subscription". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to. */ @@ -3395,25 +3395,25 @@ export namespace youtube_v3 { /** * The type of activity this subscription is for (only uploads, everything). */ - activityType?: string; + activityType?: string | null; /** * The number of new items in the subscription since its content was last read. */ - newItemCount?: number; + newItemCount?: number | null; /** * The approximate number of items that the subscription points to. */ - totalItemCount?: number; + totalItemCount?: number | null; } export interface Schema$SubscriptionListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of subscriptions that match the request criteria. */ @@ -3421,21 +3421,21 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about a subscription, including title, description and thumbnails of the subscribed item. @@ -3444,19 +3444,19 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the subscriber's channel. */ - channelId?: string; + channelId?: string | null; /** * Channel title for the channel that the subscription belongs to. */ - channelTitle?: string; + channelTitle?: string | null; /** * The subscription's details. */ - description?: string; + description?: string | null; /** * The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * The id object contains information about the channel that the user subscribed to. */ @@ -3468,7 +3468,7 @@ export namespace youtube_v3 { /** * The subscription's title. */ - title?: string; + title?: string | null; } /** * Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. @@ -3477,11 +3477,11 @@ export namespace youtube_v3 { /** * The channel ID of the subscriber. */ - channelId?: string; + channelId?: string | null; /** * The description of the subscriber. */ - description?: string; + description?: string | null; /** * Thumbnails for this subscriber. */ @@ -3489,7 +3489,7 @@ export namespace youtube_v3 { /** * The title of the subscriber. */ - title?: string; + title?: string | null; } /** * A superChatEvent resource represents a Super Chat purchase on a YouTube channel. @@ -3498,15 +3498,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube assigns to uniquely identify the Super Chat event. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEvent". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the Super Chat event. */ @@ -3516,11 +3516,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of Super Chat purchases that match the request criteria. */ @@ -3528,55 +3528,55 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEventListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$SuperChatEventSnippet { /** * The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000. */ - amountMicros?: string; + amountMicros?: string | null; /** * Channel id where the event occurred. */ - channelId?: string; + channelId?: string | null; /** * The text contents of the comment left by the user. */ - commentText?: string; + commentText?: string | null; /** * The date and time when the event occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - createdAt?: string; + createdAt?: string | null; /** * The currency in which the purchase was made. ISO 4217. */ - currency?: string; + currency?: string | null; /** * A rendered string that displays the purchase amount and currency (e.g., "$1.00"). The string is rendered for the given language. */ - displayString?: string; + displayString?: string | null; /** * True if this event is a Super Chat for Good purchase. */ - isSuperChatForGood?: boolean; + isSuperChatForGood?: boolean | null; /** * True if this event is a Super Sticker event. */ - isSuperStickerEvent?: boolean; + isSuperStickerEvent?: boolean | null; /** * The tier for the paid message, which is based on the amount of money spent to purchase the message. */ - messageType?: number; + messageType?: number | null; /** * If this event is a Super Chat for Good purchase, this field will contain information about the charity the purchase is donated to. */ @@ -3594,15 +3594,15 @@ export namespace youtube_v3 { /** * Internationalized alt text that describes the sticker image and any animation associated with it. */ - altText?: string; + altText?: string | null; /** * Specifies the localization language in which the alt text is returned. */ - altTextLanguage?: string; + altTextLanguage?: string | null; /** * Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker. */ - stickerId?: string; + stickerId?: string | null; } /** * A thumbnail is an image representing a YouTube resource. @@ -3611,15 +3611,15 @@ export namespace youtube_v3 { /** * (Optional) Height of the thumbnail image. */ - height?: number; + height?: number | null; /** * The thumbnail image's URL. */ - url?: string; + url?: string | null; /** * (Optional) Width of the thumbnail image. */ - width?: number; + width?: number | null; } /** * Internal representation of thumbnails for a YouTube resource. @@ -3650,11 +3650,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of thumbnails. */ @@ -3662,11 +3662,11 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#thumbnailSetResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Stub token pagination template to suppress results. @@ -3687,7 +3687,7 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner. */ @@ -3695,11 +3695,11 @@ export namespace youtube_v3 { /** * The ID that YouTube uses to uniquely identify the video. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#video". */ - kind?: string; + kind?: string | null; /** * The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. */ @@ -3707,7 +3707,7 @@ export namespace youtube_v3 { /** * List with all localizations. */ - localizations?: {[key: string]: Schema$VideoLocalization}; + localizations?: {[key: string]: Schema$VideoLocalization} | null; /** * The monetizationDetails object encapsulates information about the monetization status of the video. */ @@ -3753,23 +3753,23 @@ export namespace youtube_v3 { /** * Additional comments regarding the abuse report. */ - comments?: string; + comments?: string | null; /** * The language that the content was viewed in. */ - language?: string; + language?: string | null; /** * The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID. */ - reasonId?: string; + reasonId?: string | null; /** * The specific, or secondary, reason that this content is abusive (if available). The value is an abuse report reason ID that is a valid secondary reason for the primary reason. */ - secondaryReasonId?: string; + secondaryReasonId?: string | null; /** * The ID that YouTube uses to uniquely identify the video. */ - videoId?: string; + videoId?: string | null; } /** * A videoAbuseReportReason resource identifies a reason that a video could be reported as abusive. Video abuse report reasons are used with video.ReportAbuse. @@ -3778,15 +3778,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID of this abuse report reason. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReason". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the abuse report reason. */ @@ -3796,11 +3796,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of valid abuse reasons that are used with video.ReportAbuse. */ @@ -3808,11 +3808,11 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReasonListResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about a video category, such as its localized title. @@ -3821,7 +3821,7 @@ export namespace youtube_v3 { /** * The localized label belonging to this abuse report reason. */ - label?: string; + label?: string | null; /** * The secondary reasons associated with this reason, if any are available. (There might be 0 or more.) */ @@ -3831,25 +3831,25 @@ export namespace youtube_v3 { /** * The ID of this abuse report secondary reason. */ - id?: string; + id?: string | null; /** * The localized label for this abuse report secondary reason. */ - label?: string; + label?: string | null; } export interface Schema$VideoAgeGating { /** * Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. */ - alcoholContent?: boolean; + alcoholContent?: boolean | null; /** * Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. */ - restricted?: boolean; + restricted?: boolean | null; /** * Video game rating, if any. */ - videoGameRating?: string; + videoGameRating?: string | null; } /** * A videoCategory resource identifies a category that has been or could be associated with uploaded videos. @@ -3858,15 +3858,15 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the video category. */ - id?: string; + id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategory". */ - kind?: string; + kind?: string | null; /** * The snippet object contains basic details about the video category, including its title. */ @@ -3876,11 +3876,11 @@ export namespace youtube_v3 { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding videoCategory resource. */ @@ -3888,35 +3888,35 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategoryListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Basic details about a video category, such as its localized title. */ export interface Schema$VideoCategorySnippet { - assignable?: boolean; + assignable?: boolean | null; /** * The YouTube channel that created the video category. */ - channelId?: string; + channelId?: string | null; /** * The video category's title. */ - title?: string; + title?: string | null; } /** * Details about the content of a YouTube Video. @@ -3925,7 +3925,7 @@ export namespace youtube_v3 { /** * The value of captions indicates whether the video has captions or not. */ - caption?: string; + caption?: string | null; /** * Specifies the ratings that the video received under various rating schemes. */ @@ -3937,27 +3937,27 @@ export namespace youtube_v3 { /** * The value of definition indicates whether the video is available in high definition or only in standard definition. */ - definition?: string; + definition?: string | null; /** * The value of dimension indicates whether the video is available in 3D or in 2D. */ - dimension?: string; + dimension?: string | null; /** * The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long. */ - duration?: string; + duration?: string | null; /** * Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. */ - hasCustomThumbnail?: boolean; + hasCustomThumbnail?: boolean | null; /** * The value of is_license_content indicates whether the video is licensed content. */ - licensedContent?: boolean; + licensedContent?: boolean | null; /** * Specifies the projection format of the video. */ - projection?: string; + projection?: string | null; /** * The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property. */ @@ -3970,11 +3970,11 @@ export namespace youtube_v3 { /** * A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries. */ - allowed?: string[]; + allowed?: string[] | null; /** * A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries. */ - blocked?: string[]; + blocked?: string[] | null; } /** * Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. @@ -3987,31 +3987,31 @@ export namespace youtube_v3 { /** * The uploaded video file's combined (video and audio) bitrate in bits per second. */ - bitrateBps?: string; + bitrateBps?: string | null; /** * The uploaded video file's container format. */ - container?: string; + container?: string | null; /** * The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM */ - creationTime?: string; + creationTime?: string | null; /** * The length of the uploaded video in milliseconds. */ - durationMs?: string; + durationMs?: string | null; /** * The uploaded file's name. This field is present whether a video file or another type of file was uploaded. */ - fileName?: string; + fileName?: string | null; /** * The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. */ - fileSize?: string; + fileSize?: string | null; /** * The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded. */ - fileType?: string; + fileType?: string | null; /** * A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. */ @@ -4024,19 +4024,19 @@ export namespace youtube_v3 { /** * The audio stream's bitrate, in bits per second. */ - bitrateBps?: string; + bitrateBps?: string | null; /** * The number of audio channels that the stream contains. */ - channelCount?: number; + channelCount?: number | null; /** * The audio codec that the stream uses. */ - codec?: string; + codec?: string | null; /** * A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. */ - vendor?: string; + vendor?: string | null; } /** * Information about a video stream. @@ -4045,45 +4045,45 @@ export namespace youtube_v3 { /** * The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. */ - aspectRatio?: number; + aspectRatio?: number | null; /** * The video stream's bitrate, in bits per second. */ - bitrateBps?: string; + bitrateBps?: string | null; /** * The video codec that the stream uses. */ - codec?: string; + codec?: string | null; /** * The video stream's frame rate, in frames per second. */ - frameRateFps?: number; + frameRateFps?: number | null; /** * The encoded video content's height in pixels. */ - heightPixels?: number; + heightPixels?: number | null; /** * The amount that YouTube needs to rotate the original source content to properly display the video. */ - rotation?: string; + rotation?: string | null; /** * A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. */ - vendor?: string; + vendor?: string | null; /** * The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels. */ - widthPixels?: number; + widthPixels?: number | null; } export interface Schema$VideoGetRatingResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of ratings that match the request criteria. */ @@ -4091,21 +4091,21 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse". */ - kind?: string; + kind?: string | null; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } export interface Schema$VideoListResponse { /** * Etag of this resource. */ - etag?: string; + etag?: string | null; /** * Serialized EventId of the request which produced this response. */ - eventId?: string; + eventId?: string | null; /** * A list of videos that match the request criteria. */ @@ -4113,21 +4113,21 @@ export namespace youtube_v3 { /** * Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse". */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ - prevPageToken?: string; + prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ - visitorId?: string; + visitorId?: string | null; } /** * Details about the live streaming metadata. @@ -4136,27 +4136,27 @@ export namespace youtube_v3 { /** * The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. */ - activeLiveChatId?: string; + activeLiveChatId?: string | null; /** * The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over. */ - actualEndTime?: string; + actualEndTime?: string | null; /** * The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. */ - actualStartTime?: string; + actualStartTime?: string | null; /** * The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. */ - concurrentViewers?: string; + concurrentViewers?: string | null; /** * The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. */ - scheduledEndTime?: string; + scheduledEndTime?: string | null; /** * The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - scheduledStartTime?: string; + scheduledStartTime?: string | null; } /** * Localized versions of certain video properties (e.g. title). @@ -4165,11 +4165,11 @@ export namespace youtube_v3 { /** * Localized version of the video's description. */ - description?: string; + description?: string | null; /** * Localized version of the video's title. */ - title?: string; + title?: string | null; } /** * Details about monetization of a YouTube Video. @@ -4184,15 +4184,15 @@ export namespace youtube_v3 { * Player to be used for a video playback. */ export interface Schema$VideoPlayer { - embedHeight?: string; + embedHeight?: string | null; /** * An <iframe> tag that embeds a player that will play the video. */ - embedHtml?: string; + embedHtml?: string | null; /** * The embed width */ - embedWidth?: string; + embedWidth?: string | null; } /** * Describes processing status and progress and availability of some other Video resource parts. @@ -4201,19 +4201,19 @@ export namespace youtube_v3 { /** * This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. */ - editorSuggestionsAvailability?: string; + editorSuggestionsAvailability?: string | null; /** * This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request. */ - fileDetailsAvailability?: string; + fileDetailsAvailability?: string | null; /** * The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed. */ - processingFailureReason?: string; + processingFailureReason?: string | null; /** * This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. */ - processingIssuesAvailability?: string; + processingIssuesAvailability?: string | null; /** * The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing. */ @@ -4221,15 +4221,15 @@ export namespace youtube_v3 { /** * The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed. */ - processingStatus?: string; + processingStatus?: string | null; /** * This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. */ - tagSuggestionsAvailability?: string; + tagSuggestionsAvailability?: string | null; /** * This value indicates whether thumbnail images have been generated for the video. */ - thumbnailsAvailability?: string; + thumbnailsAvailability?: string | null; } /** * Video processing progress and completion time estimate. @@ -4238,15 +4238,15 @@ export namespace youtube_v3 { /** * The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video. */ - partsProcessed?: string; + partsProcessed?: string | null; /** * An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video. */ - partsTotal?: string; + partsTotal?: string | null; /** * An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. */ - timeLeftMs?: string; + timeLeftMs?: string | null; } /** * Project specific details about the content of a YouTube Video. @@ -4255,11 +4255,11 @@ export namespace youtube_v3 { /** * A list of project tags associated with the video during the upload. */ - tags?: string[]; + tags?: string[] | null; } export interface Schema$VideoRating { - rating?: string; - videoId?: string; + rating?: string | null; + videoId?: string | null; } /** * Recording information associated with the video. @@ -4272,11 +4272,11 @@ export namespace youtube_v3 { /** * The text description of the location where the video was recorded. */ - locationDescription?: string; + locationDescription?: string | null; /** * The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. */ - recordingDate?: string; + recordingDate?: string | null; } /** * Basic details about a video, including title, description, uploader, thumbnails and category. @@ -4285,31 +4285,31 @@ export namespace youtube_v3 { /** * The YouTube video category associated with the video. */ - categoryId?: string; + categoryId?: string | null; /** * The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. */ - channelId?: string; + channelId?: string | null; /** * Channel title for the channel that the video belongs to. */ - channelTitle?: string; + channelTitle?: string | null; /** * The default_audio_language property specifies the language spoken in the video's default audio track. */ - defaultAudioLanguage?: string; + defaultAudioLanguage?: string | null; /** * The language of the videos's default snippet. */ - defaultLanguage?: string; + defaultLanguage?: string | null; /** * The video's description. */ - description?: string; + description?: string | null; /** * Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. */ - liveBroadcastContent?: string; + liveBroadcastContent?: string | null; /** * Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only) */ @@ -4317,11 +4317,11 @@ export namespace youtube_v3 { /** * The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * A list of keyword tags associated with the video. Tags may contain spaces. */ - tags?: string[]; + tags?: string[] | null; /** * A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ @@ -4329,7 +4329,7 @@ export namespace youtube_v3 { /** * The video's title. */ - title?: string; + title?: string | null; } /** * Statistics about the video, such as the number of times the video was viewed or liked. @@ -4338,23 +4338,23 @@ export namespace youtube_v3 { /** * The number of comments for the video. */ - commentCount?: string; + commentCount?: string | null; /** * The number of users who have indicated that they disliked the video by giving it a negative rating. */ - dislikeCount?: string; + dislikeCount?: string | null; /** * The number of users who currently have the video marked as a favorite video. */ - favoriteCount?: string; + favoriteCount?: string | null; /** * The number of users who have indicated that they liked the video by giving it a positive rating. */ - likeCount?: string; + likeCount?: string | null; /** * The number of times the video has been viewed. */ - viewCount?: string; + viewCount?: string | null; } /** * Basic details about a video category, such as its localized title. @@ -4363,35 +4363,35 @@ export namespace youtube_v3 { /** * This value indicates if the video can be embedded on another website. */ - embeddable?: boolean; + embeddable?: boolean | null; /** * This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. */ - failureReason?: string; + failureReason?: string | null; /** * The video's license. */ - license?: string; + license?: string | null; /** * The video's privacy status. */ - privacyStatus?: string; + privacyStatus?: string | null; /** * This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. */ - publicStatsViewable?: boolean; + publicStatsViewable?: boolean | null; /** * The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishAt?: string; + publishAt?: string | null; /** * 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; + rejectionReason?: string | null; /** * The status of the uploaded video. */ - uploadStatus?: string; + uploadStatus?: string | null; } /** * Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. @@ -4400,19 +4400,19 @@ export namespace youtube_v3 { /** * A list of video editing operations that might improve the video quality or playback experience of the uploaded video. */ - editorSuggestions?: string[]; + editorSuggestions?: string[] | null; /** * A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed. */ - processingErrors?: string[]; + processingErrors?: string[] | null; /** * A list of suggestions that may improve YouTube's ability to process the video. */ - processingHints?: string[]; + processingHints?: string[] | null; /** * A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track. */ - processingWarnings?: string[]; + processingWarnings?: string[] | null; /** * A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube. */ @@ -4425,11 +4425,11 @@ export namespace youtube_v3 { /** * A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword. */ - categoryRestricts?: string[]; + categoryRestricts?: string[] | null; /** * The keyword tag suggested for the video. */ - tag?: string; + tag?: string | null; } /** * Freebase topic information related to the video. @@ -4438,15 +4438,15 @@ export namespace youtube_v3 { /** * Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API. */ - relevantTopicIds?: string[]; + relevantTopicIds?: string[] | null; /** * A list of Wikipedia URLs that provide a high-level description of the video's content. */ - topicCategories?: string[]; + topicCategories?: string[] | null; /** * A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API. */ - topicIds?: string[]; + topicIds?: string[] | null; } /** * Branding properties for the watch. All deprecated. @@ -4455,15 +4455,15 @@ export namespace youtube_v3 { /** * The text color for the video watch page's branded area. */ - backgroundColor?: string; + backgroundColor?: string | null; /** * An ID that uniquely identifies a playlist that displays next to the video player. */ - featuredPlaylistId?: string; + featuredPlaylistId?: string | null; /** * The background color for the video watch page's branded area. */ - textColor?: string; + textColor?: string | null; } export class Resource$Activities { diff --git a/src/apis/youtubeAnalytics/v2.ts b/src/apis/youtubeAnalytics/v2.ts index 55b80606355..94f47fccbab 100644 --- a/src/apis/youtubeAnalytics/v2.ts +++ b/src/apis/youtubeAnalytics/v2.ts @@ -137,28 +137,28 @@ export namespace youtubeAnalytics_v2 { /** * Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. */ - argument?: string[]; + argument?: string[] | null; /** * Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. */ - code?: string; + code?: string | null; /** * Debugging information, which should not be shared externally. */ - debugInfo?: string; + debugInfo?: string | null; /** * Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain */ - domain?: string; + domain?: string | null; /** * A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like. */ - externalErrorMessage?: string; + externalErrorMessage?: string | null; /** * Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country */ - location?: string; - locationType?: string; + location?: string | null; + locationType?: string | null; } /** * Request Error information. The presence of an error field signals that the operation has failed. @@ -167,7 +167,7 @@ export namespace youtubeAnalytics_v2 { /** * Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. */ - code?: string; + code?: string | null; /** * Specific error description and codes */ @@ -175,7 +175,7 @@ export namespace youtubeAnalytics_v2 { /** * Request identifier generated by the service, which can be used to identify the error in the logs */ - requestId?: string; + requestId?: string | null; } /** * A group. @@ -192,15 +192,15 @@ export namespace youtubeAnalytics_v2 { /** * The Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the group. */ - id?: string; + id?: string | null; /** * Identifies the API resource's type. The value will be `youtube#group`. */ - kind?: string; + kind?: string | null; /** * The `snippet` object contains basic information about the group, including its creation date and name. */ @@ -213,11 +213,11 @@ export namespace youtubeAnalytics_v2 { /** * The number of items in the group. */ - itemCount?: string; + itemCount?: string | null; /** * The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` */ - itemType?: string; + itemType?: string | null; } /** * A group item. @@ -230,19 +230,19 @@ export namespace youtubeAnalytics_v2 { /** * The Etag of this resource. */ - etag?: string; + etag?: string | null; /** * The ID that YouTube uses to uniquely identify the group that contains the item. */ - groupId?: string; + groupId?: string | null; /** * The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. */ - id?: string; + id?: string | null; /** * Identifies the API resource's type. The value will be `youtube#groupItem`. */ - kind?: string; + kind?: string | null; /** * The `resource` object contains information that identifies the item being added to the group. */ @@ -252,11 +252,11 @@ export namespace youtubeAnalytics_v2 { /** * The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. */ - id?: string; + id?: string | null; /** * Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` */ - kind?: string; + kind?: string | null; } /** * A group snippet. @@ -265,11 +265,11 @@ export namespace youtubeAnalytics_v2 { /** * The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ - publishedAt?: string; + publishedAt?: string | null; /** * The group name. The value must be a non-empty string. */ - title?: string; + title?: string | null; } /** * Response message for GroupsService.ListGroupItems. @@ -282,7 +282,7 @@ export namespace youtubeAnalytics_v2 { /** * The Etag of this resource. */ - etag?: string; + etag?: string | null; /** * A list of groups that match the API request parameters. Each item in the list represents a `groupItem` resource. */ @@ -290,7 +290,7 @@ export namespace youtubeAnalytics_v2 { /** * Identifies the API resource's type. The value will be `youtube#groupItemListResponse`. */ - kind?: string; + kind?: string | null; } /** * Response message for GroupsService.ListGroups. @@ -303,7 +303,7 @@ export namespace youtubeAnalytics_v2 { /** * The Etag of this resource. */ - etag?: string; + etag?: string | null; /** * A list of groups that match the API request parameters. Each item in the list represents a `group` resource. */ @@ -311,11 +311,11 @@ export namespace youtubeAnalytics_v2 { /** * Identifies the API resource's type. The value will be `youtube#groupListResponse`. */ - kind?: string; + kind?: string | null; /** * The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for TargetedQueriesService.Query. @@ -332,11 +332,11 @@ export namespace youtubeAnalytics_v2 { /** * This value specifies the type of data included in the API response. For the query method, the kind property value will be `youtubeAnalytics#resultTable`. */ - kind?: string; + kind?: string | null; /** * The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the `columnHeaders` field. If no data is available for the given query, the `rows` element will be omitted from the response. The response for a query with the `day` dimension will not contain rows for the most recent days. */ - rows?: any[][]; + rows?: any[][] | null; } /** * The description of a column of the result table. @@ -345,15 +345,15 @@ export namespace youtubeAnalytics_v2 { /** * The type of the column (`DIMENSION` or `METRIC`). */ - columnType?: string; + columnType?: string | null; /** * The type of the data in the column (`STRING`, `INTEGER`, `FLOAT`, etc.). */ - dataType?: string; + dataType?: string | null; /** * The name of the dimension or metric. */ - name?: string; + name?: string | null; } export class Resource$Groupitems { diff --git a/src/apis/youtubereporting/v1.ts b/src/apis/youtubereporting/v1.ts index 876242ca860..72536266938 100644 --- a/src/apis/youtubereporting/v1.ts +++ b/src/apis/youtubereporting/v1.ts @@ -132,23 +132,23 @@ export namespace youtubereporting_v1 { /** * gdata */ - blobGeneration?: string; + blobGeneration?: string | null; /** * gdata */ - blobId?: string; + blobId?: string | null; /** * gdata */ - downloadReadHandle?: string; + downloadReadHandle?: string | null; /** * gdata */ - readToken?: string; + readToken?: string | null; /** * gdata */ - uploadMetadataContainer?: string; + uploadMetadataContainer?: string | null; } /** * gdata @@ -157,7 +157,7 @@ export namespace youtubereporting_v1 { /** * gdata */ - blobRef?: string; + blobRef?: string | null; /** * gdata */ @@ -165,23 +165,23 @@ export namespace youtubereporting_v1 { /** * gdata */ - cosmoBinaryReference?: string; + cosmoBinaryReference?: string | null; /** * gdata */ - crc32cHash?: number; + crc32cHash?: number | null; /** * gdata */ - inline?: string; + inline?: string | null; /** * gdata */ - length?: string; + length?: string | null; /** * gdata */ - md5Hash?: string; + md5Hash?: string | null; /** * gdata */ @@ -189,15 +189,15 @@ export namespace youtubereporting_v1 { /** * gdata */ - path?: string; + path?: string | null; /** * gdata */ - referenceType?: string; + referenceType?: string | null; /** * gdata */ - sha1Hash?: string; + sha1Hash?: string | null; } /** * gdata @@ -206,23 +206,23 @@ export namespace youtubereporting_v1 { /** * gdata */ - bestGuess?: string; + bestGuess?: string | null; /** * gdata */ - fromBytes?: string; + fromBytes?: string | null; /** * gdata */ - fromFileName?: string; + fromFileName?: string | null; /** * gdata */ - fromHeader?: string; + fromHeader?: string | null; /** * gdata */ - fromUrlPath?: string; + fromUrlPath?: string | null; } /** * gdata @@ -235,7 +235,7 @@ export namespace youtubereporting_v1 { /** * gdata */ - chunkSizeBytes?: string; + chunkSizeBytes?: string | null; /** * gdata */ @@ -243,11 +243,11 @@ export namespace youtubereporting_v1 { /** * gdata */ - objectSizeBytes?: string; + objectSizeBytes?: string | null; /** * gdata */ - objectVersion?: string; + objectVersion?: string | null; } /** * gdata @@ -273,7 +273,7 @@ export namespace youtubereporting_v1 { /** * gdata */ - objectVersion?: string; + objectVersion?: string | null; } /** * gdata @@ -282,7 +282,7 @@ export namespace youtubereporting_v1 { /** * gdata */ - objectVersion?: string; + objectVersion?: string | null; /** * gdata */ @@ -295,11 +295,11 @@ export namespace youtubereporting_v1 { /** * gdata */ - objectSizeBytes?: string; + objectSizeBytes?: string | null; /** * gdata */ - objectVersion?: string; + objectVersion?: string | null; } /** * gdata @@ -308,11 +308,11 @@ export namespace youtubereporting_v1 { /** * gdata */ - allowGzipCompression?: boolean; + allowGzipCompression?: boolean | null; /** * gdata */ - ignoreRange?: boolean; + ignoreRange?: boolean | null; } /** * gdata @@ -321,15 +321,15 @@ export namespace youtubereporting_v1 { /** * gdata */ - algorithm?: string; + algorithm?: string | null; /** * gdata */ - bigstoreObjectRef?: string; + bigstoreObjectRef?: string | null; /** * gdata */ - blobRef?: string; + blobRef?: string | null; /** * gdata */ @@ -341,7 +341,7 @@ export namespace youtubereporting_v1 { /** * gdata */ - contentType?: string; + contentType?: string | null; /** * gdata */ @@ -349,11 +349,11 @@ export namespace youtubereporting_v1 { /** * gdata */ - cosmoBinaryReference?: string; + cosmoBinaryReference?: string | null; /** * gdata */ - crc32cHash?: number; + crc32cHash?: number | null; /** * gdata */ @@ -381,35 +381,35 @@ export namespace youtubereporting_v1 { /** * gdata */ - filename?: string; + filename?: string | null; /** * gdata */ - hash?: string; + hash?: string | null; /** * gdata */ - hashVerified?: boolean; + hashVerified?: boolean | null; /** * gdata */ - inline?: string; + inline?: string | null; /** * gdata */ - isPotentialRetry?: boolean; + isPotentialRetry?: boolean | null; /** * gdata */ - length?: string; + length?: string | null; /** * gdata */ - md5Hash?: string; + md5Hash?: string | null; /** * gdata */ - mediaId?: string; + mediaId?: string | null; /** * gdata */ @@ -417,27 +417,27 @@ export namespace youtubereporting_v1 { /** * gdata */ - path?: string; + path?: string | null; /** * gdata */ - referenceType?: string; + referenceType?: string | null; /** * gdata */ - sha1Hash?: string; + sha1Hash?: string | null; /** * gdata */ - sha256Hash?: string; + sha256Hash?: string | null; /** * gdata */ - timestamp?: string; + timestamp?: string | null; /** * gdata */ - token?: string; + token?: string | null; } /** * gdata @@ -446,15 +446,15 @@ export namespace youtubereporting_v1 { /** * gdata */ - bucketName?: string; + bucketName?: string | null; /** * gdata */ - generation?: string; + generation?: string | null; /** * gdata */ - objectName?: string; + objectName?: string | null; } /** * A job creating reports of a specific type. @@ -463,27 +463,27 @@ export namespace youtubereporting_v1 { /** * The creation date/time of the job. */ - createTime?: string; + createTime?: string | null; /** * The date/time when this job will expire/expired. After a job expired, no new reports are generated. */ - expireTime?: string; + expireTime?: string | null; /** * The server-generated ID of the job (max. 40 characters). */ - id?: string; + id?: string | null; /** * The name of the job (max. 100 characters). */ - name?: string; + name?: string | null; /** * The type of reports this job creates. Corresponds to the ID of a ReportType. */ - reportTypeId?: string; + reportTypeId?: string | null; /** * True if this a system-managed job that cannot be modified by the user; otherwise false. */ - systemManaged?: boolean; + systemManaged?: boolean | null; } /** * Response message for ReportingService.ListJobs. @@ -496,7 +496,7 @@ export namespace youtubereporting_v1 { /** * A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * Response message for ReportingService.ListReports. @@ -505,7 +505,7 @@ export namespace youtubereporting_v1 { /** * A token to retrieve next page of results. Pass this value in the ListReportsRequest.page_token field in the subsequent call to `ListReports` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of report types. */ @@ -518,7 +518,7 @@ export namespace youtubereporting_v1 { /** * A token to retrieve next page of results. Pass this value in the ListReportTypesRequest.page_token field in the subsequent call to `ListReportTypes` method to retrieve the next page of results. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of report types. */ @@ -531,31 +531,31 @@ export namespace youtubereporting_v1 { /** * The date/time when this report was created. */ - createTime?: string; + createTime?: string | null; /** * The URL from which the report can be downloaded (max. 1000 characters). */ - downloadUrl?: string; + downloadUrl?: string | null; /** * The end of the time period that the report instance covers. The value is exclusive. */ - endTime?: string; + endTime?: string | null; /** * The server-generated ID of the report. */ - id?: string; + id?: string | null; /** * The date/time when the job this report belongs to will expire/expired. */ - jobExpireTime?: string; + jobExpireTime?: string | null; /** * The ID of the job that created this report. */ - jobId?: string; + jobId?: string | null; /** * The start of the time period that the report instance covers. The value is inclusive. */ - startTime?: string; + startTime?: string | null; } /** * A report type. @@ -564,19 +564,19 @@ export namespace youtubereporting_v1 { /** * The date/time when this report type was/will be deprecated. */ - deprecateTime?: string; + deprecateTime?: string | null; /** * The ID of the report type (max. 100 characters). */ - id?: string; + id?: string | null; /** * The name of the report type (max. 100 characters). */ - name?: string; + name?: string | null; /** * True if this a system-managed report type; otherwise false. Reporting jobs for system-managed report types are created automatically and can thus not be used in the `CreateJob` method. */ - systemManaged?: boolean; + systemManaged?: boolean | null; } export class Resource$Jobs { diff --git a/src/generator/templates/api-endpoint.njk b/src/generator/templates/api-endpoint.njk index 1edb04bab1f..a7427d902ee 100644 --- a/src/generator/templates/api-endpoint.njk +++ b/src/generator/templates/api-endpoint.njk @@ -125,7 +125,7 @@ export interface Schema${{ schema.id }} { {% elif p.items and p.items.$ref %} {{ pname|cleanPropertyName|safe }}?: Schema${{ p.items.$ref }}[]; {% else %} - {{ pname|cleanPropertyName|safe }}?: {{ p|getType|safe }}; + {{ pname|cleanPropertyName|safe }}?: {{ p|getType|safe }}|null; {% endif %} {% endfor %} {% endif %} diff --git a/src/index.ts b/src/index.ts index ed6445f01f5..04594620e68 100644 --- a/src/index.ts +++ b/src/index.ts @@ -53,6 +53,7 @@ export {appengine_v1alpha} from './apis/appengine/v1alpha'; export {appengine_v1beta} from './apis/appengine/v1beta'; export {appsactivity_v1} from './apis/appsactivity/v1'; export {bigquery_v2} from './apis/bigquery/v2'; +export {bigqueryconnection_v1beta1} from './apis/bigqueryconnection/v1beta1'; export {bigquerydatatransfer_v1} from './apis/bigquerydatatransfer/v1'; export {bigqueryreservation_v1} from './apis/bigqueryreservation/v1'; export { @@ -60,6 +61,7 @@ export { } from './apis/bigqueryreservation/v1alpha2'; export {bigtableadmin_v1} from './apis/bigtableadmin/v1'; export {bigtableadmin_v2} from './apis/bigtableadmin/v2'; +export {binaryauthorization_v1} from './apis/binaryauthorization/v1'; export {binaryauthorization_v1beta1} from './apis/binaryauthorization/v1beta1'; export {blogger_v2} from './apis/blogger/v2'; export {blogger_v3} from './apis/blogger/v3'; @@ -107,6 +109,7 @@ export {cloudtrace_v2} from './apis/cloudtrace/v2'; export {commentanalyzer_v1alpha1} from './apis/commentanalyzer/v1alpha1'; export {composer_v1} from './apis/composer/v1'; export {composer_v1beta1} from './apis/composer/v1beta1'; +export {compute_alpha} from './apis/compute/alpha'; export {compute_beta} from './apis/compute/beta'; export {compute_v1} from './apis/compute/v1'; export {container_v1} from './apis/container/v1'; @@ -171,7 +174,6 @@ export {genomics_v2alpha1} from './apis/genomics/v2alpha1'; export {gmail_v1} from './apis/gmail/v1'; export {groupsmigration_v1} from './apis/groupsmigration/v1'; export {groupssettings_v1} from './apis/groupssettings/v1'; -export {healthcare_v1alpha2} from './apis/healthcare/v1alpha2'; export {healthcare_v1beta1} from './apis/healthcare/v1beta1'; export {homegraph_v1} from './apis/homegraph/v1'; export {iam_v1} from './apis/iam/v1';